Skip to content

Commit 931a880

Browse files
committed
updated README.md
1 parent 2fd3a9c commit 931a880

1 file changed

Lines changed: 16 additions & 10 deletions

File tree

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,27 +23,33 @@ See the paired integration tutorial for advice on which distributions and losses
2323

2424
## Installation
2525

26-
You need to have Python 3.10 or newer installed on your system. We recommend installing [Mambaforge](https://github.com/conda-forge/miniforge#mambaforge).
26+
You need to have Python 3.12 or newer installed on your system.
2727

28-
To create and activate a new environment:
28+
### Quick start
29+
30+
To install the latest release of `multigrate` from [PyPI][link-pypi]:
2931

3032
```bash
31-
mamba create --name multigrate python=3.10
32-
mamba activate multigrate
33+
pip install multigrate
3334
```
3435

35-
Next, there are several alternative options to install multigrate:
36-
37-
1. Install the latest release of `multigrate` from [PyPI][link-pypi]:
36+
Or install the latest development version:
3837

3938
```bash
40-
pip install multigrate
39+
pip install git+https://github.com/theislab/multigrate.git@main
4140
```
4241

43-
2. Or install the latest development version:
42+
### Development setup
43+
44+
For development, we recommend using [`uv`](https://docs.astral.sh/uv/) for fast dependency management:
4445

4546
```bash
46-
pip install git+https://github.com/theislab/multigrate.git@main
47+
# Clone the repository
48+
git clone https://github.com/theislab/multigrate.git
49+
cd multigrate
50+
51+
# Install in development mode with all optional dependencies
52+
uv sync --all-groups
4753
```
4854

4955
## Release notes

0 commit comments

Comments
 (0)