Attention: Jupyter services at the JSC site are currently unreachable. When using the Collaboratory Lab, users are advised to select the Cineca execution site instead. We apologize for the inconvenience and are working to resolve the issue as quickly as possible.


Changes for page Data Curation

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

Data Curation