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.dev117.tar.gz (288.0 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.dev117-py3-none-any.whl (73.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: core_lens-0.1.dev117.tar.gz
  • Upload date:
  • Size: 288.0 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.dev117.tar.gz
Algorithm Hash digest
SHA256 1937483403beff2e834f9684403110541f8e4a953fca0b470de4212209aaf183
MD5 f64bf0fd9f6dcee35d3dcf1bf4e069f1
BLAKE2b-256 341be6b1c726c4378f1fd254a40ed7831a0437bb7c5feacb73492b209c211966

See more details on using hashes here.

File details

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

File metadata

  • Download URL: core_lens-0.1.dev117-py3-none-any.whl
  • Upload date:
  • Size: 73.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.dev117-py3-none-any.whl
Algorithm Hash digest
SHA256 3e69970298dd8b17f3e769dfde5948dc005d1c3e4c7f4d7313ed4d4edf590523
MD5 08e71d36cca73190623890b5622c8066
BLAKE2b-256 7305a3529afece70574d0d25d27b1b10dfc84f5dc34b56e3f15cfc776d96d545

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