Skip to content

Commit 38978ca

Browse files
khatamiradkhatamirad
authored
updated text for intended-users section
| # | Type | Location in page | Description | |---|---|---|---| | 1 | Edited | Opening paragraph | Rewritten to accurately describe what the page does | | 2 | Added | After opening paragraph | New "Who is CoreMeta4Cat for?" section — five user-type subsections | | 3 | Added | After user-type subsections | New "How different groups use CoreMeta4Cat" routing table | | 4 | Edited | "Are you using CoreMeta4Cat?" | Converted to `!!! info` callout within "Projects and repositories" section | | 5 | Fixed | Two locations | GitHub links corrected from personal fork to official repository |
1 parent c6bc94f commit 38978ca

1 file changed

Lines changed: 56 additions & 30 deletions

File tree

‎docs/coremeta4cat-users.md‎

Lines changed: 56 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,77 @@
1-
---
2-
title: CoreMeta4Cat Users
3-
description: Projects, repositories, and communities that adopt CoreMeta4Cat
1+
# Intended Users
2+
3+
CoreMeta4Cat is designed for anyone who produces, manages, or builds tools around catalysis research data. This page describes who the standard is for, how different groups use it, and which projects and repositories have adopted it.
4+
5+
![CoreMeta4Cat logo](images/CoreMeta4Cat_Picture.png)
6+
47
---
58

6-
# CoreMeta4Cat Users
9+
## Who is CoreMeta4Cat for?
710

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.
11+
### Experimental researchers
912

10-
<div style="text-align: center;">
11-
<a>
12-
<img src="../images/CoreMeta4Cat_Picture.png" alt="CoreMeta4Cat logo" style="width: 40%;">
13-
</a>
14-
</div>
13+
If you run catalytic experiments — synthesis, characterisation, reaction testing — CoreMeta4Cat tells you exactly what metadata to record alongside your data so that it can be understood and reused by others, including your future self. You do not need to know anything about schemas, ontologies, or FAIR principles to use it. Start with the [vocabulary reference workbook](https://nfdi4cat.github.io/CoreMeta4Cat/latest/assets/coremeta4cat_vocabulary.xlsx) and the [Getting Started](https://nfdi4cat.github.io/CoreMeta4Cat/latest/getting-started/) guide.
1514

16-
---
15+
**CoreMeta4Cat helps you:**
16+
- Know which metadata fields are mandatory, recommended, or optional for your specific experiment type
17+
- Use consistent field names and units that other researchers — and data repositories — will recognise
18+
- Prepare your dataset for publication, repository deposit, or FAIR compliance without extra rework
1719

18-
## NFDI4Cat
20+
### Computational researchers
1921

20-
<div style="text-align: center;">
21-
<a>
22-
<img src="../images/nfdi4cat-logo.png" alt="nfdi4cat-logo" style="width: 40%;">
23-
</a>
24-
</div>
22+
If you run DFT calculations, molecular dynamics simulations, or microkinetic models, CoreMeta4Cat defines the minimum metadata for your computational outputs — software, method, settings, and calculated properties. The same vocabulary links your simulation data to experimental datasets, enabling direct comparison and validation.
2523

26-
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.
24+
### Data stewards and repository managers
25+
26+
If you manage a research data repository or institutional data infrastructure, CoreMeta4Cat provides a validated, community-agreed schema for catalysis data intake. The LinkML source generates SHACL shapes, JSON Schema, and Python/Pydantic classes automatically, making integration into existing repository workflows straightforward.
27+
28+
**CoreMeta4Cat gives you:**
29+
- A structured, versioned metadata schema with clear obligation levels (Mandatory / Recommended / Optional)
30+
- Automatic generation of validation artefacts (SHACL, JSON Schema) from a single source
31+
- A direct connection to the Voc4Cat controlled vocabulary and DCAT-AP-PLUS provenance layer
32+
33+
### Tool and ELN developers
2734

28-
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.
35+
If you develop electronic lab notebooks, data management platforms, or analysis tools used in catalysis labs, CoreMeta4Cat provides a community-agreed data model to map your internal schema against. Aligning your tool's output to CoreMeta4Cat makes your users' data immediately compatible with repositories and other tools in the NFDI4Cat ecosystem.
36+
37+
### PhD students and early-career researchers
38+
39+
If you are new to research data management, CoreMeta4Cat is a practical starting point. Rather than confronting abstract FAIR principles, it gives you a concrete, catalysis-specific list of what to document for your experiment type. The [Getting Started](https://nfdi4cat.github.io/CoreMeta4Cat/latest/getting-started/) page is written for exactly this audience — no prior knowledge of metadata standards required.
2940

3041
---
3142

32-
## Are you using CoreMeta4Cat?
43+
## How different groups use CoreMeta4Cat
3344

34-
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:
45+
| User type | Primary use | Entry point |
46+
|---|---|---|
47+
| Experimental researcher | Record and annotate dataset metadata | [Vocabulary workbook](https://nfdi4cat.github.io/CoreMeta4Cat/latest/assets/coremeta4cat_vocabulary.xlsx) · [Getting Started](https://nfdi4cat.github.io/CoreMeta4Cat/latest/getting-started/) |
48+
| Computational researcher | Document simulation inputs, settings, and outputs | [Simulation data class](https://nfdi4cat.github.io/CoreMeta4Cat/latest/simulation/) |
49+
| Data steward / repository | Implement as metadata intake schema | [Schema Reference](https://nfdi4cat.github.io/CoreMeta4Cat/latest/elements/overview/) · [Design Patterns](https://nfdi4cat.github.io/CoreMeta4Cat/latest/design-patterns/) |
50+
| Tool / ELN developer | Map internal schema to CoreMeta4Cat | [How to Extend](https://nfdi4cat.github.io/CoreMeta4Cat/latest/how-to-extend/) · [GitHub](https://github.com/nfdi4cat/CoreMeta4Cat) |
51+
| PhD student | Learn what metadata to document | [Getting Started — Level 1 and 2](https://nfdi4cat.github.io/CoreMeta4Cat/latest/getting-started/) |
3552

36-
| Field | What to provide |
37-
|---|---|
38-
| **Project name** | The name of the project, repository, or tool |
39-
| **Organisation** | The institution or consortium responsible |
40-
| **Description** | One or two sentences on how CoreMeta4Cat is used |
41-
| **Link** | A URL to the project, dataset collection, or publication |
42-
| **Contact** | An optional name or email for follow-up |
53+
---
54+
55+
## Projects and repositories using CoreMeta4Cat
56+
57+
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.
58+
59+
!!! info "Is your project listed here?"
60+
If your project, repository, or tool uses CoreMeta4Cat, please open an issue or pull request on the [CoreMeta4Cat GitHub repository](https://github.com/nfdi4cat/CoreMeta4Cat) with the following information:
61+
62+
| Field | What to provide |
63+
|---|---|
64+
| **Project name** | The name of the project, repository, or tool |
65+
| **Organisation** | The institution or consortium responsible |
66+
| **Description** | One or two sentences on how CoreMeta4Cat is used |
67+
| **Link** | A URL to the project, dataset collection, or publication |
68+
| **Contact** | An optional name or email for follow-up |
4369

4470
---
4571

4672
## Scope of adoption
4773

48-
CoreMeta4Cat is designed to be adopted at different levels, depending on the use case:
74+
CoreMeta4Cat can be adopted at different levels depending on your use case — from simply using the vocabulary reference as a documentation guide, all the way to full semantic integration.
4975

5076
**Metadata collection and submission**
5177
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.
@@ -68,4 +94,4 @@ Because CoreMeta4Cat maps every class and slot to established ontology terms (Vo
6894
| [Voc4Cat](https://nfdi4cat.github.io/voc4cat/) | The NFDI4Cat controlled vocabulary, used for `rdf_type` classification terms throughout CoreMeta4Cat |
6995
| [DCAT-AP-PLUS](https://nfdi-de.github.io/dcat-ap-plus/dev/) | The base provenance layer that CoreMeta4Cat extends |
7096
| [LinkML](https://linkml.io/) | The schema language and tooling used to define and validate CoreMeta4Cat |
71-
| [CoreMeta4Cat on GitHub](https://github.com/HendrikBorgelt/CoreMeta4Cat) | Schema source files, issue tracker, and contribution guide |
97+
| [CoreMeta4Cat on GitHub](https://github.com/nfdi4cat/CoreMeta4Cat) | Schema source files, issue tracker, and contribution guide |

0 commit comments

Comments
 (0)