Skip to content

Commit

Permalink
Merge branch 'master' into admonition
Browse files Browse the repository at this point in the history
  • Loading branch information
sappelhoff authored Mar 11, 2024
2 parents dbcb962 + c9e4779 commit f9e699b
Show file tree
Hide file tree
Showing 9 changed files with 46 additions and 16 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Attribution 4.0 International

Copyright (c) 2018-2022, BIDS Contributors.
Copyright (c) 2018, BIDS Contributors.

=======================================================================

Expand Down
37 changes: 28 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[![Validation](https://github.com/bids-standard/bids-specification/actions/workflows/validation.yml/badge.svg)](https://github.com/bids-standard/bids-specification/actions/workflows/validation.yml)
[![CircleCI](https://circleci.com/gh/bids-standard/bids-specification.svg?style=shield)](https://circleci.com/gh/bids-standard/bids-specification)
[![Mastodon Follow](https://img.shields.io/mastodon/follow/109520103085644521?domain=https%3A%2F%2Ffosstodon.org%2F)](https://fosstodon.org/@bidsstandard)
[![@BIDSstandard](http://img.shields.io/twitter/follow/bidsstandard.svg?style=social)](https://twitter.com/BIDSstandard)
[![@BIDSstandard](https://img.shields.io/twitter/follow/bidsstandard.svg?style=social)](https://x.com/BIDSstandard)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3686061.svg)](https://doi.org/10.5281/zenodo.3686061)

<img src="./BIDS_logo/BIDS_logo_white_transparent_background_crop.png#gh-dark-mode-only" alt="bids-logo" width="600"/>
Expand All @@ -13,7 +13,6 @@ organization of neuroimaging data.
In this repository, we develop the
[BIDS specification](https://bids-specification.readthedocs.io/en/latest/).


# When to use BIDS

To organize your data in BIDS, all you need is neuro data, a computer, and the
Expand Down Expand Up @@ -44,10 +43,7 @@ The specification is provided in the form of a webpage, built using
1. Read some introductory material, most likely the very basic problems have already been addressed!
- [BIDS Starter Kit](https://github.com/bids-standard/bids-starter-kit) for tutorials, wikis, templates, ...
2. Post your question in one of several channels where BIDS members are active
- the [NeuroStars](https://neurostars.org/tags/bids) discourse forum
- the [BrainHack Mattermost](https://mattermost.brainhack.org), for instant messaging (see also this [news item](https://bids.neuroimaging.io/2020/06/24/Join-the-BIDS-community-on-the-BrainHack-Mattermost.html))
- the [Google group](https://groups.google.com/forum/#!forum/bids-discussion), for broader discussions surrounding BIDS
- the [specification repository issue page](https://github.com/bids-standard/bids-specification/issues), if you found inconsistencies, typos, or other issues with the BIDS specification itself
- see: [BIDS communication channels](#bids-communication-channels)

# Contributing to BIDS

Expand All @@ -58,11 +54,34 @@ For a current list of our contributors, please see our [Contributors appendix](h

When you're ready to get started, check out [our contributing guidelines](https://github.com/bids-standard/bids-specification/blob/master/CONTRIBUTING.md).

We ask that all contributions to BIDS across all project-related spaces (including but not limited to:
[GitHub](https://github.com/bids-standard),
the [Google group](https://groups.google.com/forum/#!forum/bids-discussion), and newsletter emails),
We ask that all contributions to BIDS across all project-related spaces
(including but not limited to:
[GitHub](https://github.com/bids-standard), and the
[Google group](https://groups.google.com/forum/#!forum/bids-discussion); see
[BIDS communication channels](#bids-communication-channels))
adhere to our [code of conduct](https://github.com/bids-standard/bids-specification/blob/master/CODE_OF_CONDUCT.md).

# BIDS communication channels

## Main communication channels

- "Issue" pages on the different GitHub repositories of the [`bids-standard` GitHub organization](https://github.com/bids-standard),
such as the [BIDS specification repository](https://github.com/bids-standard/bids-specification/issues),
for reporting problems or making suggestions
- The [NeuroStars Discourse forum](https://neurostars.org/tags/bids), for asking usage questions
- The [BrainHack Mattermost](https://mattermost.brainhack.org), for instant messaging
(see also this [news item](https://bids.neuroimaging.io/2020/06/24/Join-the-BIDS-community-on-the-BrainHack-Mattermost.html))
- The [Google group](https://groups.google.com/forum/#!forum/bids-discussion), for broader discussions and announcements surrounding BIDS
- The [BIDS website "news"](https://bids.neuroimaging.io/news.html), similar to the Google group, for broader discussions and announcements

## Social media channels

- [X](https://x.com/BIDSstandard)
- [Mastodon](https://fosstodon.org/@bidsstandard)
- [Bluesky](https://bsky.app/profile/bidsstandard.bsky.social)
- [Youtube](https://www.youtube.com/channel/UCxZUcYfd_nvIVWAbzRB1tlw)
- [Instagram](https://www.instagram.com/bidsstandard/)

## Contributors

Thanks goes to these wonderful people.
Expand Down
8 changes: 6 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,16 @@ extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/bids-standard/bids-specification/
- icon: fontawesome/brands/twitter
link: https://twitter.com/BIDSstandard/
- icon: fontawesome/brands/x-twitter
link: https://x.com/BIDSstandard/
- icon: fontawesome/brands/mastodon
link: https://fosstodon.org/@bidsstandard
- icon: fontawesome/brands/google
link: https://groups.google.com/g/bids-discussion
- icon: fontawesome/brands/instagram
link: https://www.instagram.com/bidsstandard/
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/channel/UCxZUcYfd_nvIVWAbzRB1tlw

extra_javascript:
- js/jquery-3.6.0.min.js
Expand Down
2 changes: 1 addition & 1 deletion src/modality-specific-files/genetic-descriptor.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Genetic Descriptor

Support genetic descriptors was developed as a
Support for genetic descriptors was developed as a
[BIDS Extension Proposal](../extensions.md#bids-extension-proposals).
Please see [Citing BIDS](../introduction.md#citing-bids)
on how to appropriately credit this extension when referring to it in the
Expand Down
3 changes: 2 additions & 1 deletion src/modality-specific-files/microscopy.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ and a guide for using macros can be found at
https://github.com/bids-standard/bids-specification/blob/master/macros_doc.md
-->
{{ MACROS___make_filename_template("raw", datatypes=["micr"], suffixes=["TEM", "SEM", "uCT", "BF", "DF",
"PC", "DIC", "FLUO", "CONF", "PLI", "CARS", "2PE", "MPE", "SR", "NLO", "OCT", "SPIM"], n_dupes_to_combine=4) }}
"PC", "DIC", "FLUO", "CONF", "PLI", "CARS", "2PE", "MPE", "SR", "NLO", "OCT", "SPIM", "hipCT"], n_dupes_to_combine=4) }}

Microscopy data MUST be stored in the `micr` directory.

Expand Down Expand Up @@ -91,6 +91,7 @@ and a guide for using macros can be found at
"NLO",
"OCT",
"SPIM",
"hipCT",
]
)
}}
Expand Down
2 changes: 1 addition & 1 deletion src/modality-specific-files/near-infrared-spectroscopy.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ and a guide for using macros can be found at
{{ MACROS___make_filename_template(
"raw",
datatypes=["nirs"],
suffixes=["nirs", "events", "physio", "stim"])
suffixes=["nirs", "events", "channels", "optodes", "coordsystem", "physio", "stim"])
}}

Only the *Shared Near Infrared Spectroscopy Format* ([SNIRF](https://github.com/fNIRS/snirf))
Expand Down
2 changes: 1 addition & 1 deletion src/schema/objects/columns.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@ reference_frame:
description: |
Specification of a reference frame in which the motion data are to be interpreted.
The description of the levels in `*_channels.json` SHOULD use `RotationRule`,
`RotationOrder`, and `SpatialAxis`, and MAY use `Description` for the specification.
`RotationOrder`, and `SpatialAxes`, and MAY use `Description` for the specification.
anyOf:
- type: string
- type: string
Expand Down
5 changes: 5 additions & 0 deletions src/schema/objects/suffixes.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -595,6 +595,11 @@ headshape:
description: |
The 3-D locations of points that describe the head shape and/or electrode
locations can be digitized and stored in separate files.
hipCT:
value: hipCT
display_name: HiP-CT
description: |
Hierarchical Phase-Contrast Tomography imaging data
ieeg:
value: ieeg
display_name: Intracranial Electroencephalography
Expand Down
1 change: 1 addition & 0 deletions src/schema/rules/files/raw/micr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ microscopy:
- NLO
- OCT
- SPIM
- hipCT
extensions:
- .ome.tif
- .ome.btf
Expand Down

0 comments on commit f9e699b

Please sign in to comment.