Skip to content

Commit 23a91a8

Browse files
authored
a few more details on installing invest
1 parent c257f38 commit 23a91a8

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.rst

+14-4
Original file line numberDiff line numberDiff line change
@@ -79,16 +79,26 @@ dependencies needed.
7979

8080
Installing ``natcap.invest`` from local source code
8181
"""""""""""""""""""""""""""""""""""""""""""""""""""
82-
From an activated virtual environment::
82+
From an activated virtual environment, it's safest to uninstall any existing installation
83+
and then install `natcap.invest`::
8384

85+
$ pip uninstall natcap.invest
8486
$ make install
8587

8688
In practice, it can be convenient to use an "editable install" instead to avoid needing
87-
to re-install after making changes to source code::
89+
to uninstall & re-install after making changes to source code::
8890

8991
$ pip install -e .
9092

91-
But note that any changes to non-Python files will still require compilation.
93+
Note that with an editable install any changes to non-Python (Cython, C++) files will
94+
require compilation using one of the above installation methods.
95+
96+
*The Workbench is not part of the* ``natcap.invest`` *Python package. See*
97+
``workbench/readme.md`` *for developer details.*
98+
99+
A successful ``natcap.invest`` installation will include the InVEST CLI::
100+
101+
$ invest list
92102

93103
Building InVEST Distributions
94104
-----------------------------
@@ -153,7 +163,7 @@ To build the user's guide::
153163
This will build HTML and PDF documentation, writing them to ``dist/userguide``
154164
and ``dist/InVEST_*_Documentation.pdf``, respectively.
155165

156-
The User's Guide is maintained in a separate git reporsitory. InVEST will build
166+
The User's Guide is maintained in a separate git repository. InVEST will build
157167
the User's Guide with the commit defined in the ``Makefile``::
158168

159169
GIT_UG_REPO := https://github.com/natcap/invest.users-guide

0 commit comments

Comments
 (0)