Skip to content

Commit d0e2788

Browse files
committed
Update README installation instructions
1 parent e6ab7df commit d0e2788

1 file changed

Lines changed: 19 additions & 8 deletions

File tree

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,36 @@ Index [BIDS](https://bids-specification.readthedocs.io/en/stable/) datasets fast
1010

1111
## Installation
1212

13-
To install the latest release from pypi, you can run
13+
Install the core package using `pip`:
1414

1515
```sh
1616
pip install bids2table
1717
```
1818

19-
To install with cloud support, include the `cloud` extra
19+
### Variants
20+
21+
Depending on your use case, you may need extra dependencies. Choose the option that
22+
matches your use case:
23+
24+
| If you want to... | Run this command |
25+
| - | - |
26+
| Add cloud storage support (S3, GCS) | `pip install bids2table[cloud]` |
27+
| Enable `pybids` compatibility | `pip install bids2table[pybids]` |
28+
| Install everything | `pip install bids2table[cloud,pybids]` |
2029

21-
```sh
22-
pip install bids2table[cloud]
23-
```
2430

2531
> [!WARNING]
26-
> Previous version only supported s3 cloud storage. `s3` dependency group installation is still supported, but will be deprecated in the next version. Please update any installation scripts to use the `cloud` dependency group.
32+
> *Deprecation Warning:* Previous versions used `bids2table[s3]` for cloud support.
33+
> While the `s3` extra still works for now, it will be removed in the next major
34+
> release. Please update your installation scripts to use `[cloud]`.
35+
36+
### Development Version
2737

28-
The latest development version can be installed with
38+
To test out the absolute latest features directly from the main branch, install
39+
directly from GitHub:
2940

3041
```sh
31-
pip install "bids2table[cloud] @ git+https://github.com/childmindresearch/bids2table.git"
42+
pip install "bids2table[cloud,pybids] @ git+https://github.com/childmindresearch/bids2table.git"
3243
```
3344

3445
## Usage

0 commit comments

Comments
 (0)