Skip to content

Commit 50a051e

Browse files
authored
Updating toml (#65)
* toml * updating readme * typo * readme
1 parent c5f7be7 commit 50a051e

3 files changed

Lines changed: 36 additions & 4 deletions

File tree

AUTHORS

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Peyman Najafi
2+
Andrew P. Davison
3+
Lyuba Zehl
4+
Sophia Pieschnik

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,37 @@
11
# bids2openminds
22
A tool to generate openMINDS metadata from BIDS datasets
33

4-
In active development, not yet released. More information coming soon!
4+
In active development, please try the first alpha release and send us feedback by creating an issue.
5+
6+
## Installation
7+
8+
```
9+
pip install bids2openminds
10+
```
11+
12+
## Usage
13+
14+
```
15+
Usage: bids2openminds [OPTIONS] INPUT_PATH
16+
17+
Options:
18+
-o, --output-path PATH The output path or filename for OpenMINDS
19+
file/files.
20+
--single-file Save the entire collection into a single
21+
file (default).
22+
--multiple-files Each node is saved into a separate file
23+
within the specified directory. 'output-
24+
path' if specified, must be a directory.
25+
-e, --include-empty-properties Whether to include empty properties in the
26+
final file.
27+
-q, --quiet Not generate the final report and no
28+
warning.
29+
--help Show this message and exit.
30+
```
531

632
## For developers
733

834
To run tests:
9-
35+
```
1036
$ pytest
37+
```

pyproject.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
[project]
22
name = "bids2openminds"
3-
version = "0.0.0"
3+
version = "0.1.0"
44
dependencies = [
55
"bids",
6-
"openminds >= 0.2.2",
6+
"openminds >= 0.2.3",
77
"click>=8.1",
88
"pandas",
99
"nameparser >= 1.1.3"
@@ -12,6 +12,7 @@ requires-python = ">=3.9"
1212
authors = [
1313
{name = "Peyman Najafi", email = "peyman.najafi@cnrs.fr"},
1414
{name = "Andrew P. Davison", email = "andrew.davison@cnrs.fr"},
15+
{name = "Lyuba Zehl", email = "lyuba.zehl@ebrains.eu"}
1516
]
1617
description = "Generates openMINDS metadata from a BIDS dataset"
1718
readme = "README.md"

0 commit comments

Comments
 (0)