Skip to main content

Query, analyse, and visualise CoreStack's microwatershed and Earth science data through a clean, composable Python API.

Project description

CoreLens

GitHub last commit GitHub Actions Workflow Status GitHub repo size

A Python library for querying, analysing, and visualising geospatial Earth science data built on CoreStack.

CoreLens provides a unified interface over microwatersheds, administrative boundaries, and pluggable domain entities — with lazy Parquet I/O (powered by Polars), seasonal time-series support, and spatial statistical analysis.

Quickstart

pip install core-lens
from core_lens import AoI
from core_lens.entities import MWSEntity, TehsilEntity

# Register entities
AoI.register(MWSEntity)
AoI.register(TehsilEntity)

# Create an AoI scoped to a specific Tehsil
aoi = AoI(data_root="/path/to/data", tehsil="Pangi")

# Access entities scoped to this AoI
mws_view = aoi.mws

# Materialise and plot
static_result = mws_view.static
aoi.plot(overlay=static_result)

Documentation

Full documentation is available in the docs/ directory. It includes:

  • Core Concepts: Understanding AoI, Views, and Results.
  • Example Queries: Time filtering, aggregations, spatial joins, and statistics.
  • Plugin System: How to add custom entities.

To build the docs locally:

cd docs
make html

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

core_lens-0.1.dev99.tar.gz (281.5 kB view details)

Uploaded Source

Built Distribution

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

core_lens-0.1.dev99-py3-none-any.whl (69.0 kB view details)

Uploaded Python 3

File details

Details for the file core_lens-0.1.dev99.tar.gz.

File metadata

  • Download URL: core_lens-0.1.dev99.tar.gz
  • Upload date:
  • Size: 281.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Fedora Linux","version":"44","id":"","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for core_lens-0.1.dev99.tar.gz
Algorithm Hash digest
SHA256 039567386710e18fecefde373b328152d8d7d2ef981ed83a33ebf1af63980c5b
MD5 48abf549eb7500b511d8509ec55007cb
BLAKE2b-256 7a3b5c01673629a9d94fbc122021fd29e8a5598133ad8b6f69a2333e01fbe137

See more details on using hashes here.

File details

Details for the file core_lens-0.1.dev99-py3-none-any.whl.

File metadata

  • Download URL: core_lens-0.1.dev99-py3-none-any.whl
  • Upload date:
  • Size: 69.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Fedora Linux","version":"44","id":"","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for core_lens-0.1.dev99-py3-none-any.whl
Algorithm Hash digest
SHA256 9a0245e28904b642aec51f2cc09e1dcc6f25a9d6fd1cb4d945c1aa16ec086db0
MD5 017d2f82e350ca5da8e39dd979d21bb7
BLAKE2b-256 81720ce8a1336a9c7fda2eb018a228c363d05b34901d0dddf7b05d0be1f761d9

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