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.dev108.tar.gz (283.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.dev108-py3-none-any.whl (71.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: core_lens-0.1.dev108.tar.gz
  • Upload date:
  • Size: 283.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.dev108.tar.gz
Algorithm Hash digest
SHA256 3992912c97ff447b4b73756372147342f1e6e4f841aed76230c033470b7e13dc
MD5 3aa0dfb69732dfdb5af130a77d896f1b
BLAKE2b-256 2adb067f78a6b2ea9a86527d15dd2d2ce589a32f1396d9346ba38917f284bf64

See more details on using hashes here.

File details

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

File metadata

  • Download URL: core_lens-0.1.dev108-py3-none-any.whl
  • Upload date:
  • Size: 71.3 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.dev108-py3-none-any.whl
Algorithm Hash digest
SHA256 93e99785e9c9c1427c99e5a052db4388dc0d13e18bc228c2052ac50f297d912a
MD5 5df3844e4479e69cccad97bb7e469896
BLAKE2b-256 c0adae4e533b7ceda49e3738603e74172a62c65b287fa46249b916678b3c9e6d

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