Changes for page EBRAINS Knowledge Graph guide for software curation
Last modified by adavison on 2024/11/13 11:30
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -7,43 +7,26 @@ 7 7 8 8 == How to enter software metadata manually == 9 9 10 - Tomanuallyinputmetadataofyoursoftwareinto theKG, you use atoolcalled"KG Editor".TheKG Editorcanbe reachedat [[HBP KnowledgeGraphEditor>>url:https://editor.kg.ebrains.eu/]]. Just loginwithyourHBPcredentials.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. 11 11 12 -After you a relogged in,youareprobably promptedtochooseaspaceinaview like below:12 +After you have entered and information on the software, **do not forget to save your changes!** 13 13 14 -[[image:image-2022032311 3258-3.png||height="386" width="681"]]14 +**-> **[[image:image-20220323121238-10.png||height="170" width="382"]] 15 15 16 - From theavailable choices (should notbe too manyinyour case) choosethe one thatcorrespondstothetitleof yoursoftware.Something like## swcuration-{your_software_name} ##shouldpply.16 +[[https:~~/~~/editor.kg.ebrains.eu/instances/69849848-68a0-4731-bfc9-8ada6bdee638>>https://editor.kg.ebrains.eu/instances/69849848-68a0-4731-bfc9-8ada6bdee638]] 17 17 18 - After that, yousee the view below.now clickonthelittle magnifyer glass symbolathep.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 20 - [[image:image-20220323120123-6.png||height="412" width="1032"]]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: 21 21 22 -After that, you see this list on the left side: 23 - 24 -[[image:image-20220323121426-1.png||height="202" width="258"]] 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 respective list entry. We recommed starting with "Software". After clicking the plus icon you will see the software instance editor view like below: 28 - 29 29 [[image:image-20220323152326-1.png||height="1062" width="1023"]] 30 30 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. 33 - 34 -After you have entered the software, **do not forget to save your changes!** 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 -If you have registered a software previously, updating means adding a new instance of type "Software version" a ndlink it to the existing instance of type "Software".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". 45 45 46 -To make t hisprocess 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.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. 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]] 40 +[[image:image-20220323111341-2.png||height="74" width="186"]]