Skip to main content

TERN ecoplots data access library

Project description

EcoPlots Python Library

PyPI Python versions Docs License GitHub EcoPlots Portal

High-level Python clients for discovering, filtering, previewing, and retrieving ecological plot data from the TERN EcoPlots Portal. Returns tidy structures for analysis (pandas.DataFrame, geopandas.GeoDataFrame) or raw GeoJSON.


Features

  • 🔎 Discover datasets with validated, human-friendly filters
  • ⚡ Preview result pages before full downloads
  • 🗺️ Spatial selection (GeoJSON/WKT)
  • 🧭 Two clients: synchronous EcoPlots and asynchronous AsyncEcoPlots
  • 💾 Save / load projects via .ecoproj for reproducible workflows

Documentation: https://terndata-ecoplots.readthedocs.io


Installation

pip install terndata.ecoplots

Supported Python: 3.10+


Quick start

from terndata.ecoplots import EcoPlots

ec = EcoPlots()
ec.select(site_id="TCFTNS0002")    # add validated filters
preview = ec.preview().head()      # quick look (first page)
gdf = ec.get_data()                # full pull (GeoDataFrame)

Async

import asyncio
from terndata.ecoplots import AsyncEcoPlots

async def main():
    ec = AsyncEcoPlots()
    ec.select(site_id="TCFTNS0002")
    gdf = await ec.get_data()
    return gdf

# asyncio.run(main())

Demo

For example usage, please refer to the demo notebook.


Links


Contributing

Issues and pull requests are welcome—please open an issue to discuss substantial changes.

Build docs locally:

pip install -r docs/requirements.txt
make -C docs html

Run tests:

make test

Build wheels locally:

make build

Support

For questions or issues, email esupport@tern.org.au.


Citation

Terrestrial Ecosystem Research Network (2025). terndata.ecoplots: A Python package for accessing TERN EcoPlots data. https://pypi.org/project/terndata.ecoplots/


License

Licensed under the terms in LICENSE.
Copyright © 2025 TDSA (TERN Data Services and Analytics). Author: Avinash Chandra.

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

terndata_ecoplots-0.0.4b0.tar.gz (275.2 kB view details)

Uploaded Source

Built Distribution

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

terndata_ecoplots-0.0.4b0-py3-none-any.whl (109.6 kB view details)

Uploaded Python 3

File details

Details for the file terndata_ecoplots-0.0.4b0.tar.gz.

File metadata

  • Download URL: terndata_ecoplots-0.0.4b0.tar.gz
  • Upload date:
  • Size: 275.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for terndata_ecoplots-0.0.4b0.tar.gz
Algorithm Hash digest
SHA256 e198a566c387e94da0df7c53f6d898fa6eed4b1a17bb6fb1d44fc823203955f7
MD5 bf38f3244d9bf478f6777096d8ac06a5
BLAKE2b-256 b1648ca7a1cba30bb959ccb5a7975a0278ef12edbeaee9502d2bdbc87ab557c6

See more details on using hashes here.

Provenance

The following attestation bundles were made for terndata_ecoplots-0.0.4b0.tar.gz:

Publisher: publish.yml on ternaustralia/terndata.ecoplots

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file terndata_ecoplots-0.0.4b0-py3-none-any.whl.

File metadata

File hashes

Hashes for terndata_ecoplots-0.0.4b0-py3-none-any.whl
Algorithm Hash digest
SHA256 be8dc74b8734db306c48a58cbc56b7579049ac3bf9072d72832b5e1b9e410c36
MD5 5c186799e9e362e6d636f765bfd01f0c
BLAKE2b-256 f2200b9f42ffed6c5095e547f0bc16bca2c165ec2e46bc4e368e943e5ef88b42

See more details on using hashes here.

Provenance

The following attestation bundles were made for terndata_ecoplots-0.0.4b0-py3-none-any.whl:

Publisher: publish.yml on ternaustralia/terndata.ecoplots

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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