-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add first draft roadmap and community.
- Loading branch information
1 parent
1fc2aa5
commit 5e8f693
Showing
5 changed files
with
92 additions
and
90 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# Guiding Principles | ||
|
||
In this document we lay out our vision for | ||
[**NeuroBlueprint**](https://neuroblueprint.neuroinformatics.dev/) | ||
and **datashuttle** in three guiding principles. | ||
|
||
For more detail, please see our blog posts motivating | ||
[NeuroBlueprint](https://neuroinformatics.dev/blog/neuroblueprint.html) | ||
and | ||
[**datashuttle**](https://neuroinformatics.dev/blog/datashuttle.html). | ||
|
||
The three guiding principles in the development of | ||
**NeuroBlueprint** | ||
and **datashuttle** are: | ||
|
||
## 1) Align as best possible with existing community initiatives (BIDS and NWB) | ||
|
||
[BIDS](https://bids.neuroimaging.io/) | ||
and | ||
[NWB](https://www.nwb.org/) | ||
are the gold-standard for standardising systems neuroscience projects. | ||
Alignment with these specifications should always be the final aim for a project. | ||
|
||
The role of **NeuroBlueprint** is a lightweight standard that can be used to get | ||
started, especially during the early phase of a project when you may be very busy. | ||
The guiding rule is that some standardisation is better than no standardisation. | ||
|
||
It is not a rival or replacement for more developed specifications, | ||
but a stepping stone towards full standardisation. | ||
We aim to align with BIDS specification and in future to provide | ||
conversion to NWB through **datashuttle** wherever possible. | ||
|
||
## 2) Strive to be as lightweight as possible | ||
|
||
In keeping with **(1)**, **NeuroBlueprint** aims to keep the specification as lightweight | ||
as possible. There is no point in the standard proliferating in scope such that it becomes | ||
a duplicate of BIDS and NWB. | ||
|
||
In the first version (**datashuttle 0.4, **NeuroBlueprint 0.2), | ||
the goal is to have a simple organisational | ||
system in which different datatypes (ephys, behaviour) can be | ||
automatically found in any project. | ||
|
||
In future versions as we extend the sophisiatication of automated analysis it will | ||
be necessary to standardise additional features (e.g. sync pulse metadata). | ||
These restrictions will always be goal-orientated and cumstomisable | ||
to achieve your research goal. It is hoped as these 'rules' are | ||
accumulated projects become closer and closer to full BIDS standardisation. | ||
|
||
The role of **datashuttle** will be to enforce these rules in a flexible way. | ||
|
||
## 3) Be versioned and modular | ||
|
||
Linked to **(2)**, **NeuroBlueprint** and **datashuttle** will be | ||
properly versioned and modular, allowing them to develop smoothly over time. | ||
The release of a new versions will strive hard to be backwards compatible, | ||
only breaking backwards compatibility infrequently to improve alignment | ||
with existing standards. | ||
|
||
Typically, new versions will only include new | ||
sets of standardisation rules that | ||
you may or may not choose to follow. **datashuttle** will | ||
enforce these in a flexible way and care will be taken to ensure its API | ||
changes as little as possible. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Roadmap | ||
|
||
Here we lay out the roadmap for | ||
[NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev/) | ||
and **datashuttle**. The roadmap is largely determined by needs | ||
of the community and we strongly encourage people to get in | ||
contact to outline their needs and priorities! | ||
|
||
The aim of the first version of **NeuroBlueprint** (v0.2) and **datashuttle** (v0.4) | ||
are to provide a lightweight, standardised framework such that raw data | ||
and derivatives of different data types (e.g. behaviour, electrophysiology) | ||
can be automatically found. | ||
|
||
The next aim will be to support more advanced multimodal analysis, requiring | ||
metadata (e.g. sync pulses). The next version will focus on recommending | ||
a general metadata standard based on those already used in the community, | ||
and specifying specific metadata keys for the aim of automating multimodal analysis. | ||
|
||
Aiming for integration with existing standards, we plan to develop | ||
automated methods for converting raw data files stored in a NeuroBlueprint | ||
project to NWB. We will constantly strive for full alignment with the BIDS | ||
standard and update when possible as BIDS expands into systems neuroscience. |