Skip to content

Commit ae61666

Browse files
LucaMarconatopre-commit-ci[bot]kevinyamauchi
authored
Update installation.md (#268)
* Update installation.md * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * small logo in readme * Update docs/installation.md --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Kevin Yamauchi <kevin.yamauchi@gmail.com>
1 parent 4325b59 commit ae61666

2 files changed

Lines changed: 11 additions & 1 deletion

File tree

-30 KB
Loading

docs/installation.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,22 @@ pip install "spatialdata[torch]"
3434

3535
## Development version
3636

37-
To install `spatialdata` from GitHub, run::
37+
To install `spatialdata` from GitHub, run:
3838

3939
```bash
4040
pip install git+https://github.com/scverse/spatialdata
4141
```
4242

43+
Alternative you can clone the repository and do an editable install with:
44+
45+
```bash
46+
pip install -e .
47+
```
48+
49+
This is the reccommended way to install the package in case in which you want to contribute to the code. To update the package you can use `git pull`.
50+
51+
Important: if you perform an editable install of `spatialdata` and then install `spatialdata-plot`, `spatialdata-io` or `napari-spatialdata`, they may automatically override the installation of `spatialdata` with the version from PyPI. To check if this happened you can run `python -c "import spatialdata; print(spatialdata.__path__)"`: if you get a path that contains `site-packages`, then your editable installation has been overridden and you need to reinstall the package by rerunning `pip install -e .` in the cloned `spatialdata` repo.
52+
4353
<!-- Links -->
4454

4555
[napari-spatialdata]: https://github.com/scverse/napari-spatialdata

0 commit comments

Comments
 (0)