forked from bids-standard/bids-specification
-
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.
- Loading branch information
Showing
3 changed files
with
22 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# BIDS schema | ||
|
||
The BIDS schema is a machine readable representation of the BIDS standard, | ||
written in a custom YAML format. | ||
The goal of the schema is to provide a single source for rendering the specification | ||
and validating BIDS datasets, reducing the scope for inconsistencies. | ||
Third party tools may also use the schema to write code that will adapt to additions | ||
to the BIDS standard. | ||
|
||
The BIDS schema is available in two machine readable formats: | ||
|
||
- as a set of [YAML](https://en.wikipedia.org/wiki/YAML) files in the [BIDS specification repository](https://github.com/bids-standard/bids-specification/src/schema) | ||
- as a [single dereferenced json file](https://bids-specification.readthedocs.io/en/stable/schema.json) | ||
|
||
A didactic walkthrough of the schema can be found in the [BEP Guide](https://bids-extensions.readthedocs.io/en/latest/schema/), | ||
and a complete description is available in the [`bidsschematools` documentation](https://bidsschematools.readthedocs.io/en/latest/). | ||
[`bidsschematools`](https://pypi.org/project/bidsschematools/) is a Python package sourced | ||
from the specification repository, and includes the necessary code to render the specification | ||
and filename validation. |
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