Wiki source code of EBRAINS Knowledge Graph guide for software curation
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | (% class="wikigeneratedid" %) |
| |
15.1 | 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]].~*~**** |
| |
5.2 | 3 | |
| 4 | |||
| 5 | (% class="wikigeneratedid" %) | ||
| |
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 | |||
| |
2.2 | 8 | == How to enter software metadata manually == |
| |
1.1 | 9 | |
| |
19.6 | 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. |
| |
19.4 | 11 | |
| |
19.6 | 12 | After you have entered and information on the software, **do not forget to save your changes!** |
| |
19.5 | 13 | |
| |
19.6 | 14 | **-> **[[image:image-20220323121238-10.png||height="170" width="382"]] |
| 15 | |||
| |
19.4 | 16 | [[https:~~/~~/editor.kg.ebrains.eu/instances/69849848-68a0-4731-bfc9-8ada6bdee638>>https://editor.kg.ebrains.eu/instances/69849848-68a0-4731-bfc9-8ada6bdee638]] |
| 17 | |||
| 18 | [[https:~~/~~/editor.kg.ebrains.eu/instances/e591283c-6811-4d13-ab89-a561d6861f31>>https://editor.kg.ebrains.eu/instances/e591283c-6811-4d13-ab89-a561d6861f31]] | ||
| 19 | |||
| |
19.6 | 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: |
| |
19.4 | 21 | |
| |
17.1 | 22 | [[image:image-20220323152326-1.png||height="1062" width="1023"]] |
| |
9.2 | 23 | |
| |
11.2 | 24 | |
| |
20.1 | 25 | === How to update an existing Software instances === |
| 26 | |||
| 27 | 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". | ||
| 28 | |||
| 29 | To make updating easier, we have already placed a copy of your last software version 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. | ||
| 30 | |||
| |
2.2 | 31 | == How to upload software metadata programmatically == |
| 32 | |||
| |
5.2 | 33 | 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]]. |
| 34 | |||
| 35 | |||
| 36 | ==== Authorizing for API usage. ==== | ||
| 37 | |||
| 38 | 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. | ||
| 39 | |||
| |
19.6 | 40 | [[image:image-20220323111341-2.png||height="74" width="186"]] |