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

Use Nipoppy schema to validate proc status TSV for bagel derivatives command #352

Open
Tracked by #167
alyssadai opened this issue Oct 1, 2024 · 3 comments
Open
Tracked by #167

Comments

@alyssadai
Copy link
Contributor

alyssadai commented Oct 1, 2024

When users come to us with an imaging status file - whether made by nipoppy or made by hand - we would like to validate the file against the current Nipoppy schema to make sure the contents have the correct structure. The Nipoppy schema is written in pydantic, so we will have to decide how we want to "ingest" the schema in our own tools.

Some options are:

  • copy paste the pydantic schema directly into our codebase
  • make nipoppy itself a dependency of the cli so we can directly import the schema
  • find ways to export the schema in a format that encompasses all of its validation functions and that we can read in
  • spin out the schema into a separate repo (e.g. pipeline catalog?) and then consume it from there (e.g. via submodule)
@alyssadai
Copy link
Contributor Author

alyssadai commented Oct 10, 2024

Currently blocked by #180, due to Nipoppy schema being written in v2 (and we would have to use their model as a module, not jsonschema, due to the internal validation they have)

Edit: No longer blocked

@surchs surchs moved this from Specify - Done to Implement - Track in Neurobagel Nov 26, 2024
@surchs
Copy link
Contributor

surchs commented Nov 26, 2024

Tracked while we discuss how to do this
edit: will discuss this Thursday and then issue either goes into a milestone or off the board

@surchs
Copy link
Contributor

surchs commented Dec 12, 2024

Decision: We will implement the following as part of a new issue: grab example imaging status file from a nipoppy maintained repo (e.g. catalog) and use it as a test target. Keep this example in sync with upstream nipoppy (e.g. submodule) so tests start breaking when we go out of sync

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

2 participants