Last modified by adavison on 2024/11/13 10:32
From version 15.2
edited by jan
on 2022/11/30 10:10
Change comment: There is no comment for this version
To version 23.1
edited by jan
on 2022/12/09 09:49
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,20 +1,34 @@
1 -== Contents ==
1 += Contents[[[[image:EBRAINS-Share-Software.jpg||alt="Infographic Software Curation" height="532" style="float:right" width="298"]]>>attach:EBRAINS-Share-Software.jpg]] =
2 2  
3 -{{toc/}}
3 +{{toc start="2"/}}
4 4  
5 -This guide provides a starting point and reference for the process of entering information about your software into the EBRAINS Knowledge Graph (KG).
5 +This guide provides a starting point and reference for the process of entering information about your software
6 +into the EBRAINS Knowledge Graph (KG).
6 6  
8 +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]].
9 +
7 7  **For any questions or support directly reach out to [[Jan Gründling>>mailto:gruendling@uni-trier.de]].**
8 8  
12 +
13 +
14 +
15 +
16 +
17 +
18 +
19 +----
20 +
9 9  == How to enter software metadata manually ==
10 10  
23 +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]].
24 +
11 11  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).
12 12  
13 13  **Before explaining the editing process, here are some helpful links:**
14 14  
15 15  * 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]]
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]]
30 +* Additional information for each attribute: [[Attribute Description>>doc:Collabs.swc-guide.Attribute description.WebHome]]
31 +* A detailed description of the software features: [[Software Features>>doc:Collabs.swc-guide.Software Features.WebHome]]
18 18  
19 19  **Editing the software and software version instances:**
20 20  
... ... @@ -24,7 +24,7 @@
24 24  
25 25  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.
26 26  
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:
41 +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:
28 28  
29 29  [[image:Collabs.swc-guide.EBRAINS Knowledge Graph guide for software curation.WebHome@guideDev.JPG||height="109" width="600"]]
30 30  
... ... @@ -42,13 +42,13 @@
42 42  
43 43  The curators will check the new software instances and move them to the correct space.
44 44  
45 -== How to update an existing Software instances ==
59 +== How to update existing Software instances ==
46 46  
47 47  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".
48 48  
49 49  **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/]]**
50 50  
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.
65 +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.
52 52  
53 53  == How to upload software metadata programmatically ==
54 54  
EBRAINS-Share-Software.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.jan
Size
... ... @@ -1,0 +1,1 @@
1 +707.2 KB
Content