Skip to content

Adding ExperimentSchema check and experiment README update#289

Open
korbinib wants to merge 1 commit intoNMRLipids:mainfrom
korbinib:exp_schema
Open

Adding ExperimentSchema check and experiment README update#289
korbinib wants to merge 1 commit intoNMRLipids:mainfrom
korbinib:exp_schema

Conversation

@korbinib
Copy link
Collaborator

Changes to be committed:
new file: ../.github/workflows/CheckExperimentSchema.yml
modified: README.md

Fixes partly NMRLipids/FAIRMD_lipids#459

 Changes to be committed:
	new file:   ../.github/workflows/CheckExperimentSchema.yml
	modified:   README.md
@korbinib korbinib requested review from comcon1 and mdondrup February 10, 2026 12:44
@korbinib korbinib self-assigned this Feb 10, 2026
@korbinib korbinib added the enhancement New feature or request label Feb 10, 2026
Copy link
Collaborator

@MagnusSletten MagnusSletten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Couple of minor comments.

Comment on lines +29 to +32
- name: Install Databank dependencies
working-directory: Databank
run: |
pip install .
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With your current use of json-schema you actually don't need a pip install here at all which is nice. Should be very fast.

Comment on lines +41 to +42
if [ -f "$file" ]; then
check-jsonschema --schemafile ../Databank/src/fairmd/lipids/schema_validation/schema/experiment_schema.json "$file"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the smaller number of experiment files to check I think this will be perfectly fine, but it uses a new python process for each file.

Something like

find ./experiments -type f -name README.yaml -print0 \
  | xargs -0 -r check-jsonschema \
      --schemafile ../Databank/src/fairmd/lipids/schema_validation/schema/experiment_schema

Will be even faster because it reuses the process. This was more relevant for the simulation readme files though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants