From 4f5c3f1931e6ad43c1fb5bc104eb7638a9451860 Mon Sep 17 00:00:00 2001 From: Joe Ziminski <55797454+JoeZiminski@users.noreply.github.com> Date: Thu, 30 May 2024 17:40:42 +0100 Subject: [PATCH] Add 'Community' section. (#58) * Add first draft community and roadmap page. * Fix linting. * Add links to community page. * Update docs/source/roadmap.md Co-authored-by: Adam Tyson * Update docs/source/roadmap.md Co-authored-by: Adam Tyson * Add links to metadata decision point. * Add links and restructure community section. * Add link all datashuttle links. * Fix bolding, small tidy ups. * Add SWC link, small fixes. * Add SWC link, small fixes. * Remove datashuttle roadmap / guiding principles links until they are released. * link to github issues Co-authored-by: Niko Sirmpilatze * grammer fix Co-authored-by: Niko Sirmpilatze * Standardise behaviour spelling. --------- Co-authored-by: Adam Tyson Co-authored-by: Niko Sirmpilatze --- docs/source/community.md | 27 +++++++++++++++++++++++++++ docs/source/index.md | 1 + docs/source/roadmap.md | 29 +++++++++++++++++++++++++++++ 3 files changed, 57 insertions(+) create mode 100644 docs/source/community.md create mode 100644 docs/source/roadmap.md diff --git a/docs/source/community.md b/docs/source/community.md new file mode 100644 index 0000000..21a7e0d --- /dev/null +++ b/docs/source/community.md @@ -0,0 +1,27 @@ +# Community + +**NeuroBlueprint** is developed by the +[NeuroInformatics Unit](https://neuroinformatics.dev) +at the +[Sainsbury Wellcome Centre](https://www.sainsburywellcome.org/web/). +We are very interested in feedback on the +specification, please get in contact through our +[GitHub Issues](https://github.com/neuroinformatics-unit/NeuroBlueprint/issues) +or +[Zulip Chat](https://neuroinformatics.zulipchat.com/#narrow/stream/406000-NeuroBlueprint)! + +We are keen to work closely with ongoing standardisation efforts in the +[BIDS](https://bids.neuroimaging.io) +and +[NWB](https://www.nwb.org) +communities. Please see our +[Roadmap](roadmap.md) +for details on our future plans. + +```{toctree} +:maxdepth: 3 +:caption: Contents +:hidden: + +roadmap +``` diff --git a/docs/source/index.md b/docs/source/index.md index 93e1946..ade1ef7 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -29,4 +29,5 @@ and [BIDS community](https://bids.neuroimaging.io/) to extend the BIDS specifica :caption: Contents specification +community ``` diff --git a/docs/source/roadmap.md b/docs/source/roadmap.md new file mode 100644 index 0000000..d856db3 --- /dev/null +++ b/docs/source/roadmap.md @@ -0,0 +1,29 @@ +# Roadmap + +The roadmap for **NeuroBlueprint** +contains our development plans for the specification. + +The roadmap is responsive to the requirements +of the community, and we encourage people to get in +contact to outline their needs and priorities. + +The aim of **NeuroBlueprint** +[v0.2](https://github.com/neuroinformatics-unit/NeuroBlueprint/releases) +was to provide a lightweight specification +enabling automatic discovery of raw data for +different data types (e.g. behaviour, electrophysiology). + +Next, we plan to extend the specification to support automated +multimodal analysis. This will require metadata standardisation, +and we will decide on an existing metadata standard to adopt and a minimal +set of required keywords. + +**Q4 2024** + +- Investigate and adopt a metadata standard (e.g. +[Brain Imaging Data Structure](https://bids-specification.readthedocs.io/en/stable/derivatives/common-data-types.html) +or +[Allen Institute for Neural Dynamics](https://github.com/AllenNeuralDynamics/aind-data-schema)). + +- Add required metadata for automated multimodal behavioural and electrophysiological +analysis to the specification.