-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
misc: added README to docker directory
- Loading branch information
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Dockerfile for running Schism | ||
|
||
To aid the reproducibility of work carried out with Schism, alongside its wider usage, this directory contains a Dockerfile which can be used to run the code. With this, both tests and examples can be run. | ||
|
||
# Building and running the image | ||
|
||
To build the image, one must navigate to the main directory (that above this one) and run the following command: | ||
|
||
`docker build --network=host --file docker/dockerfile --tag schism .`. | ||
|
||
To run a bash shell inside the image, use: | ||
|
||
`docker run -i -t schism /bin/bash`. | ||
|
||
Note that these commands may require `sudo`. Once inside the image, one will want to activate the `venv` created, using: | ||
|
||
`source venv/bin/activate`. | ||
|
||
From here, one can run the tests and examples, found in `app/schism`. |