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.dev109.tar.gz (283.4 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.dev109-py3-none-any.whl (71.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: core_lens-0.1.dev109.tar.gz
  • Upload date:
  • Size: 283.4 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.dev109.tar.gz
Algorithm Hash digest
SHA256 641a61623777073b9a6dc06e7f83349e1b9bceca8f3c276c9422cece4af44036
MD5 934c811314e31254beb127bdf8a599d4
BLAKE2b-256 de3f5c86975bb8d69310dc5a1a75f5b539f54b1b3d9226aea745c405cdd7c083

See more details on using hashes here.

File details

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

File metadata

  • Download URL: core_lens-0.1.dev109-py3-none-any.whl
  • Upload date:
  • Size: 71.2 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.dev109-py3-none-any.whl
Algorithm Hash digest
SHA256 80ebd3248c862ca0f8efbd60d5b8cf933f17d172901164663c6aa90607e4589c
MD5 f645e6f0744cda327822dd05b7b3ffc9
BLAKE2b-256 e5b37479a5d5821bc9a4a4214e520c488790cc00e2d3cd5b51085107b2ed4e6e

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