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.dev112.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.dev112-py3-none-any.whl (71.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: core_lens-0.1.dev112.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.dev112.tar.gz
Algorithm Hash digest
SHA256 9eee30e4a2632063facd76f32a01287b275a0264fed922b472d9f1c43765f472
MD5 d56105a9644818c090be498470daa01b
BLAKE2b-256 1bbd1d8801522bad80a69e328ec1ccf8174683e908e4f1bf0bab3f76220e9d6f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: core_lens-0.1.dev112-py3-none-any.whl
  • Upload date:
  • Size: 71.4 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.dev112-py3-none-any.whl
Algorithm Hash digest
SHA256 2aefeabd20ebbdd10416d0a84f5b37c7f07dfc1d4571e4964498f19a44b4a58b
MD5 0305022e8b256427c439ad96e2e1c21a
BLAKE2b-256 aeb8afbbfa7c51f83f65d128c537630fed5eff5e3553478fa3a886904ef07075

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