Skip to main content

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.

Metadata

Release files for ecoscape-connectivity 0.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ecoscape-connectivity 0.0.3
File Size Uploaded
ecoscape-connectivity-0.0.3.tar.gz 9.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ecoscape-connectivity 0.0.3
File Interpreter ABI Platform
ecoscape_connectivity-0.0.3-py3-none-any.whl Python 3 none any Details

Total release size: 21.1 kB

Release files / ecoscape-connectivity-0.0.3.tar.gz

Download URL ecoscape-connectivity-0.0.3.tar.gz
Size 9.9 kB
Tags Source
SHA-256 checksum
How to use checksums
cae60d19ff4d563ab448f3a0b1c09075aa4305d29771c9f10b67cdf9cebef32c
BLAKE2b-256 checksum
How to use checksums
6ede3272a3a58594eebd0c1de8c4b35ea7ea0f83b7b464b6385e21451f302509
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.7.11

Release files / ecoscape_connectivity-0.0.3-py3-none-any.whl

Download URL ecoscape_connectivity-0.0.3-py3-none-any.whl
Size 11.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
61f71d8edbc603e37bbf173208c3b560115f4b0fd1a74a441f40ac0e9aed1e4c
BLAKE2b-256 checksum
How to use checksums
c8cc6abf5923d197c648e88aa146cc8c2317d4c379b290638d6dfcf9f5526297
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.7.11

Release history Release notifications | RSS feed

0.2.5

2 release files

0.2.4

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.5

2 release files

0.0.4

2 release files

This release

0.0.3 This release

2 release files

0.0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page