Skip to content

Commit dca4811

Browse files
authored
updates related to python environments and package installation
1 parent 3fc95d2 commit dca4811

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

README.rst

+19-11
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ General Information
3535
Dependencies
3636
------------
3737

38-
Run ``make check`` to test if all required dependencies are installed on your system.
3938
OS-specific installation instructions are found either online at
4039
http://invest.readthedocs.io/en/latest/installing.html or locally at ``doc/api-docs/installing.rst``.
4140

@@ -57,10 +56,7 @@ Or on Windows, use the following instead from a CMD prompt::
5756
> make env
5857
> .\env\bin\activate
5958

60-
This makefile target is included for convenience ... you may of course choose to
61-
manage your own virtual environment. ``requirements.txt``,
62-
``requirements-dev.txt`` and ``requirements-docs.txt`` list the python
63-
dependencies needed.
59+
This makefile target is included for convenience. It uses ``conda`` and installs packages from ``conda-forge``.
6460

6561
Using a different environment name
6662
""""""""""""""""""""""""""""""""""
@@ -74,13 +70,25 @@ You could then activate the environment created at ``myEnv``.
7470

7571
Using a different environment management tool
7672
"""""""""""""""""""""""""""""""""""""""""""""
77-
The InVEST Makefile uses ``virtualenv`` to set up an environment, but this is
78-
not the only `environment management tool out there
79-
<https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments>`_.
80-
You may elect to manage your virtual environment a different way, independent
81-
of ``make env``. The only requirement for the build process is that the required
82-
tools are available on your PATH and the required python packages can be imported.
73+
You may of course choose to manage your own virtual environment without using the Makefile.
74+
75+
We suggest using ``conda`` or ``mamba`` and ``conda-forge``.
76+
77+
``requirements.txt``, ``requirements-dev.txt`` and ``requirements-docs.txt`` list the python
78+
dependencies needed.
79+
80+
Installing ``natcap.invest`` from local source code
81+
"""""""""""""""""""""""""""""""""""""""""""""""""""
82+
From an activated virtual environment::
83+
84+
$ make install
85+
86+
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::
88+
89+
$ pip install -e .
8390

91+
But note that any changes to non-Python files will still require compilation.
8492

8593
Building InVEST Distributions
8694
-----------------------------

0 commit comments

Comments
 (0)