Skip to content

Commit 7c9554a

Browse files
committed
readme updated: add content of download neuroj via docker
1 parent a97bc80 commit 7c9554a

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,25 @@ NeuroJSON leverages **modern web technologies and scalable NoSQL databases** and
4444
We welcome your datasets!
4545

4646
- NeuroJSON prefers **BIDS-compliant data**
47-
- Convert datasets to JSON using:
48-
- [`neuroj`](https://github.com/NeuroJSON/neuroj)
49-
- [`tutorial video - convert data`](https://neurojson.io/about)
47+
- Convert datasets to JSON using [`NeuroJSON Client(neuroj)`](https://github.com/NeuroJSON/neuroj):
48+
- Install Docker (skip this step if you already have it): [Get Docker](https://docs.docker.com/get-docker/)
49+
- Download neuroj via docker:
50+
```
51+
docker pull openjdata/neuroj:v2025
52+
```
53+
- Example (convert a single dataset to JSON via neuroj):
54+
```
55+
docker run openjdata/neuroj:v2025 neuroj -i /path/to/database/rootfolder -o /path/to/output/json/folder -db openneuro -ds ds000001 --convert
56+
```
57+
- See the full list of available [NeuroJSON Client commands](https://hub.docker.com/r/openjdata/neuroj)
58+
- Watch our [`tutorial video - convert data`](https://neurojson.io/about)
5059
5160
### Steps to contribute
5261
53-
1. Convert your dataset to JSON
54-
2. Validate metadata
55-
3. [Open a ticket](https://github.com/NeuroJSON/registry) to upload your dataset
62+
1. Download NeuroJSON Client (neuroj)
63+
2. Convert your dataset to JSON
64+
3. Validate metadata
65+
4. [Open a ticket](https://github.com/NeuroJSON/registry) to upload your dataset
5666
5767
Contributions ensure **long-term public availability and reusability**.
5868

0 commit comments

Comments
 (0)