Skip to content

Commit ee6889b

Browse files
Add documentation, images and new schema modules
Add extensive user documentation (getting-started, design-patterns, how-to-extend, coremeta4cat-users, overview, images, and a vocabulary Excel workbook) and update site config (mkdocs.yml). Fix iframe path in characterization.md to use /CoreMeta4Cat. Introduce new schema submodules (chemical_entities_ap.yaml, chemical_reaction_ap.yaml, dcat_4c_ap.yaml, material_entities_ap.yaml) and update existing catcore schema and Pydantic/datamodel bindings (catcore.yaml, catcore_*_ap.yaml, catcore.py, catcore_pydantic.py). These changes expand the docs, add assets, and extend the schema import hierarchy to support additional chemistry layers and documentation for adopters.
1 parent 4097d6e commit ee6889b

26 files changed

Lines changed: 11026 additions & 6913 deletions
71.4 KB
Binary file not shown.

docs/characterization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The class follows a hierarchical structure in which selection of a characterizat
77
**CURIE:** [`OBI:0000070`](OBI:0000070)
88

99
<iframe
10-
src="/CatCore/assets/metadata_characterization_hierarchy.html"
10+
src="/CoreMeta4Cat/assets/metadata_characterization_hierarchy.html"
1111
width="100%"
1212
height= "470vh"
1313
style="border: 2px solid #5C88DA; background-color: #F0F8FF;

docs/coremeta4cat-users.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
title: CoreMeta4Cat Users
3+
description: Projects, repositories, and communities that adopt CoreMeta4Cat
4+
---
5+
6+
# CoreMeta4Cat Users
7+
8+
This page lists projects, data repositories, and communities that have adopted CoreMeta4Cat as their metadata standard. It is also the right place to understand how CoreMeta4Cat fits into the broader NFDI4Cat research data infrastructure.
9+
10+
<div style="text-align: center;">
11+
<a>
12+
<img src="/CoreMeta4Cat/images/CoreMeta4Cat_Picture.png" alt="CatCore logo" style="width: 40%;">
13+
</a>
14+
</div>
15+
16+
---
17+
18+
## NFDI4Cat
19+
20+
![NFDI4Cat Logo](images/nfdi4cat-logo.png)</code>
21+
22+
CoreMeta4Cat is developed within the [NFDI4Cat](https://nfdi4cat.org) initiative — the National Research Data Infrastructure consortium for catalysis sciences in Germany. NFDI4Cat brings together universities, research institutions, and industrial partners to build shared data infrastructure for the catalysis community.
23+
24+
CoreMeta4Cat is the community-driven metadata model proposed within this framework, designed to enable semantically enriched, interoperable catalysis data across experimental, computational, and digitally curated research workflows.
25+
26+
---
27+
28+
## Are you using CoreMeta4Cat?
29+
30+
If your project, repository, or tool uses CoreMeta4Cat, we would love to list it here. Please open an issue or pull request on the [CoreMeta4Cat GitHub repository](https://github.com/HendrikBorgelt/CoreMeta4Cat) with the following information:
31+
32+
| Field | What to provide |
33+
|---|---|
34+
| **Project name** | The name of the project, repository, or tool |
35+
| **Organisation** | The institution or consortium responsible |
36+
| **Description** | One or two sentences on how CoreMeta4Cat is used |
37+
| **Link** | A URL to the project, dataset collection, or publication |
38+
| **Contact** | An optional name or email for follow-up |
39+
40+
---
41+
42+
## Scope of adoption
43+
44+
CoreMeta4Cat is designed to be adopted at different levels, depending on the use case:
45+
46+
**Metadata collection and submission**
47+
Research groups can use CoreMeta4Cat to structure the metadata they report alongside published datasets, whether in institutional repositories, domain repositories, or supplementary materials of publications.
48+
49+
**Repository integration**
50+
Data repository operators can implement CoreMeta4Cat as their metadata intake schema, enabling structured, validated metadata submission from depositing researchers. The LinkML source generates SHACL shapes, JSON Schema, and Python/Pydantic classes out of the box, making integration straightforward.
51+
52+
**Workflow tools and ELNs**
53+
Electronic lab notebooks (ELNs) and data management tools used in catalysis labs can map their internal data models to CoreMeta4Cat, enabling automatic metadata export in a standardised format.
54+
55+
**Knowledge graph and semantic web applications**
56+
Because CoreMeta4Cat maps every class and slot to established ontology terms (Voc4Cat, CHMO, OBI, NCIT, …), instance data can be exported as RDF and loaded into a triple store or knowledge graph for semantic querying across datasets.
57+
58+
---
59+
60+
## Related resources
61+
62+
| Resource | Description |
63+
|---|---|
64+
| [Voc4Cat](https://nfdi4cat.github.io/voc4cat/) | The NFDI4Cat controlled vocabulary, used for `rdf_type` classification terms throughout CoreMeta4Cat |
65+
| [DCAT-AP-PLUS](https://nfdi-de.github.io/dcat-ap-plus/dev/) | The base provenance layer that CoreMeta4Cat extends |
66+
| [LinkML](https://linkml.io/) | The schema language and tooling used to define and validate CoreMeta4Cat |
67+
| [CoreMeta4Cat on GitHub](https://github.com/HendrikBorgelt/CoreMeta4Cat) | Schema source files, issue tracker, and contribution guide |

0 commit comments

Comments
 (0)