Skip to content

Commit

Permalink
Merge pull request #226 from synsense/225-installation-instructions-t…
Browse files Browse the repository at this point in the history
…o-mention-risks-of-development-install

Installation instructions warn about development installation.
  • Loading branch information
MinaKh authored Feb 15, 2024
2 parents 205ccf4 + 060f369 commit f80b691
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/getting_started/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,15 @@ If you want to develop or have access to source code of **sinabs**, download the
cd <to/your/software/folder>
git clone [email protected]:synsense/sinabs.git
cd sinabs
pip install -e . --user
pip install .


For developers, we recommend that you install this package as a development version so that you can update the package without reinstalling it.

pip install -e .

.. note::
If you are either using or developing plugin packages such as `sinabs-exodus`, a development install with `-e` flag does not work as expected.
We suggest you do a regular pip installation every time you make a change.


0 comments on commit f80b691

Please sign in to comment.