Skip to main content

A Python interface to compute biodiversity metric based on landscape elevational connectivity.

Project description

bioLEC - Landscape Elevational Connectivity Package

Docker Cloud Automated build PyPI Documentation Status

bioLEC documentation is found at biolec.readthedocs.io

bioLEC is a parallel python package built to calculate the Landscape elevational connectivity (LEC).

bioLEC

LEC quantifies the closeness of a site to all others with similar elevation. It measures how easily a species living in a given patch can spread and colonise other patches. It is assumed to be elevation-dependent and the metric depends on how often a species adapted to a given elevation needs to travel outside its optimal elevation range when moving from its patch to any other in the landscape [Bertuzzo et al., 2016].

Installation

Dependencies

You will need Python 2.7 or 3.5+. Also, the following packages are required:

Installing using pip

You can install bioLEC using the pip package manager with either version of Python:

python2 -m pip install bioLEC
python3 -m pip install bioLEC

Installing using Docker

A more straightforward installation which does not depend on specific compilers relies on the docker virtualisation system.

To install the docker image and test it is working:

   docker pull geodels/biolec:latest
   docker run --rm geodels/biolec:latest help

To build the dockerfile locally, we provide a script. First ensure you have checked out the source code from github and then run the script in the Docker directory. If you modify the dockerfile and want to push the image to make it publicly available, it will need to be retagged to upload somewhere other than the GEodels repository.

git checkout https://github.com/Geodels/bioLEC.git
cd bioLEC
source Docker/build-dockerfile.sh

Usage

Binder & docker container

Launch the demonstration at mybinder.org

Binder

LEC computation

Notebooks environment will not be the best option for large landscape models and we will recommend the use of the python script: runLEC.py in HPC environment. the code will need to be

mpirun -np 400 python runLEC.py

Or using the Docker container available through Kitematic geodels/biolec.

Docker Cloud Automated build

LEC computation

Collaborations

How to contribute?

We welcome all kinds of contributions! Please get in touch if you would like to help out.

Everything from code to notebooks to examples and documentation are all equally valuable so please don't feel you can't contribute.

To contribute please fork the project make your changes and submit a pull request. We will do our best to work through any issues with you and get your code merged into the main branch.

If you found a bug, have questions, or are just having trouble with bioLEC, you can:

Where to find support?

Please feel free to submit new issues to the issue-log to request new features, document new bugs, or ask questions.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this program. If not, see http://www.gnu.org/licenses/lgpl-3.0.en.html.

References

  1. E. Bertuzzo, F. Carrara, L. Mari, F. Altermatt, I. Rodriguez-Iturbe & A. Rinaldo - Geomorphic controls on species richness. PNAS, 113(7) 1737-1742, DOI: 10.1073/pnas.1518922113, 2016.

  2. T.R. Etherington - Least-cost modelling and landscape ecology: concepts, applications, and opportunities. Current Landscape Ecology Reports 1:40-53, DOI: 10.1007/s40823-016-0006-9, 2016.

  3. S. van der Walt , J.L. Schönberger, J. Nunez-Iglesias, F. Boulogne, J.D. Warner, N. Yager, E. Gouillart & T. Yu - Scikit Image Contributors - scikit-image: image processing in Python, PeerJ 2:e453, 2014.

  4. T.R. Etherington - Least-cost modelling with Python using scikit-image, Blog, 2017.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for bioLEC, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size bioLEC-1.0.0.tar.gz (10.5 MB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page