Skip to main content

dhidb

PyPI version CI and release

dhidb provides read-only Python access to a global 300 m, 12-year (2014-2025) Dynamic Habitat Indices time series stored as a dense TileDB array on public S3-compatible object storage. It supports point, bounding-box, and polygon queries without first downloading the complete database.

DHIs are widely used in spatial ecology as interpretable predictors of habitat quality and vegetation dynamics, including covariates in species distribution models (SDMs) and biodiversity assessments.

Installation

pip install dhidb

For development:

python -m pip install -e ".[test]"

Requirements and optional dependencies

DHIDB requires Python 3.10 or newer. The runtime dependencies and the compatibility ranges published by the package are:

Dependency Supported version range
affine >=2.4
numpy >=1.26,<3
pandas >=2.1
pyproj >=3.6
rasterio >=1.3
shapely >=2.0
tiledb >=0.35,<0.38
xarray >=2024.1

Optional features are installed with package extras. There is no generic dhidb[dependency] extra; use the feature-specific extra you need:

Extra Install command Adds
netcdf pip install "dhidb[netcdf]" scipy>=1.11 for NetCDF export
zarr pip install "dhidb[zarr]" zarr>=2.18 for Zarr export
test pip install "dhidb[test]" build, pytest, coverage, Ruff, and SciPy tooling

For local development and testing:

python -m pip install -e ".[test,netcdf,zarr]"

The documentation website has its own Node.js dependencies in website/package.json; they are not part of the Python package extras.

Quick start

from dhidb import DHIProvider

with DHIProvider() as db:
    print(db.years)
    print(db.variables)

    for batch in db.iter_bbox(
        bounds=(12.25, 51.25, 12.50, 51.40),  # Leipzig, Germany
        years=range(2014, 2026),
        variables=["dhi_cum", "dhi_min", "dhi_var", "valid_count"],
        batch_shape={"y": 256, "x": 256},
    ):
        print(batch.sizes)

Documentation

The Docusaurus website source is in website/. Build it locally with:

npm --prefix website install
npm --prefix website run start

Data variables

Variable Meaning Unit
dhi_cum Cumulative productivity from LSP TPROD PPI integral (m2 m-2 day)
dhi_min Minimum seasonal productivity baseline from LSP MINV PPI (m2 m-2)
dhi_var Inter-period GPP coefficient of variation dimensionless
dhi_combined Normalized combined DHI, where available dimensionless
observed_count Number of available 10-day observations scenes
valid_count Number of accepted 10-day observations scenes
qflag_any_count Observations carrying any source quality flag scenes
qflag_rejected_count Observations rejected by quality filtering scenes

License

MIT

Download files

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

Source Distribution

dhidb-0.3.0.tar.gz (35.0 MB view details)

Uploaded Source

Built Distribution

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

dhidb-0.3.0-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file dhidb-0.3.0.tar.gz.

File metadata

  • Download URL: dhidb-0.3.0.tar.gz
  • Upload date:
  • Size: 35.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for dhidb-0.3.0.tar.gz
Algorithm Hash digest
SHA256 b863c1cccee215fe695b075a71cb7ca525d0408fe7dd1099d96225ac2947aa10
MD5 00fa503993f8a9b2d72e89ced9c931a1
BLAKE2b-256 ea25053825d3cf0b7525e3a513949712fb88ecff6547879d3f481642dc32421e

See more details on using hashes here.

File details

Details for the file dhidb-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: dhidb-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 12.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for dhidb-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1323b700880342b6cfbf43892f540584c9f1cfb379592e9e9e606842b9ae1bb7
MD5 2c94fa244b5d26e5d70217bc0dcb2bf8
BLAKE2b-256 b3c74f547dd24e7fbc141800c4aec4199791579fa3c504128ca85866749b6790

See more details on using hashes here.

Release history Release notifications | RSS feed

0.3.2

2 files

0.3.1

2 files

This release

0.3.0 This release

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 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