forestatrisk Python package¶
forestatrisk Python package can be used to model the
tropical deforestation spatially, predict the spatial risk of
deforestation, and forecast the future forest cover in the
tropics. It provides functions to estimate the spatial probability of
deforestation as a function of various spatial explanatory variables.
Spatial explanatory variables can be derived from topography (altitude, slope, and aspect), accessibility (distance to roads, towns, and forest edge), deforestation history (distance to previous deforestation), or land conservation status (eg. protected area) for example.
Vieilledent G. 2021.
forestatrisk: a Python package for
modelling and forecasting deforestation in the tropics.
Journal of Open Source Software. 6(59): 2975.
Statement of Need¶
Spatial modelling of the deforestation allows identifying the main factors determining the spatial risk of deforestation and quantifying their relative effects. Forecasting forest cover change is paramount as it allows anticipating the consequences of deforestation (in terms of carbon emissions or biodiversity loss) under various technological, political and socio-economic scenarios, and informs decision makers accordingly. Because both biodiversity and carbon vary greatly in space, it is necessary to provide spatial forecasts of forest cover change to properly quantify biodiversity loss and carbon emissions associated with future deforestation.
forestatrisk Python package can be used to model the tropical
deforestation spatially, predict the spatial risk of deforestation,
and forecast the future forest cover in the tropics. The spatial data
used to model deforestation come from georeferenced raster files,
which can be very large (several gigabytes). The functions available
forestatrisk package process large rasters by blocks of
data, making calculations fast and efficient. This allows
deforestation to be modeled over large geographic areas (e.g. at the
scale of a country) and at high spatial resolution
(eg. ≤ 30 m). The
forestatrisk package offers the possibility
of using logistic regression with auto-correlated spatial random
effects to model the deforestation process. The spatial random effects
make possible to structure the residual spatial variability of the
deforestation process, not explained by the variables of the model and
often very large. In addition to these new features, the
forestatrisk Python package is open source (GPLv3 license),
cross-platform, scriptable (via Python), user-friendly (functions
provided with full documentation and examples), and easily extendable
(with additional statistical models for example). The
Python package has been used to model deforestation and predict future
forest cover by 2100 across the humid tropics
You will need several dependencies to run the
package. The best way to install the package is to create a Python
virtual environment, either through
conda (recommended) or
You first need to have
miniconda3 installed (see here).
Then, create a conda environment (details here)
and install the
forestatrisk package with the following commands:
conda create --name conda-far -c conda-forge python=3.9 gdal numpy matplotlib pandas patsy pip statsmodels earthengine-api --yes conda activate conda-far pip install pywdpa scikit-learn # Packages not available with conda pip install forestatrisk # For PyPI version # pip install https://github.com/ghislainv/forestatrisk/archive/master.zip # For GitHub dev version # conda install -c conda-forge python-dotenv rclone --yes # Potentially interesting libraries
To deactivate and delete the conda environment:
conda deactivate conda env remove --name conda-far
You first need to have the
virtualenv package installed (see here).
Then, create a virtual environment and install the
package with the following commands:
cd ~ mkdir venvs # Directory for virtual environments cd venvs virtualenv --python=/usr/bin/python3 venv-far source ~/venvs/venv-far/bin/activate # Install numpy first pip install numpy # Install gdal (the correct version) pip install --global-option=build_ext --global-option="-I/usr/include/gdal" gdal==$(gdal-config --version) pip install forestatrisk # For PyPI version, this will install all other dependencies # pip install https://github.com/ghislainv/forestatrisk/archive/master.zip # For GitHub dev version pip install statsmodels # Optional additional packages
To deactivate and delete the virtual environment:
deactivate rm -R ~/venvs/venv-far # Just remove the repository
You can test that the package has been correctly installed using the
forestatrisk in a terminal:
This should return a short description of the
and the version number:
# forestatrisk: modelling and forecasting deforestation in the tropics. # https://ecology.ghislainv.fr/forestatrisk/ # forestatrisk version x.x.
You can also test the package executing the commands in the Get started tutorial.
.sample() sample observations points from a forest cover
change map. The sample is balanced and stratified between deforested
and non-deforested pixels. The function also retrieves information
from explanatory variables for each sampled point. Sampling is done by
block to allow computation on large study areas (e.g. country or
continental scale) with a high spatial resolution (e.g. 30m).
.model_binomial_iCAR() can be used to fit the
deforestation model. A linear Binomial logistic regression model is
used in this case. The model includes an intrinsic Conditional
Autoregressive (iCAR) process to account for the spatial
autocorrelation of the observations. Parameter inference is done in a
hierarchical Bayesian framework. The function calls a Gibbs sampler
with a Metropolis algorithm written in pure C code to reduce
Other models (such as a simple GLM or a Random Forest model) can also be used.
Predict and project¶
.predict() allows predicting the deforestation
probability on the whole study area using the deforestation model
.model_*() functions. The prediction is done by block
to allow the computation on large study areas (e.g. country or
continental scale) with a high spatial resolution (e.g. 30m).
.deforest() predicts the future forest cover map based on a
raster of probability of deforestation (rescaled from 1 to 65535),
which is obtained from function
.predict(), and an area (in
hectares) to be deforested.
A set of functions (eg.
.map_accuracy()) is also provided to perform model and map
forestatrisk Python package is Open Source and released under
the GNU GPL version 3 license. Anybody
who is interested can contribute to the package development following
our Community guidelines. Every
contributor must agree to follow the project’s Code of conduct.
Table of contents¶
- Get started
- Python API
- Indices and tables