Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructured specs and task package auto-generation script #10

Merged
merged 42 commits into from
Nov 1, 2023

Conversation

tclose
Copy link
Contributor

@tclose tclose commented Aug 1, 2023

This PR restructures the format for the YAML specs used to assist the conversion process the tasks, adding fields to rename the task and fields and override the inferred field types.

It also adds the scripts/create_packages.py script, which scrapes nipype.interfaces to generate separate stub git repos for each of the task packages (e.g. pydra-ants, pydra-afni, pydra-fsl, pydra-dipy, etc...) that are pre-populated with auto-generated YAML files with info inferred from doctests. See pydra-ants-autodemo for an example of what the repositories would look like.

We should be able to use the script to quickly create separate repos for each tool package in Nipype. The GH actions are designed to then have the packages automatically convert all the Nipype interfaces and publish release whenever a new nipype or nipype2pydra version is released.

The nipype2pydra conversion step will generate a unittest for each interface, that attempts to initialise the task with sensible values and run it for 10s. If it makes it that far it is considered to have passed the initialisation phase and is marked as passed. The values passed to the fields are determined by their types, and for selected file-types (e.g. NIfTI, DICOM) the fileformats package is able to provide sample filesets using a package I wrote called medimages4tests.

I have tried to explain the process in the README of pydra-ants-autodemo, let me know if it doesn't make sense with and adds scripts for auto-generating new package repos

tclose added 30 commits July 25, 2023 10:55
@tclose tclose changed the title Restructured specs Restructured specs and task package auto-generation script Aug 2, 2023
@tclose tclose merged commit 1a76879 into main Nov 1, 2023
0 of 2 checks passed
@tclose tclose deleted the restructured-specs branch November 1, 2023 05:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant