Skip to main content

EcoScape habitat connectivity computation.

Project description

EcoScape Connectivity Computation

This package implements the computation of connectivity and flow according to the EcoScape algorithm.

Authors

Usage

The package can be used both from the command line, and as a python module. For command line options, do:

ecoscape-connectivity --help

As a Python module, the main function is compute_connectivity:

from ecoscape_connectivity import compute_connectivity

def compute_connectivity(habitat_fn=None,
                         terrain_fn=None,
                         connectivity_fn=None,
                         flow_fn=None,
                         permeability_dict=None,
                         gap_crossing=2,
                         num_gaps=10,
                         num_simulations=400,
                         seed_density=4,
                         single_tile=False,
                         tile_size=1000,
                         tile_border=256,
                         minimum_habitat=1e-4)

The computation will be much faster if you run it with GPU support.

The output connectivity and flow are encoded in the output geotiffs as follows:

  • For connectivity, the values from [0, 1] are rescaled to the range 0..255 and encoded as integers.
  • For flow, the values of $f \in [0, \infty)$ are encoded in log-scale via $20 \cdot log_{10} (1 + f)$ (so that the flow is expressed in dB, like sound intensity), and clipped to integers in the 0..255 range.

Arguments:

  • habitat_fn: name of habitat geotiff. This file must contain 0 = non habitat, and 1 = habitat.
  • terrain_fn: name of the landscape matrix geotiff. This file contains terrain categories that are translated via permeability_dict.
  • connectivity_fn: output file name for connectivity.
  • flow_fn: output file name for flow. If None, the flow is not computed, and the computation is faster.
  • permeability_dict: Permeability dictionary. Gives the permeability of each terrain type, translating from the terrain codes, to the permeability in [0, 1]. If a terrain type is not found in the dictionary, it is assumed it has permeability 0.
  • gap_crossing: size of gap crossing in pixels.
  • num_gaps: number of gaps that can be crossed during dispersal.
  • num_simulations: Number of simulations that are done.
  • seed_density: density of seeds. There are this many seeds for every square with edge of dispersal distance.
  • single_tile: if True, instead of iterating over small tiles, tries to read the input as a single large tile. This is faster, but might not fit into memory.
  • tile_size: size of (square) tile in pixels.
  • tile_border: size of tile border in pixels.
  • minimum_habitat: if a tile has a fraction of habitat smaller than this, it is skipped. This saves time in countries where the habitat is only on a small portion.

Example Notebooks

Here you can find a Colab Notebook that demonstrates connectivity computation.

Project details


Download files

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

Source Distribution

ecoscape-connectivity-0.0.3.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ecoscape_connectivity-0.0.3-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

Details for the file ecoscape-connectivity-0.0.3.tar.gz.

File metadata

  • Download URL: ecoscape-connectivity-0.0.3.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.11

File hashes

Hashes for ecoscape-connectivity-0.0.3.tar.gz
Algorithm Hash digest
SHA256 cae60d19ff4d563ab448f3a0b1c09075aa4305d29771c9f10b67cdf9cebef32c
MD5 80bb0c6051163c2097d48826aa01ba58
BLAKE2b-256 6ede3272a3a58594eebd0c1de8c4b35ea7ea0f83b7b464b6385e21451f302509

See more details on using hashes here.

File details

Details for the file ecoscape_connectivity-0.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for ecoscape_connectivity-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 61f71d8edbc603e37bbf173208c3b560115f4b0fd1a74a441f40ac0e9aed1e4c
MD5 437d5800b8eb593ae1aa4e260ce10c94
BLAKE2b-256 c8cc6abf5923d197c648e88aa146cc8c2317d4c379b290638d6dfcf9f5526297

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page