Skip to content

Commit 5703789

Browse files
committed
Updated ReadMe with docker usage
1 parent 1c6967f commit 5703789

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

contributors.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ some icons needs to be added or your name is not listed, please add it.
66
Murat Bilgel 💻 🐛 💡
77
Anthony Galassi 💻 📖 💬 🎨 💡 ⚠️
88
Melanie Ganz-Benjaminsen 🔍 💬 🤔 📋
9-
Gabriel Gonzalez-Escamilla 💻 ⚠️ 🐛 👀
9+
Gabriel Gonzalez-Escamilla 💻 ⚠️ 🐛 👀
10+
Rami Hamati 💻 🐛
1011
Gitte Knudsen 💡💵
1112
Granville Matheson 📝 🐛 ✅
1213
Martin Norgaard 💻 💬 🤔 ⚠️ 👀

pypet2bids/README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ make installpoetry buildpackage installpackage
7777
<details>
7878
<summary>Run Directly From Source</summary>
7979

80-
Lastly, if one wishes run pypet2bids directly from the source code in this repository or to help contribute to the python portion of this project or any of the documentation they can do so via the following options:
80+
If one wishes run pypet2bids directly from the source code in this repository or to help contribute to the python portion of this project or any of the documentation they can do so via the following options:
8181

8282
```bash
8383
cd PET2BIDS/pypet2bids
@@ -100,6 +100,25 @@ python dcm2niix4pet.py --help
100100

101101
</details>
102102

103+
<details>
104+
<summary>Run Using Docker</summary>
105+
Lastly, we provide a Docker container that includes dcm2niix and pypet2bids. This can be installed using Docker. To build the docker file run:
106+
107+
```
108+
docker build . -t openneuropet/pet2bids
109+
```
110+
111+
Then mount and run conversions on your input folders like so:
112+
113+
```
114+
docker run --rm -it \
115+
-v /path/to/dicoms:/dicoms:ro \
116+
-v /path/to/outputdir:/out \
117+
openneuropet/pet2bids dcm2niix4pet /dicoms --destination-path /out
118+
```
119+
Please note the latest version of dcm2niix is pulled and installed at the time of building the Docker container.
120+
</details>
121+
103122
**Note:**
104123
*We recommend using dcm2niix v1.0.20220720 or newer; we rely on metadata included in these later releases. It's best to
105124
collect releases from the [rorden lab/dcm2niix/releases](https://github.com/rordenlab/dcm2niix/releases) page. We have

0 commit comments

Comments
 (0)