pid4cat-model

Handle-based PIDs with a rich LinkML metadata model for resources in catalysis (PID4Cat)

https://github.com/nfdi4cat/pid4cat-model

Science Score: 49.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 5 DOI reference(s) in README
✓
Academic publication links
Links to: zenodo.org
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.5%) to scientific vocabulary

Keywords

handles linkml linkml-schema persistent-identifiers

Last synced: 6 months ago · JSON representation

Repository

Handle-based PIDs with a rich LinkML metadata model for resources in catalysis (PID4Cat)

Basic Info

Host: GitHub
Owner: nfdi4cat
License: mit
Language: Python
Default Branch: main
Homepage: https://nfdi4cat.github.io/pid4cat-model/
Size: 5.98 MB

Statistics

Stars: 3
Watchers: 2
Forks: 3
Open Issues: 4
Releases: 4

Topics

handles linkml linkml-schema persistent-identifiers

Created about 2 years ago · Last pushed 7 months ago

Metadata Files

Readme Contributing License Code of conduct Zenodo

Persistent Identifiers for FAIR data in Catalysis

pid4cat is NFDI4Cat´s service for metadata rich, universal persistent identifiers. pid4cat builds upon the handle-system (as DOIs do). pid4cat adds a custom API to a handle server and provides a LinkML model for PID-related metadata. The metadata are stored in the handle records. pid4cat persistent identifiers are used for samples, devices, and more, to ensure consistent tracking, integration, and accessibility of resources across both central and local RDM systems.

Components of pid4cat

This repository contains

pid4cat service documentation
pid4cat model expressed as a LinkML model.
pid4cat-model Python package to interface the pid4cat service and handle the PID metadata

The PID metadata model and tools are generic and may be useful beyond catalysis.

Status: beta - This is in development and may still change. We are interested in feedback of potential users. Please use issues for your comments, questions or ideas!

Documentation

pid4cat documentation
pid4cat-model metadata schema documentation
pid4cat Python package metadata schema documentation, see also README_pypkg

Repository Structure

docs/ - mkdocs-managed documentation
- elements/ - generated schema documentation
examples/ - Examples of using the schema
project/ - project files (these files are auto-generated, do not edit)
src/ - source files
- pid4cat_model
- schema -- LinkML schema
- datamodel -- generated Python data models
- other modules included in Python package
tests/ - Python tests
- data/ - Example data

Developer Tools

There are several pre-defined command-recipes available. They are written for the command runner just. To list all pre-defined commands, run just or just --list.

Contributors

A big thanks to all contributors! Without you pid4cat would not exist.

In addition to the GitHub contributors, several people contributed offline:

Preston Rodriguez (ORCID: 0000-0002-0377-5018), @prestonrodrigues (implementation of handle API gateway server, operation of handle server)
Mark Dörr (ORCID: 0000-0003-3270-6895), @markdoerr (discussions on model and API)
Volodymyr Kushnarenko (ORCID: 0000-0001-7427-2410), @vkush (discussions on model, operation of handle server)
Hendrik Borgelt (ORCID: 0000-0001-5886-7860), @HendrikBorgelt (discussions on model)

Main author:

David Linke (ORCID: 0000-0002-5898-1820) - Idea, initial setup of repository, main developer of pid4cat-model and Python package, project coordination.

License

The code and data model in this repository are distributed under the MIT license. The documentation, images and logos are CC-BY 4.0 licensed.

Acknowledgement

This repository uses the template linkml-project-copier published as doi:10.5281/zenodo.15163584.

This project started as an in-kind contribution of Leibniz-Institut für Katalyse e.V. (Rostock, Germany) to the NFDI4Cat project.

After 2024-03-27 this work has been funded by the German Research Foundation (DFG) through the project "NFDI4Cat - NFDI for Catalysis-Related Sciences" (DFG project no. 441926934), within the National Research Data Infrastructure (NFDI) programme of the Joint Science Conference (GWK).

Owner

Name: NFDI4Cat
Login: nfdi4cat
Kind: organization
Location: Germany

Website: https://nfdi4cat.org/
Twitter: nfdi4cat
Repositories: 13
Profile: https://github.com/nfdi4cat

Working on a research data infrastructure for the catalysis disciplines.

GitHub Events

Total

Create event: 87
Release event: 3
Issues event: 82
Watch event: 1
Delete event: 81
Issue comment event: 41
Push event: 287
Pull request review event: 1
Pull request review comment event: 4
Pull request event: 139
Fork event: 2

Last Year

Create event: 87
Release event: 3
Issues event: 82
Watch event: 1
Delete event: 81
Issue comment event: 41
Push event: 287
Pull request review event: 1
Pull request review comment event: 4
Pull request event: 139
Fork event: 2

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 45
Total pull requests: 142
Average time to close issues: 16 days
Average time to close pull requests: 3 days
Total issue authors: 2
Total pull request authors: 3
Average comments per issue: 0.93
Average comments per pull request: 0.11
Merged pull requests: 129
Bot issues: 0
Bot pull requests: 31

Past Year

Issues: 44
Pull requests: 136
Average time to close issues: 16 days
Average time to close pull requests: 3 days
Issue authors: 2
Pull request authors: 3
Average comments per issue: 0.95
Average comments per pull request: 0.12
Merged pull requests: 123
Bot issues: 0
Bot pull requests: 28

View more stats

Top Authors

Issue Authors

dalito (44)
markdoerr (2)

Pull Request Authors

dalito (116)
dependabot[bot] (33)
markdoerr (3)

Top Labels

Issue Labels

enhancement (18) bug (7) documentation (5) upstream (1) discussion (1) dependencies (1) help wanted (1)

Pull Request Labels

dependencies (38) github_actions (13) documentation (7) enhancement (5) gateway-API (1)

Packages

Total packages: 1
Total downloads:
- pypi 18 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 4
Total maintainers: 1

pypi.org: pid4cat-model

Python model equivalent of LinkML datamodel for handle-based PIDs for resources in catalysis (pid4cat)

Documentation: https://pid4cat-model.readthedocs.io/
License: mit
Latest release: 0.4.2
published 9 months ago

Versions: 4
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 18 Last month

Rankings

Dependent packages count: 9.3%

Average: 31.0%

Dependent repos count: 52.6%

Maintainers (1)

dalito