Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -1,5 +1,61 @@
1		-
	1	+
2	2
	3	+**For any questions or support directly reach out to [[Jan Gründling>>mailto:gruendling@uni-trier.de]].**
	4	+
	5	+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:
	6	+
	7	+== How to enter software metadata manually ==
	8	+
	9	+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).
	10	+
	11	+**Before explaining the editing process, here are some helpful links:**
	12	+
	13	+* 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]]
	14	+* additional information for each attribute: [[Attribute Description>>doc:.EBRAINS Knowledge Graph guide for software curation.Attribute description.WebHome]]
	15	+* a detailed description of the software features: [[Software Features>>doc:.EBRAINS Knowledge Graph guide for software curation.Software Features.WebHome]]
	16	+
	17	+**Editing the software and software version instances:**
	18	+
	19	+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:
	20	+
	21	+[[image:Collabs.swc-guide.EBRAINS Knowledge Graph guide for software curation.WebHome@guide1.JPG]]
	22	+
	23	+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.
	24	+
	25	+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:
	26	+
	27	+[[image:Collabs.swc-guide.EBRAINS Knowledge Graph guide for software curation.WebHome@guideDev.JPG||height="109" width="600"]]
	28	+
	29	+[[image:Collabs.swc-guide.EBRAINS Knowledge Graph guide for software curation.WebHome@guide21.JPG||height="142" width="600"]]
	30	+
	31	+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.
	32	+
	33	+[[image:Collabs.swc-guide.EBRAINS Knowledge Graph guide for software curation.WebHome@guide6.JPG]]
	34	+
	35	+If you are not sure which type to use, please refer to the descriptions linked above or contact the curator.
	36	+
	37	+After you have entered your information on the software, **do not forget to save your changes **(see screenshot below) and contact the curator.
	38	+
	39	+[[image:Collabs.swc-guide.EBRAINS Knowledge Graph guide for software curation.WebHome@guide4.JPG||height="189" width="400"]]
	40	+
	41	+The curators will check the new software instances and move them to the correct space.
	42	+
	43	+=== How to update an existing Software instances ===
	44	+
	45	+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".
	46	+
	47	+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.
	48	+
	49	+== How to upload software metadata programmatically ==
	50	+
	51	+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]].
	52	+
	53	+==== Authorizing for API usage. ====
	54	+
	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	+
	57	+[[image:Collabs.swc-guide.EBRAINS Knowledge Graph guide for software curation.WebHome@image-20220323111341-2.png||height="74" width="186"]]
	58	+
3	3	(% class="col-xs-12 col-sm-4" %)
4	4	(((
5	5	Please read the [[Guide>>doc:.EBRAINS Knowledge Graph guide for software curation.WebHome]].