Last modified by adavison on 2024/11/13 10:32
From version 44.1
edited by adavison
on 2024/11/13 10:32
Change comment: There is no comment for this version
To version 42.5
edited by adavison
on 2024/11/13 10:29
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,6 +1,6 @@
1 1  == Audience ==
2 2  
3 -This guide is for software developers who would like to register their software in the EBRAINS Knowledge Graph (KG).
3 +This guide is for software developers who would like to register their software in the EBRAINS Knowledge Graph.
4 4  
5 5  == Introduction ==
6 6  
... ... @@ -8,17 +8,17 @@
8 8  
9 9  For this reason, the process of adding information about software and software versions has been automated as much as possible. Two methods are available:
10 10  
11 -1. providing a ##codemeta.json## file in your software repository.
11 +1. providing a codemeta.json file in your software repository.
12 12  1. publishing software through Zenodo.
13 13  
14 14  == Method 1: Providing a codemeta.json file in your software repository ==
15 15  
16 -[[CodeMeta>>https://codemeta.github.io/||rel="noopener noreferrer" target="_blank"]] is a project developed by a number of actors involved in sharing software, including Zenodo, GitHub, DataCite and Software Heritage, to provide a common specification for software metadata. EBRAINS has adopted the CodeMeta specification to maximise interoperability with other software repositories, and to minimise the added burden on software developers. A web form for generating ##codemeta.json## files is available at [[https:~~/~~/codemeta.github.io/codemeta-generator/>>https://codemeta.github.io/codemeta-generator/||rel="noopener noreferrer" target="_blank"]], provided by Software Heritage.
16 +[[CodeMeta>>https://codemeta.github.io/||rel="noopener noreferrer" target="_blank"]] is a project developed by a number of actors involved in sharing software, including Zenodo, GitHub, DataCite and Software Heritage, to provide a common specification for software metadata. EBRAINS has adopted the CodeMeta specification to maximise interoperability with other software repositories, and to minimise the added burden on software developers. A web form for generating codemeta.json files is available at [[https:~~/~~/codemeta.github.io/codemeta-generator/>>https://codemeta.github.io/codemeta-generator/||rel="noopener noreferrer" target="_blank"]], provided by Software Heritage.
17 17  
18 -To register your software with EBRAINS, place a ##codemeta.json## file in your code repository (e.g. on GitHub or GitLab), and send the URL of the file to the curation team via [[EBRAINS support>>https://ebrains.eu/support/||rel="noopener noreferrer" target="_blank"]]. Your software will then automatically be registered in the KG.
18 +To register your software with EBRAINS, place a codemeta.json file in your code repository (e.g. on GitHub or GitLab), and send the URL of the file to the curation team via [[EBRAINS support>>https://ebrains.eu/support/||rel="noopener noreferrer" target="_blank"]]. Your software will then automatically be registered in the KG.
19 19  
20 -Whenever you make a new release of the software, update the ##codemeta.json## file. EBRAINS will scan this file regularly and whenever it finds a new version identifier the new version will be added to the KG, and linked to all the previous versions.
20 +Whenever you make a new release of the software, update the codemeta.json file. EBRAINS will scan this file regularly and whenever it finds a new version identifier the new version will be added to the KG, and linked to all the previous versions.
21 21  
22 22  == Method 2: Publishing software through Zenodo ==
23 23  
24 -If you already share your software through Zenodo, you can register it with EBRAINS as well by sending the Zenodo URL to the curation team via [[EBRAINS support>>https://ebrains.eu/support/||rel="noopener noreferrer" target="_blank"]]. Whenever a new version of your software is published through Zenodo, it will also be automatically added to the KG.
24 +If you already share your software through Zenodo, you can register it with EBRAINS as well by sending the Zenodo URL to the curation team via [[EBRAINS support>>https://ebrains.eu/support/||rel="noopener noreferrer" target="_blank"]].