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 <[email protected]>
scverse · May 19, 2023 · ae61666 · ae61666
1 parent 4325b59
commit ae61666
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/docs/_static/img/spatialdata_horizontal.png b/docs/_static/img/spatialdata_horizontal.png
diff --git 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.
+
 <!-- Links -->
 
 [napari-spatialdata]: https://github.com/scverse/napari-spatialdata