invest/README_PYTHON.rst

71 lines
2.2 KiB
ReStructuredText

================================================================
InVEST: Integrated Valuation of Ecosystem Services and Tradeoffs
================================================================
About InVEST
=============
InVEST (Integrated Valuation of Ecosystem Services and Tradeoffs) is a family
of tools for quantifying the values of natural capital in clear, credible, and
practical ways. In promising a return (of societal benefits) on investments in
nature, the scientific community needs to deliver knowledge and tools to
quantify and forecast this return. InVEST enables decision-makers to quantify
the importance of natural capital, to assess the tradeoffs associated with
alternative choices, and to integrate conservation and human development.
InVEST is licensed under a permissive, modified BSD license.
For more information, see:
* `InVEST API documentation <http://invest.readthedocs.io/>`_
* InVEST on `GitHub <https://github.com/natcap/invest>`__
* The `Natural Capital Project website <http://naturalcapitalproject.stanford.edu>`__.
.. Everything after this comment will be included in the API docs.
.. START API
Installing InVEST
=================
Python Dependencies
-------------------
Runtime dependencies for ``natcap.invest`` are listed in ``requirements.txt``.
Installing via pip
------------------
If you have a compiler installed and configured for your system, and
dependencies installed, the easiest way to install InVEST as a python package
is:
.. code-block:: console
$ pip install natcap.invest
Installing the latest development version
-----------------------------------------
The latest development version of InVEST can be installed from our git
source tree:
.. code-block:: console
$ pip install "git+https://github.com/natcap/invest@main#egg=natcap.invest"
Development
===========
Dependencies for InVEST are listed in ``requirements.txt`` (runtime
requirements), ``requirements-dev.txt`` (development requirements), and
``requirements-docs.txt`` (for building documentation).
Support
=======
Participate in the NatCap forums here:
http://community.naturalcapitalproject.org
Bugs may be reported at http://github.com/natcap/invest