Skip to content

Add substance & reaction specific Dataset & DataGeneratingActivity subclasses in chem_dcat_ap.yaml and move samples to chemical_entities.yaml - #126

Merged
StroemPhi merged 12 commits into
mainfrom
Improve-docs
Mar 23, 2026
Merged

Add substance & reaction specific Dataset & DataGeneratingActivity subclasses in chem_dcat_ap.yaml and move samples to chemical_entities.yaml#126
StroemPhi merged 12 commits into
mainfrom
Improve-docs

Conversation

@StroemPhi

@StroemPhi StroemPhi commented Mar 18, 2026

Copy link
Copy Markdown
Member

While writing the docs, I stumbled across issues that this PR needs to fix, before I can proceed with the docs. So this PR:

  • Moves SubstanceSample and PolymerSample from chem_dcat_ap.yaml to chemical_entities.yaml, because this is more in line with the material_entities.yaml also defining the MaterialSample.
    • As part of this it also sorts the classes by type in chemical_entities.yaml.
  • Adds very general Dataset & DataGeneratingActivity subclasses constrained to SubstanceSample repsectively ChemicalReaction. These subclasses are needed to demonstrate how the DCAT-AP+ classes should be specialized in Chem-DCAT-AP based sub-profiles.
  • Adds two example files to test these new classes.
  • Fixes the bug that has_reaction_step was not multivalued.

While writing the docs centered around the yaml files as modules, it became clear these two belong in the chemical entities module, not on the most upper ChemDCAT-AP level.
To make the schema easier to read
…s to SubstanceSample repsectively ChemicalReaction

These subclasses are needed to demonstrate how the DCAT-AP+ classes should be specialized in Chem-DCAT-AP sub-profiles. This commit also adds two example files to test these new classes.
As part of this the bug that `has_reaction_step` was not multivalued, was also fix for all to work.
@github-actions

github-actions Bot commented Mar 18, 2026

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://nfdi-de.github.io/chem-dcat-ap/pr-preview/pr-126/

Built to branch gh-pages at 2026-03-23 10:10 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@HendrikBorgelt HendrikBorgelt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

looking good, no error found.

…taset-001.yaml additionally as chebi:'chemical substance'

and thereby fix that the `n-Buli` reactant was typed as a chebi:mixture, which is probably not wrong, since it will have some unknown residue. But chemical substance should be the standard.
@StroemPhi

Copy link
Copy Markdown
Member Author

I've just fixed/added the linkml-convert and linkml validate commands I used to test to the README. And I also added an additional type assertion (chebi:chemical substance) for the participants of the example reaction. So nothing really changed, just minor improvements. (It was late, when I pushed yesterday 😉)

@markdoerr

Copy link
Copy Markdown
Collaborator

I will also have a look now, just a second ... :)

Comment thread README.md Outdated
Comment thread src/chem_dcat_ap/schema/chem_dcat_ap.yaml Outdated

@markdoerr markdoerr left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I like the idea of moving the Sample classes, but we should make this ReactionRecording related classes clearer.

@StroemPhi
StroemPhi requested a review from markdoerr March 20, 2026 15:28

@dalito dalito left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I wonder if "SubstanceCharacterization" would better be named "SampleCharacterisation" or "PhysicalSampleCharacterisation". The latter terms would better match the reality (a sample of a substance is characterized). However, if our focus is the "aboutness" than SubstanceCharacterisation is fine.

What is your opinion?

@StroemPhi

Copy link
Copy Markdown
Member Author

@dalito you are right. How about renaming them to SubstanceSampleCharacterization and SubstanceSampleCharacterizationDataset to make it clearer?

…rizationDataset`

and run `just gen-project`
@StroemPhi

Copy link
Copy Markdown
Member Author

@dalito and @markdoerr can I merge this one now?

@markdoerr

Copy link
Copy Markdown
Collaborator

Hi @StroemPhi, I just found one tiny inconstancy in the Readme.md. Let me quickly fix it....

@markdoerr markdoerr left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Now everything looks fine - and can be merged from my perspective

@StroemPhi
StroemPhi merged commit cc1edbf into main Mar 23, 2026
7 checks passed
@StroemPhi
StroemPhi deleted the Improve-docs branch March 23, 2026 10:15
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.

4 participants