voc4cat

A SKOS vocabulary for catalysis maintained by NFDI4Cat & friends

https://github.com/nfdi4cat/voc4cat

Science Score: 77.0%

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

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 7 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    1 of 5 committers (20.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.3%) to scientific vocabulary

Keywords

catalysis nfdi nfdi4cat skos taxonomy vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

A SKOS vocabulary for catalysis maintained by NFDI4Cat & friends

Basic Info
Statistics
  • Stars: 14
  • Watchers: 4
  • Forks: 13
  • Open Issues: 14
  • Releases: 6
Topics
catalysis nfdi nfdi4cat skos taxonomy vocabulary
Created almost 3 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation Codeowners Zenodo

README.md

DOI SKOS logo

A SKOS vocabulary for the catalysis disciplines

The first collection of terms was published in June 2023. Since then we are continuously extending the vocabulary with the help of the community to cover all subdisciplines of catalysis. Please join if you like to help.

The Voc4Cat vocabulary and its current guidelines have been created and are maintained as part of the NFDI4Cat initiative. The guidelines have also been published at Zenodo.

This repository was created from the template voc4cat-template. It uses the voc4cat-tool and GitHub features like pull requests, actions, pages etc. to reduce the maintenance workload for contributors and editors.

Basic principles

Voc4cat makes contributing easy for everyone with a GitHub account. The process is essentially (see further below for details, browse through our step-by-step guide, or read the guide in pdf form with screenshots of each step (https://zenodo.org/records/13757351).

  • Download the most current vocabulary file (xlsx),
  • Edit the vocabulary file in Excel,
  • Submit a pull request with the updated file placed in the folder inbox-excel-vocabs.
    It is important to keep the original file name voc4cat.xlsx.

After approval your pull request is ready to be merged by the editors. The merge will integrate your contribution into the SKOS-vocabulary files in the vocabularies-folder. Upon merge the corresponding documentation and a joined turtle file will be automatically built and published to GitHub pages.

Besides this "in-development" version of the vocabulary, the latest released version and older releases are also available.

Links to specific versions:

  • latest released version
    • https://w3id.org/nfdi4cat/voc4cat
  • "in-development" version (built from most recent commit to main)
    • voc4cat vocabulary documentation https://w3id.org/nfdi4cat/voc4cat/dev
  • current and earlier releases identified by release date (the "v" before the data is optional)
    • General scheme https://w3id.org/nfdi4cat/voc4cat/{release-tag}
      for example https://w3id.org/nfdi4cat/voc4cat/v2023-08-17

We have configured content negotiation for these URLs. So you can get the human readable HTML documentation but also the machine-readable turtle file of the vocabulary from the same URL. The IRI-design is described in detail in iri-design.md.

To get the turtle file you may use tools like curl or httpie that allow to specify the content type. For example, to download the turtle file of the latest released version:

```bash

with httpie

http -o voc4cat.ttl --download https://w3id.org/nfdi4cat/voc4cat Accept:"application/x-turtle"

with curl

curl -o voc4cat.ttl -L -H "accept:application/x-turtle" https://w3id.org/nfdi4cat/voc4cat ```

We also provide links to turtle files of individual concepts and collections:

  • for the latest release https://w3id.org/nfdi4cat/voc4cat_{NUMERIC-ID}.ttl
    for example https://w3id.org/nfdi4cat/voc4cat_0000123
  • for releases by date-tag https://w3id.org/nfdi4cat/voc4cat/{release-tag}/voc4cat_{NUMERIC-ID}.ttl
    for example https://w3id.org/nfdi4cat/voc4cat/v2023-08-17/voc4cat_0000123

In addition to the specific versions, an index page is generated that links to all tagged releases. It is placed at the root of the gh-pages branch.

To see how voc4cat rates in the qSKOS quality checks, you can use this link to the SKOS testing tool.

API access

voc4cat is also available via the TIB Terminology Service. This service offers API access to voc4cat. Currently a modified version of OLS is used. There are plans to host voc4cat and other vocabularies on a SKOSMOS server in the future which will provide more SKOS-specific features than OLS.

Contributing to vocabularies

To discuss about the voc4cat-vocabulary maintained here, create an issue.

To contribute new concepts or collections or change existing ones, you may either submit your contributions as Excel/xlsx-file or (as an expert) as new/changed turtle file.

Small contributions like adding a single concept are as valuable as bigger ones. In fact if you plan a bigger change (50+ concepts), consider splitting up the additions/changes into smaller chunks with max. ~20 changes to make the review process not too hard for the reviewers and you as author.

Here are the steps for submitting updates via Excel/xlsx:

- Get the Excel/xlsx-vocabulary file - The most recent version of the vocabulary is always available via GitHub-pages https://nfdi4cat.github.io/voc4cat/dev/voc4cat.xlsx - Make changes to the Excel file. If you want to add something new you need to request a range of IDs for you. - Create a fork of the voc4cat repository (if you don't yet have one) or pull the latest changes to your fork (via "Sync fork" button in GUI). - Create a feature branch for your contribution (via GitHub GUI or git switch -c name-of-branch) - Add the xlsx file to the feature branch into the folder inbox-excel-vocabs - The name of the file must match the vocabulary that you want to update. So do not change the filename, but keep voc4cat.xlsx. - Create a pull request with the updated Excel-file in this repository. - Please describe your changes and the motivation for the changes in the pull request note or link to an issue with this information. This will help reviewers to understand the proposed change and decide about it. - Your pull request will be processed automatically by a CI/CD pipeline that typically finishes in less than a minute. - Review the artifacts/logs generated by the CI pipeline. - The workflow artifact will contain an updated xlsx file that is recreated from the updated turtle-files. - If all is good your contribution will be either - directly merged by the maintainers - or a discussion will be started about what else is needed - or why the proposed change may not fit. - If you need to fix something, first pull the changes made by the action with git pull (or "sync" in GUI) and then commit further changes to the pull request branch in your clone. - If any commits have been made by the CI pipeline, pull the changes to your repo (via "Sync fork" button in GUI) before committing any additional changes.

Finally, when the proposed pull request is accepted, your changes will be integrated in the vocabularies in the folder vocabularies. The vocabularies are stored in split form using one folder per vocabulary. Each concept, collection and concept scheme is stored in a separate file using the ID-part of the IRI as file name.

See inbox-excel-vocabs/README.md for a minimal example how to test the submission process.

How to suggest improvements to the tooling & template?

To discuss about the workflow for maintaining SKOS vocabularies based on this template, create an voc4cat-template issue.

To discuss about the tool that converts Excel to SKOS in GitHub-actions of this template, create an voc4cat-tool issue.

Documentation for voc4cat maintainers

See section for maintainers in the documentation.

Contributors

For details see the Zenodo record.

A big thanks to our GitHub contributors:

Voc4Cat contributors

Figure made with contrib.rocks.

License

Vocabularies

All vocabularies in this repository are CC0-1.0 licensed, see LICENSE for details.

Voc4Cat template

The template itself is CC0-1.0 licensed, see LICENSE. Although there is no obligation, we will nevertheless highly appreciate if you acknowledge our work in any derivative work.

Acknowledgement

This work was 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).

Special thanks to:

Owner

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

Working on a research data infrastructure for the catalysis disciplines.

Citation (CITATION.bib)

@misc{david_linke_2023_8313340,
  author       = {David Linke, voc4cat contributors},
  title        = {nfdi4cat/voc4cat - A SKOS vocabulary for the catalysis disciplines.},
  year         = {2023--2025},
  publisher    = {Zenodo},
  doi          = {10.5281/zenodo.8313340},
  url          = {https://doi.org/10.5281/zenodo.8313340}
}

GitHub Events

Total
  • Create event: 39
  • Release event: 3
  • Issues event: 32
  • Watch event: 7
  • Delete event: 39
  • Issue comment event: 67
  • Push event: 113
  • Pull request review comment event: 105
  • Pull request review event: 121
  • Pull request event: 103
  • Fork event: 3
Last Year
  • Create event: 39
  • Release event: 3
  • Issues event: 32
  • Watch event: 7
  • Delete event: 39
  • Issue comment event: 67
  • Push event: 113
  • Pull request review comment event: 105
  • Pull request review event: 121
  • Pull request event: 103
  • Fork event: 3

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 113
  • Total Committers: 5
  • Avg Commits per committer: 22.6
  • Development Distribution Score (DDS): 0.159
Past Year
  • Commits: 96
  • Committers: 4
  • Avg Commits per committer: 24.0
  • Development Distribution Score (DDS): 0.177
Top Committers
Name Email Commits
David Linke d****e@c****e 95
David Linke d****o 13
David Linke d****e@g****m 2
Nikolaos Moustakas 1****t 2
CI.runner C****r@g****e 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 55
  • Total pull requests: 109
  • Average time to close issues: 26 days
  • Average time to close pull requests: 4 days
  • Total issue authors: 11
  • Total pull request authors: 13
  • Average comments per issue: 0.96
  • Average comments per pull request: 0.63
  • Merged pull requests: 81
  • Bot issues: 0
  • Bot pull requests: 9
Past Year
  • Issues: 24
  • Pull requests: 54
  • Average time to close issues: 8 days
  • Average time to close pull requests: about 17 hours
  • Issue authors: 6
  • Pull request authors: 7
  • Average comments per issue: 0.54
  • Average comments per pull request: 0.22
  • Merged pull requests: 39
  • Bot issues: 0
  • Bot pull requests: 9
Top Authors
Issue Authors
  • dalito (32)
  • RoteKekse (5)
  • HendrikBorgelt (4)
  • nmoust (4)
  • markdoerr (3)
  • schumannj (2)
  • FranziFlecken (2)
  • sofia-angeli (1)
  • khatamirad (1)
  • MontyBitto (1)
  • carla-terboven (1)
Pull Request Authors
  • dalito (75)
  • nmoust (16)
  • dependabot[bot] (11)
  • HendrikBorgelt (4)
  • schumannj (3)
  • RoteKekse (2)
  • FranziFlecken (2)
  • carla-terboven (1)
  • markdoerr (1)
  • philippstangl (1)
  • sofia-angeli (1)
  • khatamirad (1)
  • kara-mela (1)
Top Labels
Issue Labels
enhancement (8) bug (7) documentation (6) voc4cat guidelines (5) discussion (3) question (2) housekeeping (2)
Pull Request Labels
dependencies (12) enhancement (10) bug (9) housekeeping (9) documentation (8) github_actions (5) voc4cat guidelines (1) python (1)

Dependencies

.github/workflows/ci-pr.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • stefanzweifel/git-auto-commit-action 3ea6ae190baf489ba007f7c92608f33ce20ef04a composite
.github/workflows/merge.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • peaceiris/actions-gh-pages 373f7f263a76c20808c831209c920827a82a2847 composite
.github/workflows/publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • peaceiris/actions-gh-pages 373f7f263a76c20808c831209c920827a82a2847 composite