Last modified by adavison on 2024/11/13 11:30
From version 19.2
edited by jan
on 2022/03/23 22:18
Change comment: There is no comment for this version
To version 35.1
edited by patriziaduhr
on 2022/11/13 09:33
Change comment: Uploaded new attachment "guide5.JPG", version {1}

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,1 @@
1 -Collabs.sw-curation-nest-desktop.WebHome
1 +Collabs.swc-guide.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.jan
1 +XWiki.patriziaduhr
Content
... ... @@ -1,5 +1,5 @@
1 1  (% class="wikigeneratedid" %)
2 -**~*~*~* This Guide is not complete yet and needs further extension. For any questions or support directly reach out to [[Jan Gründling>>mailto:gruendling@uni-trier.de]].~*~****
2 +**For any questions or support directly reach out to [[Jan Gründling>>mailto:gruendling@uni-trier.de]].**
3 3  
4 4  
5 5  (% class="wikigeneratedid" %)
... ... @@ -7,43 +7,41 @@
7 7  
8 8  == How to enter software metadata manually ==
9 9  
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.
10 +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).
11 11  
12 -After you are logged in, you are probably prompted to choose a space in a view like below:
12 +**Before explaining the editing process, here are some helpful links:**
13 13  
14 -[[image:image-20220323113258-3.png||height="386" width="681"]]
14 +* 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]]
15 +* additional information for each attribute: [[https:~~/~~/github.com/bweyers/HBPVisCatalogue/wiki/Attribute-Descriptions>>url:https://github.com/bweyers/HBPVisCatalogue/wiki/Attribute-Descriptions]]
16 +* a detailed description of the software features: [[https:~~/~~/github.com/bweyers/HBPVisCatalogue/wiki/Identified-Software-Features>>url:https://github.com/bweyers/HBPVisCatalogue/wiki/Identified-Software-Features]]
15 15  
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.
18 +**Editing the software and software version instances:**
17 17  
18 -After that, you see the view below. now click on the little magnifyer glass symbol at the top.
20 +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:
19 19  
20 -[[image:image-20220323120123-6.png||height="412" width="1032"]]
22 +[[image:guide1.JPG]]
21 21  
22 -After that, you see this list on the left side:
24 +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.
23 23  
24 -[[image:image-20220323121426-1.png||height="202" width="258"]]
26 +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:
25 25  
28 +[[image:guideDev.JPG||height="109" width="600"]]
26 26  
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 the software instance editor view like below:
30 +[[image:guide21.JPG||height="142" width="600"]]
28 28  
29 -[[image:image-20220323152326-1.png||height="1062" width="1023"]]
32 +If you are not sure which type to use, please refer to the descriptions linked above or contact the curator.
30 30  
34 +After you have entered your information on the software, **do not forget to save your changes **(see screenshot below) and contact the curator.
31 31  
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.
36 +[[image:guide4.JPG||height="189" width="400"]]
33 33  
34 -After you have entered the software, **do not forget to save your changes!**
38 +The curators will check the new software instances and move them to the correct space.
35 35  
36 -[[image:image-20220323121238-10.png||height="170" width="382"]]
37 -
38 -
39 -That's it. When you are done, just contact the curators via your ticket.
40 -
41 -
42 42  === How to update an existing Software instances ===
43 43  
44 44  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".
45 45  
46 -To make updating easier, we have already placed a copy of your last 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.
44 +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.
47 47  
48 48  == How to upload software metadata programmatically ==
49 49  
... ... @@ -54,4 +54,4 @@
54 54  
55 55  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.
56 56  
57 -[[image:image-20220323111341-2.png]]
55 +[[image:image-20220323111341-2.png||height="74" width="186"]]
guide1.JPG
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.patriziaduhr
Size
... ... @@ -1,0 +1,1 @@
1 +95.5 KB
Content
guide2.JPG
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.patriziaduhr
Size
... ... @@ -1,0 +1,1 @@
1 +16.3 KB
Content
guide21.JPG
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.patriziaduhr
Size
... ... @@ -1,0 +1,1 @@
1 +17.0 KB
Content
guide4.JPG
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.patriziaduhr
Size
... ... @@ -1,0 +1,1 @@
1 +13.9 KB
Content
guide5.JPG
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.patriziaduhr
Size
... ... @@ -1,0 +1,1 @@
1 +173.9 KB
Content
guideDev.JPG
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.patriziaduhr
Size
... ... @@ -1,0 +1,1 @@
1 +16.3 KB
Content