Skip to content

Commit e157b10

Browse files
committed
updating readme
1 parent 1f5ae1c commit e157b10

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ pip install /path/to/pydra-fsl/
2424
`FSLConverter` class (from `tools/converter.py`) requires three parts of information:
2525

2626
- Nipype spec: converter loads nipype interface and reads `_cmd`, `input_spec` and `output_spec`
27-
- yml file with additional spec: `specs/fsl_conv_params.yml` contains additional spec that are written based
27+
- yml file with additional spec: `specs/fsl_{module_name}_params.yml` contains additional spec that are written based
2828
on additional functions from nipype (including `list_outputs`), each interface can have the following fields:
2929
- inputs_metadata: additional metadata for fields from input_spec
3030
(it will be included in `metadata` in pydra spec),
31-
e.g., used for `FAST` to set default value for `number_classes`
31+
e.g., used in `specs/fsl_preprocess_params.yml` for `FAST` to set default value for `number_classes`
3232
(it's not part of nipype's spec, but it's set in `list_output`)
3333

3434
- output_requirements: providing required fields for the output to be created,
@@ -61,7 +61,10 @@ The converter can be used by running:
6161

6262
python tools/converter.py --interface_name <name of teh interface> --module_name <module_name>
6363

64-
The pydra task will be created in saved in `pydra/tasks/fsl/{module_name}/{interface_name}.py`
64+
The pydra task will be created and saved in `pydra/tasks/fsl/{module_name}/{interface_name}.py`.
65+
Note, that the spec file has to be present for the specific module name in order to run the converter.
66+
If no `interface_name` is provided, the default value `all` will be used
67+
and the converter will be run for all interfaces from the spec file.
6568

6669
Tests are written based on the fields from the yml file:
6770
`tests_inputs` and `tests_outputs` (the lengths should be the same).

0 commit comments

Comments
 (0)