Skip to content

Commit

Permalink
misc: added README to docker directory
Browse files Browse the repository at this point in the history
  • Loading branch information
EdCaunt committed Jul 20, 2023
1 parent df6a31a commit 071a2d0
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docker/README.md
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`.

0 comments on commit 071a2d0

Please sign in to comment.