Skip to content

Commit 88b6686

Browse files
authored
[skip ci] Update README.md
updated and extended description on how to use fileformats
1 parent e364a8f commit 88b6686

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,15 @@ All tasks will be inserted into the `pydra.tasks.<yourtaskpackagename>` namespac
1010
1. Give your repo a name.
1111
1. Once the repo is created and cloned, search for CHANGEME (`grep -rn CHANGEME . `) and
1212
replace with appropriate name.
13-
1. Rename the following folders to replace `CHANGEME` with the name of the package:
13+
1. Rename the namespace package root directory to replace `CHANGEME` with the name of the package:
1414
* `src/pydra/tasks/CHANGEME`
15-
* `fileformats/fileformats/medimage_CHANGEME`
16-
* `fileformats/fileformats/extras/medimage_CHANGEME`
15+
1. If you are planning to define [fileformats](https://arcanaframework.github.io/fileformats/) classes specific
16+
to the tools defined in the task package, then rename the base and "extras" packages using a
17+
matching name to the package (if the tool is from in another field other than medical imaging,
18+
also replace the `medimage` part). If you don't need to define and tool-specific fileformats you can delete
19+
these packages and the .github/workflows/fileformats-ci-cd.yaml
20+
* `related-packages/fileformats/fileformats/medimage_CHANGEME`
21+
* `related-packages/fileformats-extras/fileformats/extras/medimage_CHANGEME`
1722
1. Under the newly renamed package (i.e. formerly CHANGEME) there is a directory named "v1",
1823
`src/pydra/tasks/<package-name>/v1`, change this to valid Python package name starting with
1924
'v' to indicate the version of the tool the Pydra interfaces will be designed for,

0 commit comments

Comments
 (0)