Warning:  Due to planned infrastructure maintenance, the EBRAINS Wiki and EBRAINS Support system will be unavailable for up to three days starting Monday, 14 July. During this period, both services will be inaccessible, and any emails sent to the support address will not be received.

Attention: We are currently experiencing some issues with the EBRAINS Drive. Please bear with us as we fix this issue. We apologise for any inconvenience caused.


Last modified by adavison on 2024/11/13 11:30
From version 40.1
edited by jan
on 2022/11/30 14:35
Change comment: There is no comment for this version
To version 13.2
edited by jan
on 2022/03/23 12:15
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,1 @@
1 -Collabs.swc-guide.WebHome
1 +Collabs.sw-curation-nest-desktop.WebHome
Content
... ... @@ -1,59 +1,43 @@
1 -= Contents =
1 +(% class="wikigeneratedid" %)
2 +~*~*~* This Guide is not complete yet and needs further extension. It is in an alpha version. For any questions or support directly reach out to [[Jan Gründling>>mailto:gruendling@uni-trier.de]].~*~**
2 2  
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 +(% 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:
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 -**For any questions or support directly reach out to [[Jan Gründling>>mailto:gruendling@uni-trier.de]].**
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]].
10 +To manually input meta data of your software into the KG, you use a tool called "KG Editor". The KG Editor can be reached at [[HBP Knowledge Graph Editor>>url:https://editor.kg.ebrains.eu/]]. Just log in with your HBP credentials.
14 14  
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).
12 +After you are logged in, you are probably prompted to choose a space in a view like below:
16 16  
17 -**Before explaining the editing process, here are some helpful links:**
14 +[[image:image-20220323113258-3.png||height="386" width="681"]]
18 18  
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:.EBRAINS Knowledge Graph guide for software curation.Attribute description.WebHome]]
21 -* A detailed description of the software features: [[Software Features>>doc:.EBRAINS Knowledge Graph guide for software curation.Software Features.WebHome]]
16 +From the available choices (should not be too many in your case) choose the one that corresponds to the title of your software. Something like## swcuration-{your_software_name} ##should apply.
22 22  
23 -*
18 +After that, you see the view below. now click on the little magnifyer glass symbol at the top.
24 24  
25 -**Editing the software and software version instances:**
20 +[[image:image-20220323120123-6.png||height="412" width="1032"]]
26 26  
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 +After that, you see this list on the left side:
28 28  
29 -[[image:guide1.JPG]]
24 +[[image:image-20220323121426-1.png||height="202" width="258"]]
30 30  
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 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:
27 +To register your software, you will need to create one instance "Software" and one or more instances "Software version". To create instances, just click the small +button that appears when you are hovering over the respective list entry. We recommed starting with "Software". After clicking the plus icon you will see a view like below:
34 34  
35 -[[image:guideDev.JPG||height="109" width="600"]]
29 +[[image:image-20220323120955-9.png||height="802" width="712"]]
36 36  
37 -[[image:guide21.JPG||height="142" width="600"]]
38 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.
32 +Now you can start entering the information on your data! Fields marked with an asterisk (*) are required. When you arrive at the "Has version" field, you can create one or more versions of your software to be curated.
40 40  
41 -[[image:guide6.JPG]]
34 +After you have entered the software, **do not forget to save your changes!**
42 42  
43 -If you are not sure which type to use, please refer to the descriptions linked above or contact the curator.
36 +[[image:image-20220323121238-10.png]]
44 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 46  
47 -[[image:guide4.JPG||height="189" width="400"]]
39 +That's it. When you are done, just contact the curators via your ticket.
48 48  
49 -The curators will check the new software instances and move them to the correct space.
50 -
51 -=== How to update an existing Software instances ===
52 -
53 -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".
54 -
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.
56 -
57 57  == How to upload software metadata programmatically ==
58 58  
59 59  To create a valid jsonld file, please use the [[API>>https://core.kg.ebrains.eu/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config]].
... ... @@ -63,4 +63,4 @@
63 63  
64 64  Before using it, you need to authorize, using the "Authorize" button found in the top right corner of the API documentation (see below) or by using a service account.
65 65  
66 -[[image:image-20220323111341-2.png||height="74" width="186"]]
50 +[[image:image-20220323111341-2.png]]
guide1.JPG
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.patriziaduhr
Size
... ... @@ -1,1 +1,0 @@
1 -95.5 KB
Content
guide2.JPG
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.patriziaduhr
Size
... ... @@ -1,1 +1,0 @@
1 -16.3 KB
Content
guide21.JPG
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.patriziaduhr
Size
... ... @@ -1,1 +1,0 @@
1 -17.0 KB
Content
guide4.JPG
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.patriziaduhr
Size
... ... @@ -1,1 +1,0 @@
1 -13.9 KB
Content
guide5.JPG
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.patriziaduhr
Size
... ... @@ -1,1 +1,0 @@
1 -174.3 KB
Content
guide6.JPG
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.patriziaduhr
Size
... ... @@ -1,1 +1,0 @@
1 -174.3 KB
Content
guideDev.JPG
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.patriziaduhr
Size
... ... @@ -1,1 +1,0 @@
1 -16.3 KB
Content
image-20220323152326-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.jan
Size
... ... @@ -1,1 +1,0 @@
1 -70.9 KB
Content