Changes for page EBRAINS Knowledge Graph guide for software curation
Last modified by adavison on 2024/11/13 11:30
From version 36.1
edited by patriziaduhr
on 2022/11/13 09:36
on 2022/11/13 09:36
Change comment:
Uploaded new attachment "guide5.JPG", version {1}
Summary
-
Page properties (3 modified, 0 added, 0 removed)
-
Attachments (0 modified, 0 added, 6 removed)
Details
- Page properties
-
- Parent
-
... ... @@ -1,1 +1,1 @@ 1 -Collabs. swc-guide.WebHome1 +Collabs.elephant-viziphant-curation.WebHome - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. patriziaduhr1 +XWiki.jan - Content
-
... ... @@ -1,5 +1,5 @@ 1 1 (% class="wikigeneratedid" %) 2 -**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. 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,41 +7,27 @@ 7 7 8 8 == How to enter software metadata manually == 9 9 10 -You will receiveanemail afterthe curatorhas createda spaceforyouin theKnowledgeGraph. This emailcontains a linktoasoftware instanceandaoftwareversion instancein yourSpace.Thesearealreadylinkedtoeachother(bythe attribute"HasVersion"ofthe softwareinstance).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 - **Beforeexplainingtheingprocess, herearesomehelpful links:**12 +[[https:~~/~~/editor.kg.ebrains.eu/instances/23f042c0-0f22-4c2b-95c8-88bbc03bb7c2/edit>>https://editor.kg.ebrains.eu/instances/23f042c0-0f22-4c2b-95c8-88bbc03bb7c2/edit]] 13 13 14 -* A description of the fields of the software and software version instances and values that these fields may take: [[https:~~/~~/humanbrainproject.github.io/openMINDS/v2/core/v3/products/softwareVersion.html>>url:https://humanbrainproject.github.io/openMINDS/v2/core/v3/products/softwareVersion.html]] and [[https:~~/~~/humanbrainproject.github.io/openMINDS/v2/core/v3/products/software.html>>url:https://humanbrainproject.github.io/openMINDS/v2/core/v3/products/software.html]] 15 -* additional information for each attribute: [[https:~~/~~/github.com/bweyers/HBPVisCatalogue/wiki/Attribute-Descriptions>>url:https://github.com/bweyers/HBPVisCatalogue/wiki/Attribute-Descriptions]] 16 -* a detailed description of the software features: [[https:~~/~~/github.com/bweyers/HBPVisCatalogue/wiki/Identified-Software-Features>>url:https://github.com/bweyers/HBPVisCatalogue/wiki/Identified-Software-Features]] 14 +[[https:~~/~~/editor.kg.ebrains.eu/instances/073e647e-0836-4075-b88b-ddeb74cbeea0/edit>>https://editor.kg.ebrains.eu/instances/073e647e-0836-4075-b88b-ddeb74cbeea0/edit]] 17 17 18 - **Editingthe softwareandsoftware versioninstances:**16 +After you have entered and information on the software, **do not forget to save your changes!** 19 19 20 - Toregister your software, you will need to input information for thenstance"Software"and for "Software version". After clicking the links in your email, you will see an instance editor view like below:18 +**-> **[[image:image-20220323121238-10.png||height="170" width="382"]] 21 21 22 -[[image:guide1.JPG]] 23 23 24 - Asyoucanseeinthescreenshotabove,somefieldsaremarkedwithanasterisk (*). Thesearerequired. Keep indthatthisishowyou presentyoursoftwarepublicly topotentialend-usersor otherresearchers.Thereforeit wouldbe niceif asmanyfields as possible arefilledin.21 +(% 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: 25 25 26 - Some fields can beof different types, such as the field "developer" and "Full documentation". In thecase of developer it is possible to enter a person or an organisation. Thepossible types are selectable on the rightabove the respective field, as showninthe following screenshots:23 +[[image:image-20220323152326-1.png||height="1062" width="1023"]] 27 27 28 -[[image:guideDev.JPG||height="109" width="600"]] 29 29 30 -[[image:guide21.JPG||height="142" width="600"]] 31 - 32 -If you are not sure which type to use, please refer to the descriptions linked above or contact the curator. 33 - 34 -After you have entered your information on the software, **do not forget to save your changes **(see screenshot below) and contact the curator. 35 - 36 -[[image:guide4.JPG||height="189" width="400"]] 37 - 38 -The curators will check the new software instances and move them to the correct space. 39 - 40 40 === How to update an existing Software instances === 41 41 42 42 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". 43 43 44 -To make updating easier, we have already placed a copy of your last software version instance in the KG space that wascreated foryou. 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 viaemail orthe ticket assigned with this case.30 +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. 45 45 46 46 == How to upload software metadata programmatically == 47 47
- guide1.JPG
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.patriziaduhr - Size
-
... ... @@ -1,1 +1,0 @@ 1 -95.5 KB - Content
- guide2.JPG
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.patriziaduhr - Size
-
... ... @@ -1,1 +1,0 @@ 1 -16.3 KB - Content
- guide21.JPG
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.patriziaduhr - Size
-
... ... @@ -1,1 +1,0 @@ 1 -17.0 KB - Content
- guide4.JPG
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.patriziaduhr - Size
-
... ... @@ -1,1 +1,0 @@ 1 -13.9 KB - Content
- guide5.JPG
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.patriziaduhr - Size
-
... ... @@ -1,1 +1,0 @@ 1 -174.3 KB - Content
- guideDev.JPG
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.patriziaduhr - Size
-
... ... @@ -1,1 +1,0 @@ 1 -16.3 KB - Content