Wiki source code of EBRAINS Knowledge Graph guide for software curation
Show last authors
author | version | line-number | content |
---|---|---|---|
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]].~*~** | ||
3 | |||
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: | ||
7 | |||
8 | == How to enter software metadata manually == | ||
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. | ||
11 | |||
12 | After you are logged in, you are probably prompted to choose a space in a view like below: | ||
13 | |||
14 | [[image:image-20220323113258-3.png||height="386" width="681"]] | ||
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. | ||
17 | |||
18 | After that, you see the view below. now click on the little magnifyer glass symbol at the top. | ||
19 | |||
20 | [[image:image-20220323120123-6.png||height="412" width="1032"]] | ||
21 | |||
22 | After that, you see on the left side this list: | ||
23 | |||
24 | [[image:image-20220323120352-7.png]] | ||
25 | |||
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 respect | ||
28 | |||
29 | |||
30 | == How to upload software metadata programmatically == | ||
31 | |||
32 | 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]]. | ||
33 | |||
34 | |||
35 | ==== Authorizing for API usage. ==== | ||
36 | |||
37 | 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. | ||
38 | |||
39 | [[image:image-20220323111341-2.png]] |