You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,9 @@ There are three ways to install and run LipoCLEAN: as an executable, as a docker
4
4
## The executable version
5
5
This method requires no installation but it is somewhat slower than the other options.
6
6
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.
8
8
3. Edit the options file for your experiment.
9
-
4. Run `lipoCLEAN.exe --options options.toml`
9
+
4. Run `lipoCLEAN.exe --options options.txt`
10
10
11
11
## The conda/virtualenv version
12
12
To set up the conda environment for the tool:
@@ -24,23 +24,23 @@ Otherwise, if you are using virtualenv:
24
24
25
25
To use the tool with either method:
26
26
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.
28
28
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`
30
30
31
31
## 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:
33
33
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`
35
35
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`
37
37
The working directory will be within the docker container's filesystem.
38
38
39
39
## Example analysis
40
40
1. Install the tool using one of the above methods.
41
41
2. Download `QE_Pro_model.zip` and `example_analysis.zip` from the releases page.
42
42
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`
44
44
45
45
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.
0 commit comments