Skip to content

Commit 0bad79a

Browse files
committed
Added Docker to readme
1 parent c59677c commit 0bad79a

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,22 @@ At the present time, the `-d` and `-l` options are unused by the code and can be
6363

6464
The command line options used on a given model run are logged in the output log file (see below) for traceability and future reference.
6565

66+
### Running with Docker
67+
68+
The model can also be run via the included Dockerfile, firstly build the image by running:
69+
70+
```bash
71+
docker build --label eeramodel </path/to/Dockerfile>
72+
```
73+
74+
you can then run an interactive terminal within a new container, with the additional option of mounting the repository to your local file system (important for having access to the model outputs):
75+
76+
```bash
77+
docker run -ti --label eeramodel_container -v </path/on/host-file-system>:/home/Covid19_EERAModel eeramodel
78+
```
79+
80+
note however that these outputs will be owned by `root` within the container, as such it is highly advised that this method not be used for development. If you do not care about having access to the files on your host file system the volume option can be dropped.
81+
6682
### Inputs
6783
The model requires a number of input files to run, in addition to the command line arguments. Input files must be placed in the `data` directory, and must be named according to the table below. The required contents of each file are described in more detail underneath the table.
6884

0 commit comments

Comments
 (0)