Changes for page data-curation-copy

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

From version 195.1
edited by adavison
on 2023/06/14 15:35
Change comment: There is no comment for this version
To version 194.2
edited by adavison
on 2023/06/14 14:59
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -232,71 +232,14 @@
232 232  Collabs are also useful for storing simulation results, adding documentation for your model,
233 233  and/or providing tutorials in Jupyter notebooks.
234 234  
235 -==== 3. Upload code ====
236 236  
237 -We recommend storing model code and/or configuration files in an online Git repository, for example on GitHub.
238 -This repository should be public when you publish the model, but a private repository can be used for model development.
239 239  
240 -Alternatively, you can upload code to the Collab Drive or Bucket storage.
241 241  
242 -==== 4.Submit metadata ====
238 +~1. Request curation using the [[Curation request form>>https://nettskjema.no/a/277393#/]]. You will be contacted by a curator with more information.
243 243  
244 -We recommend submitting metadata using the Model Catalog app, installed in your collab.
245 245  
246 -To install it:
241 +//Additional information will be added soon.//
247 247  
248 -1. click the "+ Create" button
249 -1. in the "Create Page" form, add a title, such as "Model Catalog", and select "Community App", then click "Create"
250 -1. scroll down until you find the "Model Catalog" app, click "Select", then "Save & View"
251 -
252 -You will then see a table of all the models and validation tests associated with this collab.
253 -If this is your first time using the app, the table will probably be empty.
254 -To add your model, click "+", fill in the form, then click "Add model".
255 -
256 -As development of your model proceeds, you can easily register new versions of the code,
257 -and new parameterizations by clicking "Add new version".
258 -
259 -If you prefer not to use the app, you can instead fill in the [[Curation request form>>https://nettskjema.no/a/277393#/]].,
260 -and you will be contacted by e-mail with further instructions.
261 -
262 -====
263 -5. Provide a reference dataset ====
264 -
265 -Once you're ready to publish your model entry in the EBRAINS Knowledge Graph,
266 -we encourage you to provide a dataset containing the simulation results produced by your model,
267 -following the process under "Step by step - Data" above.
268 -
269 -These reference data will be linked to the model, and will be helpful to anyone trying to
270 -reuse your model.
271 -
272 -We will soon introduce a "Reproducible" badge for all models that include a reference dataset,
273 -and whose simulation results can be reproduced by an EBRAINS curator.
274 -
275 -==== 6. Request publication, preview and publish ====
276 -
277 -Until you request your model entry to be published in the EBRAINS Knowledge Graph,
278 -only members of the collab will be able to view the model entry, in the Model Catalog app
279 -or using the Model Validation Python client.
280 -
281 -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.
282 -
283 -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.
284 -
285 -
286 -Curators will then perform a number of checks:
287 -
288 -1. Does the model description provide sufficient context to understand the purpose and use of the model?
289 -1. Does the code repository contain a licence file, explaining the conditions for reusing the code?
290 -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.
291 -
292 -The curators will also take a snapshot of your model code.
293 -
294 -* For models in public Git repositories, we archive a copy of the repository in Software Heritage.
295 -* 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.
296 -
297 -Once this is done, you will be invited to review a preview of how the model entry will appear in the KG Search,
298 -and will have the opportunity to request modifications prior to approval and publication.
299 -
300 300  ----
301 301  
302 302  === Step by Step - Software ===