Attention: The EBRAINS drive will be unavailable for most of the weekend starting the 25th October. Although the Lab is availble while the Drive is down, files that are stored in the Drive will not be loaded and you will be unable to save documents directly on the Lab.


Version 14.1 by jan on 2022/03/23 12:16
Hide last authors
jan 1.1 1 (% class="wikigeneratedid" %)
jan 14.1 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]].~*~****
jan 5.2 3
4
5 (% class="wikigeneratedid" %)
jan 1.1 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:
7
jan 2.2 8 == How to enter software metadata manually ==
jan 1.1 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.
jan 2.2 11
jan 5.2 12 After you are logged in, you are probably prompted to choose a space in a view like below:
jan 2.2 13
jan 5.2 14 [[image:image-20220323113258-3.png||height="386" width="681"]]
15
jan 13.2 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.
jan 5.2 17
jan 7.2 18 After that, you see the view below. now click on the little magnifyer glass symbol at the top.
jan 5.3 19
jan 9.2 20 [[image:image-20220323120123-6.png||height="412" width="1032"]]
jan 5.3 21
jan 13.2 22 After that, you see this list on the left side:
jan 5.3 23
jan 13.2 24 [[image:image-20220323121426-1.png||height="202" width="258"]]
jan 5.3 25
jan 9.2 26
jan 11.2 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:
jan 9.2 28
jan 13.2 29 [[image:image-20220323120955-9.png||height="802" width="712"]]
jan 9.2 30
jan 11.2 31
jan 12.2 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.
jan 11.2 33
jan 12.2 34 After you have entered the software, **do not forget to save your changes!**
35
jan 14.1 36 [[image:image-20220323121238-10.png||height="170" width="382"]]
jan 12.2 37
38
39 That's it. When you are done, just contact the curators via your ticket.
40
jan 2.2 41 == How to upload software metadata programmatically ==
42
jan 5.2 43 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]].
44
45
46 ==== Authorizing for API usage. ====
47
48 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.
49
50 [[image:image-20220323111341-2.png]]