From 071a2d05892ae32f1b3f279f82a6c43dad9f45d8 Mon Sep 17 00:00:00 2001 From: EdCaunt Date: Thu, 20 Jul 2023 10:50:36 +0100 Subject: [PATCH] misc: added README to docker directory --- docker/README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docker/README.md diff --git a/docker/README.md b/docker/README.md new file mode 100644 index 0000000..5e3bec1 --- /dev/null +++ b/docker/README.md @@ -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`. \ No newline at end of file