Changes for page data-curation-copy
Last modified by eapapp on 2023/07/04 16:46
Summary
-
Page properties (2 modified, 0 added, 0 removed)
-
Attachments (0 modified, 2 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki.e apapp1 +XWiki.ingrreit - Content
-
... ... @@ -17,9 +17,9 @@ 17 17 {{/html}} 18 18 19 19 20 -== Publishing neuroscience data, models and software via EBRAINS == 20 +(% class="wikigeneratedid" id="HPublishingneurosciencedata2CmodelsandsoftwareviaEBRAINS" %) 21 +(% style="font-size:2em" %)**Publishing neuroscience data, models and software via EBRAINS** 21 21 22 - 23 23 (% class="wikigeneratedid" %) 24 24 The aim of this collab is to provide you with detailed information about publishing data, simulations, computational models, and software via EBRAINS. If you want a quick overview of the sharing process, see [[https:~~/~~/ebrains.eu/service/share-data>>https://ebrains.eu/service/share-data]]. 25 25 ... ... @@ -83,8 +83,6 @@ 83 83 //to share data on EBRAINS: // 84 84 // // 85 85 [[[[image:image-20230324171114-2.png||height="150" width="106"]]>>https://drive.ebrains.eu/f/dfd374b9b43a458192e9/]] 86 - 87 - 88 88 ))) 89 89 90 90 ... ... @@ -106,10 +106,20 @@ 106 106 107 107 ==== **2. Upload data ** ==== 108 108 107 +(% class="box floatinginfobox" id="share-data-infographic" %) 108 +((( 109 +(% style="text-align:center" %) 110 +//Download our infographic// 111 +//with guidelines 112 +on data organization: // 109 109 114 +(% style="text-align:center" %) 115 +[[[[image:image-20230621121014-1.png||height="150" width="106"]]>>https://drive.ebrains.eu/lib/f5cf4964-f095-49bd-8c34-e4ffda05a497/file/ebrains-infographic-data-organisation.pdf/]] 116 +))) 117 + 110 110 (% style="margin-right:10px" %)[[image:https://lh5.googleusercontent.com/sieKO-kW8O18iPaUyonwyo4UfHBmtc2E9BDnjbx52j6J_uGmm-OzGAo7sloMk3sYwKa6QW3hYQsOA9N4H7uGQpca088Wrk0Nurpt_J3B0-NSbcaPNdZIh21otQcG6jnAxLGiKoEvkTyaDGTMk3fu7me8mQ=s2048||height="94px;" width="94px;"]](%%)**Ensure data is structured consistently prior to upload. ** 111 111 112 -We look for organized data, not organized according to our standard. This is to support the broadest degree of sharing possible. We do however require that the data is organized in a consistent and precise manner. Please see our// //[[ collection ofguidelines on data organization>>https://drive.ebrains.eu/smart-link/25299f04-c4e5-4028-8f5f-3b8208f9a532/]] for further guidance.120 +We look for organized data, not organized according to our standard. This is to support the broadest degree of sharing possible. We do however require that the data is organized in a consistent and precise manner. Please see our// //[[guidelines on data organization>>https://drive.ebrains.eu/smart-link/25299f04-c4e5-4028-8f5f-3b8208f9a532/]] for further guidance. 113 113 114 114 (% style="margin-right:10px" %)[[image:https://lh5.googleusercontent.com/EWtYwfVlbeC-jqPasgmzidqc50GrkKIEgwXeUeql8aaMHIukmFdWEy0nufVWWATbxDDK3XwwZEDmASrbpCsBk1u0HpAd8x4ZgAMsMPRcWyrb9etlV6FgKE_QN2e6SqKxHE0rzkR8uI1rRW_5z21TFGYVnw=s2048||height="91px;" width="91px;"]](%%)**Upload data to EBRAINS Storage, either using a drag-and-drop solution (opt. 1) or an interactive python script (opt. 2).** 115 115 ... ... @@ -157,12 +157,11 @@ 157 157 (% class="box floatinginfobox" id="data-descriptor-infographic" %) 158 158 ((( 159 159 (% style="text-align:center" %) 160 -//Download our infographic : //161 - //The EBRAINS Data//162 -//Descriptor at a glance//168 +//Download our infographic 169 +about the EBRAINS Data// 170 +//Descriptor// 163 163 // // 164 164 [[[[image:image-20230324171109-1.png||height="150" width="106"]]>>https://drive.ebrains.eu/f/c1ccb78be52e4bdba7cf/]] 165 - 166 166 ))) 167 167 168 168 ==== **5. Preview and publish** ==== ... ... @@ -173,49 +173,96 @@ 173 173 Once a Curator has assembled the dataset in the EBRAINS Knowledge Graph, combining the data, metadata and data descriptor, the data provider will receive a private URL for previewing the dataset prior to release. We need an official approval from the data custodian{{footnote}}The Data Custodian is responsible for the content and quality of the Data and metadata, and is the person to be contacted by EBRAINS CS in case of any misconduct related to the Data. It is the obligation of a Data Custodian to keep EBRAINS informed about changes in the contact information of the authors of the Datasets provided by them ([[EBRAINS Data Provision Protocol - version 1.1>>https://strapi-prod.sos-ch-dk-2.exo.io/EBRAINS_Data_Provision_Protocol_dfe0dcb104.pdf]]).{{/footnote}} to release the dataset. Once released, a [[DataCite DOI>>https://datacite.org/]] will be generated for the dataset. If the identical data collection has received a DOI elsewhere, we recommend re-using the already issued DOI. 174 174 175 175 183 + 184 + 176 176 ---- 177 177 178 -=== =====187 +=== Step by Step - Models === 179 179 180 -==== **Sharing human subject data** ==== 181 181 182 -(% class="box floatinginfobox" %) 183 -((( 184 -**Human subject data that can be shared on EBRAINS:** 185 -// // 186 -// - Post-mortem data// 187 -// - Aggregated data// 188 -// - Strongly pseudonymized or de-identified subject data// 189 -// with a legal basis for sharing (e.g. Informed Consent)// 190 -// // 190 +==== 1. Start early ==== 191 191 192 -(% class="small" %) 193 -//If you have human data that does not qualify as any of the above,// 194 -//please [[get in touch>>https://www.ebrains.eu/contact/]] and we will clarify the available options.// 195 -))) 192 +It is not necessary to wait until you are ready to publish to register your model with EBRAINS. 196 196 194 +By registering a model early in your project, you can take advantage of EBRAINS tools 195 +to keep track of simulations and to share them with your collaborators. 197 197 198 - Humansubject data shared on EBRAINS must comply with [[GDPR >>https://gdpr-info.eu/]]and[[EU directives>>https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=celex%3A32010L0063]]. The information weneed toassessthis is collected via our[[Ethicsand Regulatory ComplianceSurvey>>https://nettskjema.no/a/224765]].197 +==== 2. Create/choose a Collab workspace ==== 199 199 200 - Post-mortemandaggregatedhuman datacanbesharedopenly, given direct identifiersinthe metadata areremoved. Stronglypseudonymizedand de-identified data canbe shared via the Human Data Gateway (HDG).199 +We use EBRAINS Collaboratory "collab" workspaces to help manage the model curation process. 201 201 202 - The HumanData Gateway (HDG) wasintroduced in February2021asa responsetothe needs of multiple dataproviderswho are bringinghuman subjectdatatoEBRAINS. HDGcovers the sharing of stronglypseudonymizedorde-identified data,alimitedrangehuman subjectwithout directidentifiersand with very few indirectdentifiers.201 +In particular, we use collab membership (the "Team") to control who can view or edit your model metadata prior to publication. 203 203 204 -The HDG adds an an authentication layer on top of the data. This means that **data users **must request access to the data (via their EBRAINS account) and will receive access provided they actively accept the [[EBRAINS Access Policy>>https://ebrains.eu/terms#access-policy]], the [[EBRAINS General Terms of Use>>https://ebrains.eu/terms#general-terms-of-use]], and the [[EBRAINS Data Use Agreement>>https://ebrains.eu/terms#data-use-agreement]]. The account holder also have to accept that information about their request and access to specific data under HDG is being tracked and stored. **Data owners** must be aware that sharing under the HDG affects the legal responsibilities for the data. They must agree to joint control of the data (see the [[Data Provision Protocol v1>>url:https://strapi-prod.sos-ch-dk-2.exo.io/EBRAINS_Data_Provision_Protocol_dfe0dcb104.pdf]], section 1.4 - 1.5) and the Data Protection Officers of the responsible institutions must have accepted that the data can be shared under HDG. 203 +It is up to you whether you create a new collab for each model, or reuse an existing collab 204 +(it is no problem to have multiple models associated with a single collab). 205 205 206 -The HDG is an extension of the existing services and does not replace the future EBRAINS Service for sensitive data (planned for 2024) which is outside the domain of the current EBRAINS Data and Knowledge services. 206 +Collabs are also useful for storing simulation results, adding documentation for your model, 207 +and/or providing tutorials in Jupyter notebooks. 207 207 209 +==== 3. Upload code ==== 208 208 209 ----- 211 +We recommend storing model code and/or configuration files in an online Git repository, for example on GitHub. 212 +This repository should be public when you publish the model, but a private repository can be used for model development. 210 210 211 - === StepbyStep- Models===214 +Alternatively, you can upload code to the Collab Drive or Bucket storage. 212 212 216 +==== 4.Submit metadata ==== 213 213 214 - ~1.Requestcuration using the[[Curation requestform>>https://nettskjema.no/a/277393#/]].You will be contactedby a curator withmoreinformation.218 +We recommend submitting metadata using the Model Catalog app, installed in your collab. 215 215 220 +To install it: 216 216 217 -//Additional information will be added soon.// 222 +1. click the "+ Create" button 223 +1. in the "Create Page" form, add a title, such as "Model Catalog", and select "Community App", then click "Create" 224 +1. scroll down until you find the "Model Catalog" app, click "Select", then "Save & View" 218 218 226 +You will then see a table of all the models and validation tests associated with this collab. 227 +If this is your first time using the app, the table will probably be empty. 228 +To add your model, click "+", fill in the form, then click "Add model". 229 + 230 +As development of your model proceeds, you can easily register new versions of the code, 231 +and new parameterizations, by clicking "Add new version". 232 + 233 +If you prefer not to use the app, you can instead fill in the [[Curation request form>>https://nettskjema.no/a/277393#/]]., 234 +and you will be contacted by e-mail with further instructions. 235 + 236 +==== 5. Provide a reference dataset ==== 237 + 238 +Once you're ready to publish your model entry in the EBRAINS Knowledge Graph, 239 +we encourage you to provide a dataset containing the simulation results produced by your model, 240 +following the process under "Step by step - Data" above. 241 + 242 +These reference data will be linked to the model, and will be helpful to anyone trying to 243 +reuse your model. 244 + 245 +We will soon introduce a "Reproducible" badge for all models that include a reference dataset, 246 +and whose simulation results can be reproduced by an EBRAINS curator. 247 + 248 +==== 6. Request publication, preview and publish ==== 249 + 250 +Until you request your model entry to be published in the EBRAINS Knowledge Graph, 251 +only members of the collab will be able to view the model entry, in the Model Catalog app 252 +or using the Model Validation Python client. 253 + 254 +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. 255 + 256 +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. 257 + 258 + 259 +Curators will then perform a number of checks: 260 + 261 +1. Does the model description provide sufficient context to understand the purpose and use of the model? 262 +1. Does the code repository contain a licence file, explaining the conditions for reusing the code? 263 +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. 264 + 265 +The curators will also take a snapshot of your model code. 266 + 267 +* 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"]]. 268 +* 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. 269 + 270 +Once this is done, you will be invited to review a preview of how the model entry will appear in the KG Search, 271 +and will have the opportunity to request modifications prior to approval and publication. 272 + 219 219 ---- 220 220 221 221 === Step by Step - Software === ... ... @@ -242,8 +242,43 @@ 242 242 243 243 ---- 244 244 299 +=== Sharing human subject data === 300 + 301 +(% class="box floatinginfobox" %) 302 +((( 303 +**Human subject data that can be shared on EBRAINS:** 304 +// // 305 +// - Post-mortem data// 306 +// - Aggregated data// 307 +// - Strongly pseudonymized or de-identified subject data// 308 +// with a legal basis for sharing (e.g. Informed Consent)// 309 +// // 310 + 311 +(% class="small" %) 312 +//If you have human data that does not qualify as any of the above,// 313 +//please [[get in touch>>https://www.ebrains.eu/contact/]] and we will clarify the available options.// 314 +))) 315 + 316 + 317 +Human subject data shared on EBRAINS must comply with [[GDPR >>https://gdpr-info.eu/]]and [[EU directives>>https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=celex%3A32010L0063]]. The information we need to assess this is collected via our [[Ethics and Regulatory Compliance Survey>>https://nettskjema.no/a/224765]]. 318 + 319 +Post-mortem and aggregated human data can be shared openly, given direct identifiers in the metadata are removed. Strongly pseudonymized and de-identified data can be shared via the Human Data Gateway (HDG). 320 + 321 +The Human Data Gateway (HDG) was introduced in February 2021 as a response to the needs of multiple data providers who are bringing human subject data to EBRAINS. HDG covers the sharing of strongly pseudonymized or de-identified data, a limited range human subject data without direct identifiers and with very few indirect identifiers. 322 + 323 +The HDG adds an an authentication layer on top of the data. This means that **data users **must request access to the data (via their EBRAINS account) and will receive access provided they actively accept the [[EBRAINS Access Policy>>https://ebrains.eu/terms#access-policy]], the [[EBRAINS General Terms of Use>>https://ebrains.eu/terms#general-terms-of-use]], and the [[EBRAINS Data Use Agreement>>https://ebrains.eu/terms#data-use-agreement]]. The account holder also have to accept that information about their request and access to specific data under HDG is being tracked and stored. **Data owners** must be aware that sharing under the HDG affects the legal responsibilities for the data. They must agree to joint control of the data (see the [[Data Provision Protocol v1>>url:https://strapi-prod.sos-ch-dk-2.exo.io/EBRAINS_Data_Provision_Protocol_dfe0dcb104.pdf]], section 1.4 - 1.5) and the Data Protection Officers of the responsible institutions must have accepted that the data can be shared under HDG. 324 + 325 +The HDG is an extension of the existing services and does not replace the future EBRAINS Service for sensitive data (planned for 2024) which is outside the domain of the current EBRAINS Data and Knowledge services. 326 + 327 +---- 328 + 245 245 == **The openMINDS metadata framework** == 246 246 331 +(% class="box floatinginfobox" %) 332 +((( 333 +[[[[image:https://github.com/HumanBrainProject/openMINDS/raw/main/img/light_openMINDS-logo.png||alt="openMINDS logo" height="87" width="164"]]>>https://github.com/HumanBrainProject/openMINDS]] 334 +))) 335 + 247 247 openMINDS (open Metadata Initiative for Neuroscience Data Structures) is a community-driven, open-source metadata framework for graph database systems, such as the EBRAINS Knowledge Graph. It is composed of linked metadata models, libraries of serviceable metadata instances, and supportive tooling ([[openMINDS Python>>url:https://pypi.org/project/openMINDS/]], openMINDS Matlab). For exploring the openMINDS schemas, go to the [[HTML documentation>>url:https://humanbrainproject.github.io/openMINDS/]]. For a full overview of the framework, go to [[the openMINDS collab>>url:https://wiki.ebrains.eu/bin/view/Collabs/openminds/]] or the [[GitHub repository>>https://github.com/HumanBrainProject/openMINDS]]. 248 248 249 249 For feedback, requests, or contributions, please get in touch with the openMINDS development team via ... ... @@ -322,22 +322,15 @@ 322 322 Phd Student 323 323 Sensors and Cognitive Psychology (M. Sc.)(%%) 324 324 (% class="small" style="--darkreader-inline-color:#d3cbbf; color:#4a5568" %)**Human-Computer Interaction** 325 -)))|(% style="width:3 28px" %)(((326 - 414 +)))|(% style="width:303px" %)((( 415 +[[image:Lyuba.jpg||height="209" width="167"]] 327 327 328 - 329 - 330 - 331 - 332 - 333 - 334 - 335 335 **Lyuba Zehl** 336 336 337 337 (% class="small" %)Knowledge Systems Engineer 338 338 Dr. rer. nat. (Systems Neuroscience)(%%) 339 339 (% class="small" style="--darkreader-inline-color:#d3cbbf; color:#4a5568" %)**Standard development, data & knowledge management, interdisciplinary communication, data analysis** 340 -)))|(% style="width:3 21px" %) |(% style="width:324px" %)422 +)))|(% style="width:303px" %) |(% style="width:303px" %) 341 341 342 342 ---- 343 343 ... ... @@ -350,12 +350,16 @@ 350 350 351 351 Below is a list of additional services that data, models or software shared via EBRAINS can benefit from. EBRAINS is continuously looking to increase the number of interoperable services. 352 352 353 -(% cellpadding="15" style="margin-right:auto" %) 354 -|(% colspan="2" %)**Viewer for 2D images**|(% colspan="2" rowspan="1" %)**Viewer for sequential atlas-registered 2D images with annotation options** 355 -|(% style="white-space:nowrap; width:320px" %)[[image:MIO_screenshot.PNG||alt="MIO viewer" height="242" style="float:left" width="300"]]|Integrate image data with //the Mio viewer//: EBRAINS Multi-Image OpenSeadragon viewer provides an intuitive way of navigating high-resolution 2D image series. It has browser-based classic pan and zoom capabilities. A collection can be displayed as a filmstrip (Filmstrip Mode) or as a table (Collection Mode) with adjustable number of row and columns. See [[Mio viewer links available for this dataset>>https://search.kg.ebrains.eu/?category=Dataset&q=nr2f1#9677359c-73fa-4425-b8fa-3de794e9017a]] as an example. MioViewer user manual is found [[here>>https://multi-image-osd.readthedocs.io/en/latest/index.html]].|(% style="white-space:nowrap; width:320px" %)**[[image:LZ_screenshot.PNG||alt="LocaliZoom viewer" height="250" style="float:left" width="300"]]**|Integrate atlas-registered 2D image data with //the LocaliZoom viewer//: The EBRAINS LocaliZoom serial section viewer displays series of registered 2D section images with atlas overlay, allowing the users to zoom into high-resolution images and have information about the brain regions. See the [[LocaliZoom links available for this dataset>>https://doi.org/10.25493/T686-7BX]] as an example. LocaliZoom user manual is found [[here>>https://localizoom.readthedocs.io/en/latest/index.html]]. 356 -|(% colspan="2" rowspan="1" %)**Use your research product in an interactive publication**|(% colspan="2" rowspan="1" %)**Interactive 3D atlas viewer with options for data visualization** 357 -|[[image:LivePaper_screenshot.PNG||alt="LivePaper" height="341" style="float:left" width="300"]]|Add your data, models or software to a// Live paper. //Read more about [[Live papers on ebrains.eu>>https://www.ebrains.eu/data/live-papers/live-papers]].|[[image:3Datlas_screenshot.PNG||alt="Siibra explorer" height="204" style="float:left" width="300"]]|Upload your data to //the Siibra//-explorer: The siibra-explorer is used for visualizing volumetric brain data in all the brain atlases provided by EBRAINS (Human, Monkey, Rat and Mouse). The siibra-explorer viewer uses siibra-api to enable navigation of brain region hierarchies, maps in different coordinate spaces, and linked regional data features. Furthermore, it is connected with the siibra toolsuite providing several analytical workflows. To learn more about how to register your data to atlases, read about the [[Atlas services on ebrains.eu>>https://ebrains.eu/services/atlases#Integratedatatoanatlas]]. 358 358 436 +|(% colspan="2" %)**Viewer for 2D images** 437 +|[[image:MIO_screenshot.PNG]]|Integrate image data with //the Mio viewer//: EBRAINS Multi-Image OpenSeadragon viewer provides an intuitive way of navigating high-resolution 2D image series. It has browser-based classic pan and zoom capabilities. A collection can be displayed as a filmstrip (Filmstrip Mode) or as a table (Collection Mode) with adjustable number of row and columns. See [[Mio viewer links available for this dataset>>https://search.kg.ebrains.eu/?category=Dataset&q=nr2f1#9677359c-73fa-4425-b8fa-3de794e9017a]] as an example. MioViewer user manual is found [[here>>https://multi-image-osd.readthedocs.io/en/latest/index.html]]. 438 +|(% colspan="2" %)**Viewer for sequential atlas-registered 2D images with annotation options** 439 +|[[image:LZ_screenshot.PNG]]|Integrate atlas-registered 2D image data with //the LocaliZoom viewer//: The EBRAINS LocaliZoom serial section viewer displays series of registered 2D section images with atlas overlay, allowing the users to zoom into high-resolution images and have information about the brain regions. See the [[LocaliZoom links available for this dataset>>https://doi.org/10.25493/T686-7BX]] as an example. LocaliZoom user manual is found [[here>>https://localizoom.readthedocs.io/en/latest/index.html]]. 440 +|(% colspan="2" %)**Interactive 3D atlas viewer with options for data visualization** 441 +|[[image:3Datlas_screenshot.PNG]]|Upload your data to the //Siibra-explorer//: The siibra-explorer is used for visualizing volumetric brain data in all the brain atlases provided by EBRAINS (Human, Monkey, Rat and Mouse). The siibra-explorer viewer uses siibra-api to enable navigation of brain region hierarchies, maps in different coordinate spaces, and linked regional data features. Furthermore, it is connected with the siibra toolsuite providing several analytical workflows. To learn more about how to register your data to atlases, read about the [[Atlas services on ebrains.eu>>https://ebrains.eu/services/atlases#Integratedatatoanatlas]]. 442 +|(% colspan="2" %)**Use your research product in an interactive publication** 443 +|[[image:LivePaper_screenshot.PNG]]|Add your data, models or software to a// Live paper. //Read more about [[Live papers on ebrains.eu>>https://www.ebrains.eu/data/live-papers/live-papers]]. 444 + 359 359 ---- 360 360 361 361 ==== **Add a tutorial or learning resource ** ====
- Lyuba.jpg
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.spieschnik - Size
-
... ... @@ -1,0 +1,1 @@ 1 +568.2 KB - Content
- image-20230621121014-1.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.ingrreit - Size
-
... ... @@ -1,0 +1,1 @@ 1 +106.5 KB - Content