Skip to content

Commit 672d5c2

Browse files
committed
[skip ci] touched up readme
1 parent 2092df2 commit 672d5c2

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -86,29 +86,29 @@ Before the pydra task interfaces can be generated and installed, the file-format
8686
corresponding to Freesurfer specific file formats will need to be installed
8787

8888
```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]
9191
```
9292

9393
Next install the requirements for running the auto-conversion script and generate the
9494
Pydra task interfaces from their Nipype counterparts
9595

9696
```console
97-
$ pip install -r nipype-auto-conv/requirements.txt
97+
pip install -r nipype-auto-conv/requirements.txt
9898
```
9999

100100
The run the conversion script to convert Nipype interfaces to Pydra
101101

102102
```console
103-
$ nipype-auto-conv/generate
103+
nipype-auto-conv/generate
104104
```
105105

106106
Install repo in developer mode from the source directory and install pre-commit to
107107
ensure consistent code-style and quality.
108108

109109
```console
110-
$ pip install -e .[test,dev]
111-
$ pre-commit install
110+
pip install -e .[test,dev]
111+
pre-commit install
112112
```
113113

114114
### Auto-conversion phase
@@ -121,13 +121,13 @@ After editing one or more conversion specs the `pydra.tasks.freesurfer.auto` pac
121121
be regenerated by running
122122

123123
```console
124-
$ nipype-auto-conv/generate
124+
nipype-auto-conv/generate
125125
```
126126

127127
The tests should be run on the auto-generated tasks to see if they are valid
128128

129129
```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
131131
```
132132

133133
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
154154
selected format types, e.g. Nifti, Dicom. Therefore, it is important to specify the
155155
format of the file using the "mime-like" string corresponding to a
156156
[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.
158158

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`
160160
docs [https://arcanaframework.github.io/fileformats/developer.html] for instructions on how to define
161161
new fileformat types, and see
162162
[fileformats-medimage-extras](https://github.com/ArcanaFramework/fileformats-medimage-extras/blob/6c2dabe91e95687eebc2639bb6f034cf9595ecfc/fileformats/extras/medimage/nifti.py#L30-L48)

0 commit comments

Comments
 (0)