Changes for page Guide to Software Curation in the EBRAINS Knowledge Graph
Last modified by adavison on 2024/11/13 10:32
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Attachments (0 modified, 0 added, 1 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,24 +1,20 @@ 1 -= Contents = 1 +== Contents == 2 2 3 -{{toc start="2"/}}3 +{{toc/}} 4 4 5 5 This guide provides a starting point and reference for the process of entering information about your software into the EBRAINS Knowledge Graph (KG). 6 6 7 -For an overview of the software curation process, please refer to [[our info graphic>>https://drive.ebrains.eu/lib/f5cf4964-f095-49bd-8c34-e4ffda05a497/file/EBRAINS-Share-Software.pdf]]. 8 - 9 9 **For any questions or support directly reach out to [[Jan Gründling>>mailto:gruendling@uni-trier.de]].** 10 10 11 11 == How to enter software metadata manually == 12 12 13 -If your software has not been curated before, please fill in the request form [[here>>https://nettskjema.no/a/104328]] before continuing with the following instructions. If your Software has been curated already and you want do add a new version, refer to the section [[How to Update>>https://wiki.ebrains.eu/bin/view/Collabs/swc-guide#HHowtoupdateexistingSoftwareinstances]]. 14 - 15 15 You will receive an email after the curator has created a space for you in the Knowledge Graph. This email contains a link to a software instance and a software version instance in your Space. These are already linked to each other (by the attribute "Has Version" of the software instance). 16 16 17 17 **Before explaining the editing process, here are some helpful links:** 18 18 19 19 * A description of the fields of the software and software version instances and values that these fields may take: [[https:~~/~~/humanbrainproject.github.io/openMINDS/v2/core/v3/products/softwareVersion.html>>url:https://humanbrainproject.github.io/openMINDS/v2/core/v3/products/softwareVersion.html]] and [[https:~~/~~/humanbrainproject.github.io/openMINDS/v2/core/v3/products/software.html>>url:https://humanbrainproject.github.io/openMINDS/v2/core/v3/products/software.html]] 20 -* Additional information for each attribute: [[Attribute Description>>doc: Collabs.swc-guide.Attribute description.WebHome]]21 -* A detailed description of the software features: [[Software Features>>doc: Collabs.swc-guide.Software Features.WebHome]]16 +* Additional information for each attribute: [[Attribute Description>>doc:.EBRAINS Knowledge Graph guide for software curation.Attribute description.WebHome]] 17 +* A detailed description of the software features: [[Software Features>>doc:.EBRAINS Knowledge Graph guide for software curation.Software Features.WebHome]] 22 22 23 23 **Editing the software and software version instances:** 24 24 ... ... @@ -28,7 +28,7 @@ 28 28 29 29 As you can see in the screenshot above, some fields are marked with an asterisk (*). These are required. Keep in mind that this is how you present your software publicly to potential end-users or other researchers. Therefore it would be nice if as many fields as possible are filled in. 30 30 31 -Some fields can be of different types, such as the field " Developer" and "Full documentation". In the case of developer it is possible to enter a person or an organisation. The possible types are selectable on the right above the respective field, as shown in the following screenshots:27 +Some fields can be of different types, such as the field "developer" and "Full documentation". In the case of developer it is possible to enter a person or an organisation. The possible types are selectable on the right above the respective field, as shown in the following screenshots: 32 32 33 33 [[image:Collabs.swc-guide.EBRAINS Knowledge Graph guide for software curation.WebHome@guideDev.JPG||height="109" width="600"]] 34 34 ... ... @@ -46,13 +46,13 @@ 46 46 47 47 The curators will check the new software instances and move them to the correct space. 48 48 49 -== How to update existing Software instances == 45 +== How to update an existing Software instances == 50 50 51 51 If you have registered a software previously, updating means adding a new instance of type "Software version". Curators will later link it to the existing instance of type "Software". 52 52 53 53 **If you want to add a new version to an already curated software, please write to [[curation-support@humanbrainproject.eu>>path:mailto:curation-support@humanbrainproject.eu]] or open a ticket at [[https:~~/~~/support.humanbrainproject.eu/>>url:https://support.humanbrainproject.eu/]]** 54 54 55 -To make updating easier, we place a copy of your last software version instance in the KG space that was created for you. You can use that copy and just change the fields that require changes. Again - if you made all changes that you consider necessary, let the curator know via email or the ticket assigned with this case. 51 +To make updating easier, we have already placed a copy of your last software version instance in the KG space that was created for you. You can use that copy and just change the fields that require changes. Again - if you made all changes that you consider necessary, let the curator know via email or the ticket assigned with this case. 56 56 57 57 == How to upload software metadata programmatically == 58 58
- EBRAINS-Share-Software.jpg
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.jan - Size
-
... ... @@ -1,1 +1,0 @@ 1 -707.2 KB - Content