Skip to content

Commit cd523fa

Browse files
authored
Update README.md
1 parent 846a742 commit cd523fa

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,10 @@ This can be done by running the following from CANDIA's top level directory:
132132

133133
The general syntax of this script is `candia EXPERIMENT_CONFIG_YAML`
134134

135+
**Note** The test experiment will only run properly up to and including the decomposition step.
136+
As this is the most complex part of the pipeline, this should guarantee that your installation
137+
works for real data. A more complete test suite (more realistic data and unit tests) is planned.
138+
135139
Currently, it is **recommended to run each stage at a time**, using the corresponding scripts.
136140
Step-by-step instruction are listed here using the toy data files provided in this repo.
137141
These data files are primarily meant to test the pipeline is working properly.

0 commit comments

Comments
 (0)