forked from openMetadataInitiative/bids2openminds
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updating toml (openMetadataInitiative#65)
* toml * updating readme * typo * readme
- Loading branch information
Showing
3 changed files
with
36 additions
and
4 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
Peyman Najafi | ||
Andrew P. Davison | ||
Lyuba Zehl | ||
Sophia Pieschnik |
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 |
---|---|---|
@@ -1,10 +1,37 @@ | ||
# bids2openminds | ||
A tool to generate openMINDS metadata from BIDS datasets | ||
|
||
In active development, not yet released. More information coming soon! | ||
In active development, please try the first alpha release and send us feedback by creating an issue. | ||
|
||
## Installation | ||
|
||
``` | ||
pip install bids2openminds | ||
``` | ||
|
||
## Usage | ||
|
||
``` | ||
Usage: bids2openminds [OPTIONS] INPUT_PATH | ||
Options: | ||
-o, --output-path PATH The output path or filename for OpenMINDS | ||
file/files. | ||
--single-file Save the entire collection into a single | ||
file (default). | ||
--multiple-files Each node is saved into a separate file | ||
within the specified directory. 'output- | ||
path' if specified, must be a directory. | ||
-e, --include-empty-properties Whether to include empty properties in the | ||
final file. | ||
-q, --quiet Not generate the final report and no | ||
warning. | ||
--help Show this message and exit. | ||
``` | ||
|
||
## For developers | ||
|
||
To run tests: | ||
|
||
``` | ||
$ pytest | ||
``` |
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 |
---|---|---|
@@ -1,9 +1,9 @@ | ||
[project] | ||
name = "bids2openminds" | ||
version = "0.0.0" | ||
version = "0.1.0" | ||
dependencies = [ | ||
"bids", | ||
"openminds >= 0.2.2", | ||
"openminds >= 0.2.3", | ||
"click>=8.1", | ||
"pandas", | ||
"nameparser >= 1.1.3" | ||
|
@@ -12,6 +12,7 @@ requires-python = ">=3.9" | |
authors = [ | ||
{name = "Peyman Najafi", email = "[email protected]"}, | ||
{name = "Andrew P. Davison", email = "[email protected]"}, | ||
{name = "Lyuba Zehl", email = "[email protected]"} | ||
] | ||
description = "Generates openMINDS metadata from a BIDS dataset" | ||
readme = "README.md" | ||
|