Changes for page data-curation-copy

Last modified by eapapp on 2023/07/04 16:46

From 194.1 to 193.1 From 196.1 to 195.2

From version 195.2

edited by adavison
on 2023/06/14 15:36

Change comment: There is no comment for this version

To version 194.1

edited by ingrreit
on 2023/06/14 09:01

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

@@ -1,1 +1,1 @@
--XWiki.adavison
++XWiki.ingrreit

Content

@@ -211,89 +211,11 @@
  === Step by Step - Models ===
--==== 1. Start early ====
++~1. Request curation using the [[Curation request form>>https://nettskjema.no/a/277393#/]]. You will be contacted by a curator with more information.
--It is not necessary to wait until you are ready to publish to register your model with EBRAINS.
--By registering a model early in your project, you can take advantage of EBRAINS tools
--to keep track of simulations and to share them with your collaborators.
++//Additional information will be added soon.//
--==== 2. Create/choose a Collab workspace ====
--
--We use EBRAINS Collaboratory "collab" workspaces to help manage the model curation process.
--
--In particular, we use collab membership (the "Team") to control who can view or edit your model metadata prior to publication.
--
--It is up to you whether you create a new collab for each model, or reuse an existing collab
--(it is no problem to have multiple models associated with a single collab).
--
--Collabs are also useful for storing simulation results, adding documentation for your model,
--and/or providing tutorials in Jupyter notebooks.
--
--==== 3. Upload code ====
--
--We recommend storing model code and/or configuration files in an online Git repository, for example on GitHub.
--This repository should be public when you publish the model, but a private repository can be used for model development.
--
--Alternatively, you can upload code to the Collab Drive or Bucket storage.
--
--==== 4.Submit metadata ====
--
--We recommend submitting metadata using the Model Catalog app, installed in your collab.
--
--To install it:
--
--1. click the "+ Create" button
--1. in the "Create Page" form, add a title, such as "Model Catalog", and select "Community App", then click "Create"
--1. scroll down until you find the "Model Catalog" app, click "Select", then "Save & View"
--
--You will then see a table of all the models and validation tests associated with this collab.
--If this is your first time using the app, the table will probably be empty.
--To add your model, click "+", fill in the form, then click "Add model".
--
--As development of your model proceeds, you can easily register new versions of the code,
--and new parameterizations by clicking "Add new version".
--
--If you prefer not to use the app, you can instead fill in the [[Curation request form>>https://nettskjema.no/a/277393#/]].,
--and you will be contacted by e-mail with further instructions.
--
--==== 5. Provide a reference dataset ====
--
--Once you're ready to publish your model entry in the EBRAINS Knowledge Graph,
--we encourage you to provide a dataset containing the simulation results produced by your model,
--following the process under "Step by step - Data" above.
--
--These reference data will be linked to the model, and will be helpful to anyone trying to
--reuse your model.
--
--We will soon introduce a "Reproducible" badge for all models that include a reference dataset,
--and whose simulation results can be reproduced by an EBRAINS curator.
--
--==== 6. Request publication, preview and publish ====
--
--Until you request your model entry to be published in the EBRAINS Knowledge Graph,
--only members of the collab will be able to view the model entry, in the Model Catalog app
--or using the Model Validation Python client.
--
--After publication, the model will appear in the [[EBRAINS public search results>>https://search.kg.ebrains.eu/?category=Model||rel="noopener noreferrer" target="_blank"]], and will receive a DOI.
--
--To request publication, [[contact EBRAINS support>>https://ebrains.eu/support||rel="noopener noreferrer" target="_blank"]], providing the collab name and the model name or ID.
--
--
--Curators will then perform a number of checks:
--
--1.  Does the model description provide sufficient context to understand the purpose and use of the model?
--1.  Does the code repository contain a licence file, explaining the conditions for reusing the code?
--1.  Does the model have a clearly defined version identifier (e.g. v1.0). For models in a Git repository, the version identifier should match the name of a tag or release.
--
--The curators will also take a snapshot of your model code.
--
--* For models in public Git repositories, we archive a copy of the repository in Software Heritage.
--* For models in a collab Bucket or Drive, we make a read-only copy of the code in a public container in the EBRAINS repository.
--
--Once this is done, you will be invited to review a preview of how the model entry will appear in the KG Search,
--and will have the opportunity to request modifications prior to approval and publication.
--
  ----
  === Step by Step - Software ===