Skip to content

Commit 8b4310c

Browse files
committed
Merge branch 'main' into ancpBIDS
* main: Update codemeta.json for 0.2.0 release Release 0.2.0
2 parents d2ad821 + 56aa083 commit 8b4310c

9 files changed

Lines changed: 52 additions & 19 deletions

File tree

CHANGES.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
Changelog
2+
=========
3+
4+
0.2.0 (2026-05-07)
5+
------------------
6+
7+
- Update to openMINDS v4
8+
- Add content-type metadata to file objects
9+
- Improved conversion report: now lists detected behavioral protocols and tasks
10+
11+
0.1.1 (2025-06-05)
12+
------------------
13+
14+
- Pin to openMINDS v3 for stability
15+
- Fix compatibility with updated BIDS example datasets
16+
- Add Read the Docs documentation
17+
- Add project logo
18+
19+
0.1.0 (2024-06-21)
20+
------------------
21+
22+
Initial release. Features include:
23+
24+
- Convert BIDS datasets to openMINDS metadata collections (JSON-LD)
25+
- CLI interface (``bids2openminds`` command)
26+
- Support for subjects, authors/persons, file repositories, behavioral protocols, and dataset versions
27+
- NIfTI version detection and content-type mapping
28+
- Subject age validation and anomaly checking
29+
- Conversion summary report
30+
- Test suite using BIDS example datasets
31+
- Cross-platform CI (Linux, Windows, macOS)

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
# bids2openminds
1010
A tool to generate openMINDS metadata from BIDS datasets
1111

12-
In active development, please try the first alpha release and send us feedback by creating an issue.
12+
In active development, please send us feedback by creating an issue.
1313

1414
## Installation
1515

@@ -23,7 +23,7 @@ pip install bids2openminds
2323
Usage: bids2openminds [OPTIONS] INPUT_PATH
2424
2525
Options:
26-
-o, --output-path PATH The output path or filename for OpenMINDS
26+
-o, --output-path PATH The output path or filename for openMINDS
2727
file/files.
2828
--single-file Save the entire collection into a single
2929
file (default).

bids2openminds/converter.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ def convert(input_path, save_output=False, output_path=None, multiple_files=Fal
122122

123123
@click.command()
124124
@click.argument("input-path", type=click.Path(file_okay=False, exists=True))
125-
@click.option("-o", "--output-path", default=None, type=click.Path(file_okay=True, writable=True), help="The output path or filename for OpenMINDS file/files.")
125+
@click.option("-o", "--output-path", default=None, type=click.Path(file_okay=True, writable=True), help="The output path or filename for openMINDS file/files.")
126126
@click.option("--single-file", "multiple_files", flag_value=False, default=False, help="Save the entire collection into a single file (default).")
127127
@click.option("--multiple-files", "multiple_files", flag_value=True, help="Each node is saved into a separate file within the specified directory. 'output-path' if specified, must be a directory.")
128128
@click.option("-e", "--include-empty-properties", is_flag=True, default=False, help="Whether to include empty properties in the final file.")

codemeta.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@
3333
"codeRepository": "https://github.com/openMetadataInitiative/bids2openminds",
3434
"contIntegration": "https://github.com/openMetadataInitiative/bids2openminds/actions",
3535
"dateCreated": "2024-02-02",
36-
"dateModified": "2025-06-05",
36+
"dateModified": "2026-05-07",
3737
"datePublished": "2024-06-21",
3838
"description": "A tool to generate openMINDS metadata from BIDS datasets",
3939
"developmentStatus": "active",
40-
"downloadUrl": "https://files.pythonhosted.org/packages/28/7b/eeedbb1d40eb92dd87d9cd566f2301d31f2cf69a2a96c8f37f150af8a83c/bids2openminds-0.1.1.tar.gz",
40+
"downloadUrl": "https://files.pythonhosted.org/packages/bd/54/a5edea82cf22de4d956b4992cd837f4db7220fd44533eb59e36c7b4bc867/bids2openminds-0.2.0.tar.gz",
4141
"funder": {
4242
"@type": "Organization",
4343
"name": "European Commission"
@@ -61,5 +61,5 @@
6161
"https://pypi.org/project/click/",
6262
"https://pypi.org/project/nameparser/"
6363
],
64-
"version": "0.1.1"
64+
"version": "0.2.0"
6565
}

docs/source/changelog.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../CHANGES.rst

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
project = 'bids2openminds'
1010
copyright = '2024, open Metadata Initiative'
1111
author = 'Peyman Najafi'
12-
release = '0.01'
12+
release = '0.2.0'
1313

1414
# -- General configuration ---------------------------------------------------
1515
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/source/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,12 @@ bids2openminds documentation
99
A tool to generate `openMINDS metadata <https://openminds-documentation.readthedocs.io/en/latest/>`_ from `BIDS datasets <https://bids.neuroimaging.io/>`_
1010

1111
.. note::
12-
This project is under active development, please try the first alpha release and send us feedback by creating an issue.
12+
This project is under active development, please send us feedback by creating an issue.
1313

1414

15-
We are curentlly supporting linux, windows and mac os.
15+
We are currently supporting Linux, Windows and Mac OS.
1616

1717
.. toctree::
1818
installation
1919
usage
20+
changelog

docs/source/usage.rst

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
Usage
22
=====
33

4-
You can use bids2openminds as both a command line tool and a python library.
4+
You can use bids2openminds as both a command line tool and a Python library.
55

66
Usage as Python library
77
=======================
88

99
Overview
1010
########
11-
The ``convert`` function processes a Brain Imaging Data Structure (BIDS) directory, converts its contents into OpenMINDS format, and optionally saves the output. It handles BIDS layout, extracts relevant information, and creates a dataset description based on BIDS data using OpenMINDS templates.
11+
The ``convert`` function processes a Brain Imaging Data Structure (BIDS) directory, converts its contents into openMINDS format, and optionally saves the output. It handles BIDS layout, extracts relevant information, and creates a dataset description based on BIDS data using openMINDS templates.
1212

1313

1414
Function Signature
@@ -18,15 +18,15 @@ Function Signature
1818
Parameters
1919
##########
2020
- ``input_path`` (str): Path to the BIDS directory. This is required and must be a valid directory.
21-
- ``save_output`` (bool, default=False): If True, the converted OpenMINDS data will be saved to the specified output_path.
22-
- ``output_path`` (str, default=None): The path where the OpenMINDS data should be saved. If not specified, defaults to [``input_path``]/openminds.jsonld (single file mode) or [``input_path``]/openminds/ (multiple files mode).
23-
- ``multiple_files`` (bool, default=False): If True, the OpenMINDS data will be saved into multiple files within the specified output_path.
21+
- ``save_output`` (bool, default=False): If True, the converted openMINDS data will be saved to the specified output_path.
22+
- ``output_path`` (str, default=None): The path where the openMINDS data should be saved. If not specified, defaults to [``input_path``]/openminds.jsonld (single file mode) or [``input_path``]/openminds/ (multiple files mode).
23+
- ``multiple_files`` (bool, default=False): If True, the openMINDS data will be saved into multiple files within the specified output_path.
2424
- ``include_empty_properties`` (bool, default=False): If True, includes all the openMINDS properties with empty values in the final output. Otherwise includes only properties that have a non `None` value.
2525
- ``quiet`` (bool, default=False): If True, suppresses warnings and the final report output. Only prints success messages.
2626

2727
Returns
2828
#######
29-
- ``collection`` (openminds.Collection): The OpenMINDS collection object representing the converted dataset. For more information on OpenMINDS collection please refer to `openMINDS readthedocs <https://openminds-documentation.readthedocs.io/en/latest/shared/getting_started/openMINDS_collections.html>`_.
29+
- ``collection`` (openminds.Collection): The openMINDS collection object representing the converted dataset. For more information on openMINDS collection please refer to `openMINDS readthedocs <https://openminds-documentation.readthedocs.io/en/latest/shared/getting_started/openMINDS_collections.html>`_.
3030

3131
Example Usage
3232
#############
@@ -52,10 +52,9 @@ This function is also accessible via a command-line interface using the `click`
5252
input-path Path to the BIDS directory.
5353
5454
Options:
55-
-o, --output-path PATH The output path or filename for OpenMINDS file/files.
55+
-o, --output-path PATH The output path or filename for openMINDS file/files.
5656
--single-file Save the entire collection into a single file (default).
5757
--multiple-files Save each node into a separate file within the specified directory.
5858
-e, --include-empty-properties
5959
Include empty properties in the final file.
6060
-q, --quiet Suppress warnings and reports.
61-

pyproject.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "bids2openminds"
3-
version = "0.1.1"
3+
version = "0.2.0"
44
dependencies = [
55
"ancpbids",
66
"openminds >= 0.2.3",
@@ -16,7 +16,8 @@ authors = [
1616
]
1717
description = "Generates openMINDS metadata from a BIDS dataset"
1818
readme = "README.md"
19-
license = {file = "LICENSE"}
19+
license = "MIT"
20+
license-files = ["LICENSE"]
2021
classifiers = [
2122
"Development Status :: 3 - Alpha",
2223
"Programming Language :: Python"

0 commit comments

Comments
 (0)