Changes for page data-curation-copy
Last modified by eapapp on 2023/07/04 16:46
From version 194.2
edited by adavison
on 2023/06/14 14:59
on 2023/06/14 14:59
Change comment:
There is no comment for this version
To version 198.1
edited by spieschnik
on 2023/06/20 12:44
on 2023/06/20 12:44
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
-
Attachments (0 modified, 1 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. adavison1 +XWiki.spieschnik - Content
-
... ... @@ -211,8 +211,6 @@ 211 211 === Step by Step - Models === 212 212 213 213 214 - 215 - 216 216 ==== 1. Start early ==== 217 217 218 218 It is not necessary to wait until you are ready to publish to register your model with EBRAINS. ... ... @@ -232,14 +232,70 @@ 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 233 +==== 3. Upload code ==== 235 235 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. 236 236 238 +Alternatively, you can upload code to the Collab Drive or Bucket storage. 237 237 238 - ~1.Request curation usingthe[[Curation request form>>https://nettskjema.no/a/277393#/]]. You will be contactedbyacurator with more information.240 +==== 4.Submit metadata ==== 239 239 242 +We recommend submitting metadata using the Model Catalog app, installed in your collab. 240 240 241 - //Additionalinformation willbe added soon.//244 +To install it: 242 242 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 + 243 243 ---- 244 244 245 245 === Step by Step - Software === ... ... @@ -351,22 +351,15 @@ 351 351 Phd Student 352 352 Sensors and Cognitive Psychology (M. Sc.)(%%) 353 353 (% class="small" style="--darkreader-inline-color:#d3cbbf; color:#4a5568" %)**Human-Computer Interaction** 354 -)))|(% style="width:3 28px" %)(((355 - 408 +)))|(% style="width:303px" %)((( 409 +[[image:Lyuba.jpg||height="209" width="167"]] 356 356 357 - 358 - 359 - 360 - 361 - 362 - 363 - 364 364 **Lyuba Zehl** 365 365 366 366 (% class="small" %)Knowledge Systems Engineer 367 367 Dr. rer. nat. (Systems Neuroscience)(%%) 368 368 (% class="small" style="--darkreader-inline-color:#d3cbbf; color:#4a5568" %)**Standard development, data & knowledge management, interdisciplinary communication, data analysis** 369 -)))|(% style="width:3 21px" %) |(% style="width:324px" %)416 +)))|(% style="width:303px" %) |(% style="width:303px" %) 370 370 371 371 ---- 372 372
- Lyuba.jpg
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.spieschnik - Size
-
... ... @@ -1,0 +1,1 @@ 1 +568.2 KB - Content