Skip to content

Commit b8367a1

Browse files
committed
further clarified README
1 parent d6bb83f commit b8367a1

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,10 @@ To use the tool with either method:
3030

3131
## The Docker version
3232
The docker container has trained models provided under /models/. To use these get the default options.toml from step 1 below:
33-
1. Run `docker run --rm -v /path/to/your/data/:/data/ stavisvols/msdpostprocess python -m MSDpostprocess --print /data/options.toml`
34-
2. Edit the options file for your experiment.
35-
3. Run `docker run --rm -v /path/to/your/data/:/data/ stavisvols/msdpostprocess python -m MSDpostprocess --options /data/options.toml`
33+
1. Run `docker pull stavisvols/msdpostprocess`
34+
2. Run `docker run --rm -v /path/to/your/data/:/data/ stavisvols/msdpostprocess python -m MSDpostprocess --print /data/options.toml`
35+
3. Edit the options file for your experiment.
36+
4. Run `docker run --rm -v /path/to/your/data/:/data/ stavisvols/msdpostprocess python -m MSDpostprocess --options /data/options.toml`
3637
The working directory will be within the docker container's filesystem.
3738

3839
## Example analysis

src/MSDpostprocess/options.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,12 +76,10 @@ def print_options(self, path):
7676
resolved_path = os.path.abspath(sys._MEIPASS)
7777
else:
7878
resolved_path = os.path.abspath(os.path.dirname(__file__))
79-
8079
if os.environ.get('AM_I_IN_A_DOCKER_CONTAINER', False):
8180
example_options = os.path.join(resolved_path, 'docker_example_options.toml')
8281
else:
8382
example_options = os.path.join(resolved_path, 'example_options.toml')
84-
8583
shutil.copy2(example_options, path)
8684

8785
def validate_inputs(args):

0 commit comments

Comments
 (0)