Skip to content

Commit

Permalink
Fix "catalyst bed" relations & README improvement (#75)
Browse files Browse the repository at this point in the history
* Catalyst bed is no reactor type 
* README improvements
  • Loading branch information
dalito committed Apr 29, 2024
1 parent 717a4d5 commit 0e8d923
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 10 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,26 +73,29 @@ To discuss about the **voc4cat**-vocabulary maintained here, create an [issue](h

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. ~25 changes to make the review process not too hard for the reviewers and you as author.
> 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](https://github.com/nfdi4cat/voc4cat/issues/new/choose) for you.
- Add the xlsx file to your clone of the repository into the folder `inbox-excel-vocabs`
- 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 runs less than a minute.
- 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](https://docs.github.com/en/actions/managing-workflow-runs/downloading-workflow-artifacts) will contain an updated xlsx file that is recreated from the updated turtle-file.
- 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 update the pull request branch. This will trigger the pipeline to run again.
- If you need to fix something, 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.
Expand Down
2 changes: 2 additions & 0 deletions vocabularies/voc4cat/0005009.ttl
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
PREFIX dcterms: <http://purl.org/dc/terms/>
PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
PREFIX skos: <http://www.w3.org/2004/02/skos/core#>
PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>

<https://w3id.org/nfdi4cat/voc4cat_0005009>
a skos:Concept ;
dcterms:identifier "voc4cat_0005009"^^xsd:token ;
rdfs:isDefinedBy <https://www.w3.org/TR/2010/NOTE-curie-20101216/> ;
skos:altLabel "formation rate"@en ;
skos:definition "Is a quantity describing how fast a product is formed in a chemical reaction. It is defined by the amount of product formed per unit of time."@en ;
skos:historyNote "0000-0002-5898-1820 David Linke created the resource"@en ;
Expand Down
2 changes: 1 addition & 1 deletion vocabularies/voc4cat/0007020.ttl
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>
<https://w3id.org/nfdi4cat/voc4cat_0007020>
a skos:Concept ;
dcterms:identifier "voc4cat_0007020"^^xsd:token ;
skos:broader <https://w3id.org/nfdi4cat/voc4cat_0007036> ;
skos:definition "The part of the reactor where the catalyst is located, characterized by length, diameter, volume."@en ;
skos:historyNote "0000-0002-4041-0165 Julia Schumann created the resource"@en ;
skos:inScheme <https://w3id.org/nfdi4cat/voc4cat_> ;
skos:prefLabel "catalyst bed"@en ;
skos:topConceptOf <https://w3id.org/nfdi4cat/voc4cat_> ;
.

4 changes: 1 addition & 3 deletions vocabularies/voc4cat/0007036.ttl
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@ PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>
skos:definition "A chemical reactor in which the reaction is carried out in the presence of a catalyst."@en ;
skos:historyNote "0000-0002-4041-0165 Julia Schumann created the resource"@en ;
skos:inScheme <https://w3id.org/nfdi4cat/voc4cat_> ;
skos:narrower
<https://w3id.org/nfdi4cat/voc4cat_0007019> ,
<https://w3id.org/nfdi4cat/voc4cat_0007020> ;
skos:narrower <https://w3id.org/nfdi4cat/voc4cat_0007019> ;
skos:prefLabel "catalytic reactor"@en ;
.

3 changes: 2 additions & 1 deletion vocabularies/voc4cat/concept_scheme.ttl
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>
<https://w3id.org/nfdi4cat/voc4cat_0001900> ,
<https://w3id.org/nfdi4cat/voc4cat_0001901> ;
dcterms:identifier "voc4cat_"^^xsd:token ;
dcterms:modified "2024-03-09"^^xsd:date ;
dcterms:modified "2024-04-08"^^xsd:date ;
dcterms:publisher <https://w3id.org/nfdi4cat/> ;
owl:versionInfo "automatic" ;
skos:definition "A vocabulary for all areas of catalysis initiated in NFDI4Cat. Starting with photocatalysis we add more and more terms from other areas of catalysis and related disciplines like chemical engineering or materials science."@en ;
Expand All @@ -35,6 +35,7 @@ PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>
<https://w3id.org/nfdi4cat/voc4cat_0007016> ,
<https://w3id.org/nfdi4cat/voc4cat_0007017> ,
<https://w3id.org/nfdi4cat/voc4cat_0007018> ,
<https://w3id.org/nfdi4cat/voc4cat_0007020> ,
<https://w3id.org/nfdi4cat/voc4cat_0007023> ,
<https://w3id.org/nfdi4cat/voc4cat_0007024> ,
<https://w3id.org/nfdi4cat/voc4cat_0007025> ,
Expand Down

0 comments on commit 0e8d923

Please sign in to comment.