@@ -86,29 +86,29 @@ Before the pydra task interfaces can be generated and installed, the file-format
86
86
corresponding to Freesurfer specific file formats will need to be installed
87
87
88
88
``` console
89
- $ pip install -e ./related-packages/fileformats[dev]
90
- $ pip install -e ./related-packages/fileformats-extras[dev]
89
+ pip install -e ./related-packages/fileformats[dev]
90
+ pip install -e ./related-packages/fileformats-extras[dev]
91
91
```
92
92
93
93
Next install the requirements for running the auto-conversion script and generate the
94
94
Pydra task interfaces from their Nipype counterparts
95
95
96
96
``` console
97
- $ pip install -r nipype-auto-conv/requirements.txt
97
+ pip install -r nipype-auto-conv/requirements.txt
98
98
```
99
99
100
100
The run the conversion script to convert Nipype interfaces to Pydra
101
101
102
102
``` console
103
- $ nipype-auto-conv/generate
103
+ nipype-auto-conv/generate
104
104
```
105
105
106
106
Install repo in developer mode from the source directory and install pre-commit to
107
107
ensure consistent code-style and quality.
108
108
109
109
``` console
110
- $ pip install -e .[test,dev]
111
- $ pre-commit install
110
+ pip install -e .[test,dev]
111
+ pre-commit install
112
112
```
113
113
114
114
### Auto-conversion phase
@@ -121,13 +121,13 @@ After editing one or more conversion specs the `pydra.tasks.freesurfer.auto` pac
121
121
be regenerated by running
122
122
123
123
``` console
124
- $ nipype-auto-conv/generate
124
+ nipype-auto-conv/generate
125
125
```
126
126
127
127
The tests should be run on the auto-generated tasks to see if they are valid
128
128
129
129
``` console
130
- $ pytest pydra/tasks/freesurfer/auto/tests/test_<the-name-of-the-task-you-edited>.py
130
+ pytest pydra/tasks/freesurfer/auto/tests/test_<the-name-of-the-task-you-edited>.py
131
131
```
132
132
133
133
If the test passes you should then edit the ` pydra/tasks/freesurfer/v*/__init__.py ` file
@@ -154,9 +154,9 @@ For file-based data, automatically generated file-system objects will be created
154
154
selected format types, e.g. Nifti, Dicom. Therefore, it is important to specify the
155
155
format of the file using the "mime-like" string corresponding to a
156
156
[ fileformats] ( https://github.com/ArcanaFramework/fileformats ) class
157
- in the `` inputs > types `` and `` outputs > types ` ` dicts of the YAML spec.
157
+ in the ` inputs > types ` and ` outputs > types ` dicts of the YAML spec.
158
158
159
- If the required file-type is not found implemented within fileformats, please see the `fileformats
159
+ If the required file-type is not found implemented within fileformats, please see the ` fileformats `
160
160
docs [ https://arcanaframework.github.io/fileformats/developer.html ] for instructions on how to define
161
161
new fileformat types, and see
162
162
[ fileformats-medimage-extras] ( https://github.com/ArcanaFramework/fileformats-medimage-extras/blob/6c2dabe91e95687eebc2639bb6f034cf9595ecfc/fileformats/extras/medimage/nifti.py#L30-L48 )
0 commit comments