diff --git a/docs/_static/img/spatialdata_horizontal.png b/docs/_static/img/spatialdata_horizontal.png index 0c556440..5683233e 100644 Binary files a/docs/_static/img/spatialdata_horizontal.png and b/docs/_static/img/spatialdata_horizontal.png differ diff --git a/docs/installation.md b/docs/installation.md index a9d83a63..d80c4927 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -34,12 +34,22 @@ pip install "spatialdata[torch]" ## Development version -To install `spatialdata` from GitHub, run:: +To install `spatialdata` from GitHub, run: ```bash pip install git+https://github.com/scverse/spatialdata ``` +Alternative you can clone the repository and do an editable install with: + +```bash +pip install -e . +``` + +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`. + +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. + [napari-spatialdata]: https://github.com/scverse/napari-spatialdata