Warning: The EBRAINS Drive and EBRAINS Lab will down on Tuesday, the 8th of July 2025 starting from 5pm CEST (my timezone) for up to 1 hour.


Last modified by adavison on 2024/11/13 11:30

From version 19.6
edited by jan
on 2022/03/24 11:50
Change comment: There is no comment for this version
To version 12.1
edited by jan
on 2022/03/23 12:12
Change comment: Uploaded new attachment "image-20220323121238-10.png", version {1}

Summary

Details

Page properties
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 +~*~*~* 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]].~*~**
3 3  
4 4  
5 5  (% class="wikigeneratedid" %)
... ... @@ -7,21 +7,30 @@
7 7  
8 8  == How to enter software metadata manually ==
9 9  
10 -You need to enter or update information at two locations, these are linked below. Fields marked with an asterisk (*) are required. When you are done, just contact the curators by answering to your ticket email.
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.
11 11  
12 -After you have entered and information on the software, **do not forget to save your changes!**
12 +After you are logged in, you are probably prompted to choose a space in a view like below:
13 13  
14 -**-> **[[image:image-20220323121238-10.png||height="170" width="382"]]
14 +[[image:image-20220323113258-3.png||height="386" width="681"]]
15 15  
16 -[[https:~~/~~/editor.kg.ebrains.eu/instances/69849848-68a0-4731-bfc9-8ada6bdee638>>https://editor.kg.ebrains.eu/instances/69849848-68a0-4731-bfc9-8ada6bdee638]]
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.
17 17  
18 -[[https:~~/~~/editor.kg.ebrains.eu/instances/e591283c-6811-4d13-ab89-a561d6861f31>>https://editor.kg.ebrains.eu/instances/e591283c-6811-4d13-ab89-a561d6861f31]]
18 +After that, you see the view below. now click on the little magnifyer glass symbol at the top.
19 19  
20 -(% 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". After clicking the links above, you will see an instance editor view like below:
20 +[[image:image-20220323120123-6.png||height="412" width="1032"]]
21 21  
22 -[[image:image-20220323152326-1.png||height="1062" width="1023"]]
22 +After that, you see on the left side this list:
23 23  
24 +[[image:image-20220323120352-7.png]]
24 24  
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 a view like below:
28 +
29 +[[image:image-20220323120955-9.png]]
30 +
31 +
32 +Now you can start entering the information on your data!
33 +
25 25  == How to upload software metadata programmatically ==
26 26  
27 27  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]].
... ... @@ -31,4 +31,4 @@
31 31  
32 32  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.
33 33  
34 -[[image:image-20220323111341-2.png||height="74" width="186"]]
43 +[[image:image-20220323111341-2.png]]
image-20220323121426-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.jan
Size
... ... @@ -1,1 +1,0 @@
1 -8.1 KB
Content
image-20220323152326-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.jan
Size
... ... @@ -1,1 +1,0 @@
1 -70.9 KB
Content