Skip to content

Commit fadafe9

Browse files
committed
updated usage instructions to use .txt instead of .toml for options files
1 parent cd4a07e commit fadafe9

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ There are three ways to install and run LipoCLEAN: as an executable, as a docker
44
## The executable version
55
This method requires no installation but it is somewhat slower than the other options.
66
1. Download the executable for your operating system, the trained model, and the example options file from the [releases page](https://github.com/stavis1/lipoCLEAN/releases).
7-
2. Run `lipoCLEAN.exe --print options.toml` to get a default options file.
7+
2. Run `lipoCLEAN.exe --print options.txt` to get a default options file.
88
3. Edit the options file for your experiment.
9-
4. Run `lipoCLEAN.exe --options options.toml`
9+
4. Run `lipoCLEAN.exe --options options.txt`
1010

1111
## The conda/virtualenv version
1212
To set up the conda environment for the tool:
@@ -24,23 +24,23 @@ Otherwise, if you are using virtualenv:
2424

2525
To use the tool with either method:
2626
1. Download the trained models from the [releases page](https://github.com/stavis1/lipoCLEAN/releases).
27-
2. Run `python -m lipoCLEAN --print options.toml` to get a default options file.
27+
2. Run `python -m lipoCLEAN --print options.txt` to get a default options file.
2828
3. Edit the options file for your experiment.
29-
4. Run `python -m lipoCLEAN --options options.toml`
29+
4. Run `python -m lipoCLEAN --options options.txt`
3030

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

3939
## Example analysis
4040
1. Install the tool using one of the above methods.
4141
2. Download `QE_Pro_model.zip` and `example_analysis.zip` from the releases page.
4242
3. Extract both archives. There should be no folders nested under `QE_Pro_model/` and `example_analysis/`.
43-
4. Run `lipoCLEAN.exe --options example_analysis/example_analysis_options.toml`
43+
4. Run `lipoCLEAN.exe --options example_analysis/example_analysis_options.txt`
4444

4545
On some systems the warning `No module named 'brainpy._c.composition'` will be displayed. This is not an error and does not impact the running of the tool.
4646

0 commit comments

Comments
 (0)