Last modified by adavison on 2024/11/13 11:30
Hide last authors
adavison 46.1 1 (% class="box warningmessage" %)
2 (((
adavison 47.1 3 The procedure described in this document is out of date, and is retained here only for reference. Please see [[the current version of the software curation guide>>doc:Collabs.swc-guide.WebHome]].
adavison 46.1 4 )))
5
jan 40.1 6 = Contents =
jan 5.2 7
jan 40.1 8 {{toc start="2"/}}
jan 5.2 9
jan 40.1 10 This guide provides a starting point and reference for the process of entering information about your software into the EBRAINS Knowledge Graph (KG).
jan 1.1 11
jan 40.1 12 For an overview of the software curation process, please refer to [[our info graphic>>https://drive.ebrains.eu/lib/f5cf4964-f095-49bd-8c34-e4ffda05a497/file/EBRAINS-Share-Software.pdf]].
13
14 **For any questions or support directly reach out to [[Jan Gründling>>mailto:gruendling@uni-trier.de]].**
15
jan 2.2 16 == How to enter software metadata manually ==
jan 1.1 17
jan 40.1 18 If your software has not been curated before, please fill in the request form [[here>>https://nettskjema.no/a/104328]] before continuing with the following instructions. If your Software has been curated already and you want do add a new version, refer to the section [[How to Update>>https://wiki.ebrains.eu/bin/view/Collabs/swc-guide#HHowtoupdateexistingSoftwareinstances]].
19
patriziaduhr 34.1 20 You will receive an email after the curator has created a space for you in the Knowledge Graph. This email contains a link to a software instance and a software version instance in your Space. These are already linked to each other (by the attribute "Has Version" of the software instance).
jan 19.4 21
patriziaduhr 34.1 22 **Before explaining the editing process, here are some helpful links:**
jan 22.1 23
patriziaduhr 34.1 24 * 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]]
adavison 44.1 25 * Additional information for each attribute: [[Attribute Description>>doc:Collabs.swc-guide.Archive.Attribute description.WebHome]]
adavison 45.1 26 * A detailed description of the software features: [[Software Features>>doc:Collabs.swc-guide.Archive.Software Features.WebHome]]
jan 26.1 27
jan 40.1 28 *
29
patriziaduhr 34.1 30 **Editing the software and software version instances:**
jan 26.1 31
patriziaduhr 34.1 32 To register your software, you will need to input information for the instance "Software" and for  "Software version". After clicking the links in your email, you will see an instance editor view like below:
jan 22.1 33
patriziaduhr 34.1 34 [[image:guide1.JPG]]
jan 24.1 35
patriziaduhr 34.1 36 As you can see in the screenshot above, some fields are marked with an asterisk (*). These are required. Keep in mind that this is how you present your software publicly to potential end-users or other researchers. Therefore it would be nice if as many fields as possible are filled in.
jan 19.5 37
patriziaduhr 34.1 38 Some fields can be of different types, such as the field "developer" and "Full documentation". In the case of developer it is possible to enter a person or an organisation. The possible types are selectable on the right above the respective field, as shown in the following screenshots:
jan 19.6 39
patriziaduhr 34.1 40 [[image:guideDev.JPG||height="109" width="600"]]
41
42 [[image:guide21.JPG||height="142" width="600"]]
43
patriziaduhr 38.1 44 For example, if you want to create a new person, an editing field opens in the right column of the instance editor view as shown in the following screenshot.
45
46 [[image:guide6.JPG]]
47
patriziaduhr 34.1 48 If you are not sure which type to use, please refer to the descriptions linked above or contact the curator.
49
50 After you have entered your information on the software, **do not forget to save your changes **(see screenshot below) and contact the curator.
51
52 [[image:guide4.JPG||height="189" width="400"]]
53
54 The curators will check the new software instances and move them to the correct space.
55
jan 40.3 56 == How to update existing Software instances ==
jan 20.1 57
58 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".
59
jan 40.3 60 **If you want to add a new version to an already curated software, please write to [[curation-support@humanbrainproject.eu>>path:mailto:curation-support@humanbrainproject.eu]] or open a ticket at [[https:~~/~~/support.humanbrainproject.eu/>>url:https://support.humanbrainproject.eu/]]**
61
patriziaduhr 34.1 62 To make updating easier, we have already placed a copy of your last software version instance in the KG space that was created for you. 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 email or the ticket assigned with this case.
jan 20.1 63
jan 2.2 64 == How to upload software metadata programmatically ==
65
jan 5.2 66 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]].
67
68
69 ==== Authorizing for API usage. ====
70
71 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.
72
jan 19.6 73 [[image:image-20220323111341-2.png||height="74" width="186"]]