Skip to content

Commit 071a2d0

Browse files
committed
misc: added README to docker directory
1 parent df6a31a commit 071a2d0

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

docker/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Dockerfile for running Schism
2+
3+
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.
4+
5+
# Building and running the image
6+
7+
To build the image, one must navigate to the main directory (that above this one) and run the following command:
8+
9+
`docker build --network=host --file docker/dockerfile --tag schism .`.
10+
11+
To run a bash shell inside the image, use:
12+
13+
`docker run -i -t schism /bin/bash`.
14+
15+
Note that these commands may require `sudo`. Once inside the image, one will want to activate the `venv` created, using:
16+
17+
`source venv/bin/activate`.
18+
19+
From here, one can run the tests and examples, found in `app/schism`.

0 commit comments

Comments
 (0)