Changes for page EBRAINS Knowledge Graph guide for software curation
Last modified by adavison on 2024/11/13 11:30
Summary
-
Page properties (2 modified, 0 added, 0 removed)
-
Attachments (0 modified, 0 added, 1 removed)
Details
- Page properties
-
- Parent
-
... ... @@ -1,1 +1,1 @@ 1 -Collabs. elephant-viziphant-curation.WebHome1 +Collabs.sw-curation-nest-desktop.WebHome - 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,25 +7,37 @@ 7 7 8 8 == How to enter software metadata manually == 9 9 10 - Youneedtoenteror updateinformationattwo locations,these arelinkedbelow.Fieldsmarkedwithanasterisk(*) arerequired.Whenyouareone,just contact thecuratorsbyansweringtoyourticketemail.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 enteredandinformationonthesoftware, **donotforgettosaveyourchanges!**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 - 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 - (% id="cke_bm_36775S" style="display:none" %) (%%)Toregisteryour software, youwill needto input information for the instance"Software"and for "Softwareversion". Afterclickingthe linksabove,you willseeaninstanceeditor view like below:18 +After that, you see the view below. now click on the little magnifyer glass symbol at the top. 19 19 20 -[[image:image-202203231 52326-1.png||height="1062" width="1023"]]20 +[[image:image-20220323120123-6.png||height="412" width="1032"]] 21 21 22 +After that, you see this list on the left side: 22 22 23 - === How to updatexistingSoftwareinstances===24 +[[image:image-20220323121426-1.png||height="202" width="258"]] 24 24 25 -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". 26 26 27 -To make updatingeasier,wehave alreadyplaceda copyofyourlastntheKGspacethatbelongsto this collab.You can usethatcopy andjust change thefieldshatrequire changes.Again-ifyou madeallchangesthatyou considernecessary,letthecuratorknowvia theticketassignedwith this case.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 28 29 +[[image:image-20220323120955-9.png||height="802" width="712"]] 30 + 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 + 29 29 == How to upload software metadata programmatically == 30 30 31 31 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]]. ... ... @@ -35,4 +35,4 @@ 35 35 36 36 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. 37 37 38 -[[image:image-20220323111341-2.png ||height="74" width="186"]]50 +[[image:image-20220323111341-2.png]]
- image-20220323152326-1.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.jan - Size
-
... ... @@ -1,1 +1,0 @@ 1 -70.9 KB - Content