Attention: The Collaboratory IAM will down for up to 1 hour on Monday, the 7th of July 2025 starting from 5pm CEST (my timezone) for up to 1 hour. Any and all services, which require a user login with an EBRAINS account, will be un-available during that time


Last modified by adavison on 2024/11/13 11:30
From version 33.1
edited by patriziaduhr
on 2022/11/13 09:13
Change comment: Uploaded new attachment "guideDev.JPG", version {1}
To version 40.2
edited by jan
on 2022/11/30 14:41
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.patriziaduhr
1 +XWiki.jan
Content
... ... @@ -1,32 +1,58 @@
1 -(% class="wikigeneratedid" %)
2 -**For any questions or support directly reach out to [[Jan Gründling>>mailto:gruendling@uni-trier.de]].**
1 += Contents =
3 3  
3 +{{toc start="2"/}}
4 4  
5 -(% class="wikigeneratedid" %)
6 -This guide provides a starting point and reference for the process of entering information about your software into the EBRAINS Knowledge Graph (KG). There are two ways, the manual and the programmatical one:
5 +This guide provides a starting point and reference for the process of entering information about your software into the EBRAINS Knowledge Graph (KG).
7 7  
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 +**For any questions or support directly reach out to [[Jan Gründling>>mailto:gruendling@uni-trier.de]].**
10 +
8 8  == How to enter software metadata manually ==
9 9  
10 -Fields marked with an asterisk (*) are required. When you are done, just contact the curators by answering to your ticket email.
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]].
11 11  
12 -(% id="cke_bm_36775S" style="display:none" %) (%%)To register your software, you will need to input information for the instance "Software" and for  "Software version".
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).
13 13  
14 -After clicking the link for software sent to you, you will see an instance editor view like below, where you can add all relevant information on your software. Please note that fields marked with an asterisk (*) are mandatory.
17 +**Before explaining the editing process, here are some helpful links:**
15 15  
16 -When finished with the software view, repeat the same for the software version.
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]]
17 17  
18 -[[image:image-20220323152326-1.png||height="1062" width="1023"]]
23 +*
19 19  
25 +**Editing the software and software version instances:**
20 20  
21 -After you have entered and information on the software, **do not forget to save your changes!**
27 +To register your software, you will need to input information for the instance "Software" and for  "Software version". After clicking the links in your email, you will see an instance editor view like below:
22 22  
23 -**-> **[[image:image-20220323121238-10.png||height="170" width="382"]]
29 +[[image:guide1.JPG]]
24 24  
31 +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.
32 +
33 +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:
34 +
35 +[[image:guideDev.JPG||height="109" width="600"]]
36 +
37 +[[image:guide21.JPG||height="142" width="600"]]
38 +
39 +For example, if you want to create a new person, an editing field opens in the right column of the instance editor view as shown in the following screenshot.
40 +
41 +[[image:guide6.JPG]]
42 +
43 +If you are not sure which type to use, please refer to the descriptions linked above or contact the curator.
44 +
45 +After you have entered your information on the software, **do not forget to save your changes **(see screenshot below) and contact the curator.
46 +
47 +[[image:guide4.JPG||height="189" width="400"]]
48 +
49 +The curators will check the new software instances and move them to the correct space.
50 +
25 25  === How to update an existing Software instances ===
26 26  
27 27  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".
28 28  
29 -To make updating easier, we have already placed a copy of your last software version instance in the KG space that belongs to this collab. 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 the ticket assigned with this case.
55 +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.
30 30  
31 31  == How to upload software metadata programmatically ==
32 32  
guide5.JPG
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.patriziaduhr
Size
... ... @@ -1,0 +1,1 @@
1 +174.3 KB
Content
guide6.JPG
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.patriziaduhr
Size
... ... @@ -1,0 +1,1 @@
1 +174.3 KB
Content