RSRF 0.0.1__tar.gz

rsrf-0.0.1/MANIFEST.in

@@ -0,0 +1,11 @@
+include README.md
+include mkdocs.yml
+graft src
+graft docs
+graft scripts
+prune docs/assets/visualization
+prune data
+prune sources
+prune tests
+global-exclude __pycache__
+global-exclude *.py[cod]

rsrf-0.0.1/PKG-INFO

@@ -0,0 +1,207 @@
+Metadata-Version: 2.4
+Name: RSRF
+Version: 0.0.1
+Summary: Canonical spectral response definitions, ingest tooling, and QA workflows for optical satellite sensors.
+License-Expression: LicenseRef-RepositorySpecific
+Project-URL: Homepage, https://github.com/MarcYin/spectral_response
+Project-URL: Documentation, https://marcyin.github.io/spectral_response/
+Project-URL: Repository, https://github.com/MarcYin/spectral_response
+Project-URL: Issues, https://github.com/MarcYin/spectral_response/issues
+Keywords: spectral response,remote sensing,satellite,hyperspectral,multispectral
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: GIS
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: numpy>=1.21
+Requires-Dist: openpyxl>=3.1
+Requires-Dist: pandas>=1.5
+Requires-Dist: pyarrow>=10
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.6; extra == "docs"
+Requires-Dist: mkdocs-material>=9.5; extra == "docs"
+Provides-Extra: ingest
+Requires-Dist: h5py>=3.8; extra == "ingest"
+Requires-Dist: netCDF4>=1.6; extra == "ingest"
+Requires-Dist: xarray>=2023.0; extra == "ingest"
+Provides-Extra: qa
+Requires-Dist: matplotlib>=3.5; extra == "qa"
+Provides-Extra: release
+Requires-Dist: build>=1.2; extra == "release"
+Requires-Dist: twine>=5.1; extra == "release"
+Provides-Extra: dev
+Requires-Dist: h5py>=3.8; extra == "dev"
+Requires-Dist: matplotlib>=3.5; extra == "dev"
+Requires-Dist: mkdocs>=1.6; extra == "dev"
+Requires-Dist: mkdocs-material>=9.5; extra == "dev"
+Requires-Dist: netCDF4>=1.6; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: twine>=5.1; extra == "dev"
+Requires-Dist: xarray>=2023.0; extra == "dev"
+
+# RSRF
+
+![rsrfs](figs/rsrfs.png)
+
+`RSRF` is a repository-backed Python toolkit for canonical optical sensor spectral response definitions.
+
+It combines three things that usually drift apart:
+
+- a clean Python API for reading sampled curves and metadata-only band specs
+- reproducible ingest tooling for official upstream response artifacts
+- QA and release workflows for maintaining a curated response repository
+
+The PyPI distribution name is `RSRF`. The import package is `rsrf`.
+
+> **Explore the RSRFs in your browser:** [https://marcyin.github.io/spectral_response/visualizations/](https://marcyin.github.io/spectral_response/visualizations/)
+>
+> Use the interactive visualization page to inspect sensor bandpasses, compare overlapping responses, and quickly check the published RSRFs without setting up the repository locally.
+
+## Installation
+
+During development:
+
+```bash
+python3 -m pip install -e ".[dev]"
+```
+
+After release:
+
+```bash
+python3 -m pip install RSRF
+```
+
+## Quick start
+
+From a repository checkout:
+
+```bash
+export RSRF_ROOT="$PWD"
+rsrf list-sensors
+rsrf list-bands sentinel-2c_msi --variant band_average
+rsrf show-response prisma_hsi B001 --variant metadata_band_spec
+rsrf validate-sensor sentinel-2c_msi --variant band_average
+```
+
+From Python:
+
+```python
+from rsrf import list_sensors, load_response_definition
+
+sensors = list_sensors()
+response = load_response_definition("sentinel-2c_msi", "B01", "band_average")
+```
+
+## Working with repository data
+
+The installed package does not bundle the full canonical repository, raw sources, or parquet registries. Point the code at a repository checkout or generated data root with one of these patterns:
+
+- run commands from the repository root
+- pass `--root /path/to/repo`
+- set `RSRF_ROOT=/path/to/repo`
+
+Manifest-driven commands also resolve checked-in manifest filenames directly from the manifest library, so this works from the repository root:
+
+```bash
+rsrf validate-manifest rsrf_source_manifest_sentinel2c_v2.json
+rsrf register-manifest rsrf_source_manifest_prisma_hsi_v2.json
+```
+
+## Repository structure
+
+```text
+.
+|-- data/
+|   |-- canonical/
+|   |-- common_grid/
+|   |-- realized/
+|   `-- registry/
+|-- docs/
+|-- plans/
+|-- scripts/
+|   |-- build/
+|   |-- ingest/
+|   `-- validate/
+|-- sources/
+|   |-- extracted/
+|   |-- manifests/
+|   |   |-- official/
+|   |   |-- planning/
+|   |   `-- templates/
+|   `-- raw/
+|-- src/rsrf/
+|   |-- commands/
+|   `-- parsers/
+`-- tests/
+```
+
+The package is organized so users can navigate by concern:
+
+- `src/rsrf/api.py`: read-side access to canonical sensor definitions
+- `src/rsrf/commands/`: CLI parser, dispatch, and output helpers
+- `src/rsrf/ingest.py`: canonical artifact writing and registry updates
+- `src/rsrf/manifests.py`: manifest library lookup and path resolution
+- `src/rsrf/parsers/`: sensor-family-specific source parsers
+- `src/rsrf/planning.py`: registry-first planning catalog support
+- `src/rsrf/qa.py`: validation reports and plot export
+- `src/rsrf/registry.py`: repository layout and parquet registry helpers
+
+Trusted sampled-curve overlays live at:
+
+```text
+sources/extracted/<sensor_unit_id>/<representation_variant>/overlay_reference.csv
+```
+
+## Current coverage
+
+The repository currently includes:
+
+- sampled-curve families across Sentinel-2, Landsat MSS/TM/ETM+/OLI/TIRS, MODIS, VIIRS, OLCI, ASTER, Planet, PROBA-V, and legacy NASA OBPG ocean-colour missions
+- band-spec families across PACE OCI, EnMAP, EMIT, PRISMA, Satellogic NewSat, Pleiades, Pleiades-Neo, SPOT-6/7, FORMOSAT-5, Amazonia-1, and CBERS-4A
+- optional realized Gaussian approximations when official full sampled curves are not published
+
+The remaining notable gap from the original roadmap is `DESIS`.
+
+## Documentation
+
+Project documentation is built with MkDocs:
+
+- [https://marcyin.github.io/spectral_response/](https://marcyin.github.io/spectral_response/)
+
+Key entry points:
+
+- getting started: [`docs/getting-started.md`](docs/getting-started.md)
+- interactive visualizations: [https://marcyin.github.io/spectral_response/visualizations/](https://marcyin.github.io/spectral_response/visualizations/) ([`docs/visualizations.md`](docs/visualizations.md))
+- repository layout: [`docs/repository-layout.md`](docs/repository-layout.md)
+- CLI reference: [`docs/cli.md`](docs/cli.md)
+- data model: [`docs/data-model.md`](docs/data-model.md)
+- development guide: [`docs/development.md`](docs/development.md)
+- release guide: [`docs/releasing.md`](docs/releasing.md)
+
+## Development
+
+Run the local verification stack with:
+
+```bash
+python3 -m unittest discover -s tests/unit
+python3 -m unittest discover -s tests/regression
+python3 scripts/build/export_docs_visualization_assets.py --root .
+python3 -m build
+python3 -m twine check dist/*
+mkdocs build --strict
+```
+
+## Project status
+
+The active design and implementation history now live under `plans/`:
+
+- [`plans/rsrf_repo_plan_v3_hyperspectral_support.md`](plans/rsrf_repo_plan_v3_hyperspectral_support.md)
+- [`plans/rsrf_implementation_plan.md`](plans/rsrf_implementation_plan.md)

rsrf-0.0.1/README.md

@@ -0,0 +1,158 @@
+# RSRF
+
+![rsrfs](figs/rsrfs.png)
+
+`RSRF` is a repository-backed Python toolkit for canonical optical sensor spectral response definitions.
+
+It combines three things that usually drift apart:
+
+- a clean Python API for reading sampled curves and metadata-only band specs
+- reproducible ingest tooling for official upstream response artifacts
+- QA and release workflows for maintaining a curated response repository
+
+The PyPI distribution name is `RSRF`. The import package is `rsrf`.
+
+> **Explore the RSRFs in your browser:** [https://marcyin.github.io/spectral_response/visualizations/](https://marcyin.github.io/spectral_response/visualizations/)
+>
+> Use the interactive visualization page to inspect sensor bandpasses, compare overlapping responses, and quickly check the published RSRFs without setting up the repository locally.
+
+## Installation
+
+During development:
+
+```bash
+python3 -m pip install -e ".[dev]"
+```
+
+After release:
+
+```bash
+python3 -m pip install RSRF
+```
+
+## Quick start
+
+From a repository checkout:
+
+```bash
+export RSRF_ROOT="$PWD"
+rsrf list-sensors
+rsrf list-bands sentinel-2c_msi --variant band_average
+rsrf show-response prisma_hsi B001 --variant metadata_band_spec
+rsrf validate-sensor sentinel-2c_msi --variant band_average
+```
+
+From Python:
+
+```python
+from rsrf import list_sensors, load_response_definition
+
+sensors = list_sensors()
+response = load_response_definition("sentinel-2c_msi", "B01", "band_average")
+```
+
+## Working with repository data
+
+The installed package does not bundle the full canonical repository, raw sources, or parquet registries. Point the code at a repository checkout or generated data root with one of these patterns:
+
+- run commands from the repository root
+- pass `--root /path/to/repo`
+- set `RSRF_ROOT=/path/to/repo`
+
+Manifest-driven commands also resolve checked-in manifest filenames directly from the manifest library, so this works from the repository root:
+
+```bash
+rsrf validate-manifest rsrf_source_manifest_sentinel2c_v2.json
+rsrf register-manifest rsrf_source_manifest_prisma_hsi_v2.json
+```
+
+## Repository structure
+
+```text
+.
+|-- data/
+|   |-- canonical/
+|   |-- common_grid/
+|   |-- realized/
+|   `-- registry/
+|-- docs/
+|-- plans/
+|-- scripts/
+|   |-- build/
+|   |-- ingest/
+|   `-- validate/
+|-- sources/
+|   |-- extracted/
+|   |-- manifests/
+|   |   |-- official/
+|   |   |-- planning/
+|   |   `-- templates/
+|   `-- raw/
+|-- src/rsrf/
+|   |-- commands/
+|   `-- parsers/
+`-- tests/
+```
+
+The package is organized so users can navigate by concern:
+
+- `src/rsrf/api.py`: read-side access to canonical sensor definitions
+- `src/rsrf/commands/`: CLI parser, dispatch, and output helpers
+- `src/rsrf/ingest.py`: canonical artifact writing and registry updates
+- `src/rsrf/manifests.py`: manifest library lookup and path resolution
+- `src/rsrf/parsers/`: sensor-family-specific source parsers
+- `src/rsrf/planning.py`: registry-first planning catalog support
+- `src/rsrf/qa.py`: validation reports and plot export
+- `src/rsrf/registry.py`: repository layout and parquet registry helpers
+
+Trusted sampled-curve overlays live at:
+
+```text
+sources/extracted/<sensor_unit_id>/<representation_variant>/overlay_reference.csv
+```
+
+## Current coverage
+
+The repository currently includes:
+
+- sampled-curve families across Sentinel-2, Landsat MSS/TM/ETM+/OLI/TIRS, MODIS, VIIRS, OLCI, ASTER, Planet, PROBA-V, and legacy NASA OBPG ocean-colour missions
+- band-spec families across PACE OCI, EnMAP, EMIT, PRISMA, Satellogic NewSat, Pleiades, Pleiades-Neo, SPOT-6/7, FORMOSAT-5, Amazonia-1, and CBERS-4A
+- optional realized Gaussian approximations when official full sampled curves are not published
+
+The remaining notable gap from the original roadmap is `DESIS`.
+
+## Documentation
+
+Project documentation is built with MkDocs:
+
+- [https://marcyin.github.io/spectral_response/](https://marcyin.github.io/spectral_response/)
+
+Key entry points:
+
+- getting started: [`docs/getting-started.md`](docs/getting-started.md)
+- interactive visualizations: [https://marcyin.github.io/spectral_response/visualizations/](https://marcyin.github.io/spectral_response/visualizations/) ([`docs/visualizations.md`](docs/visualizations.md))
+- repository layout: [`docs/repository-layout.md`](docs/repository-layout.md)
+- CLI reference: [`docs/cli.md`](docs/cli.md)
+- data model: [`docs/data-model.md`](docs/data-model.md)
+- development guide: [`docs/development.md`](docs/development.md)
+- release guide: [`docs/releasing.md`](docs/releasing.md)
+
+## Development
+
+Run the local verification stack with:
+
+```bash
+python3 -m unittest discover -s tests/unit
+python3 -m unittest discover -s tests/regression
+python3 scripts/build/export_docs_visualization_assets.py --root .
+python3 -m build
+python3 -m twine check dist/*
+mkdocs build --strict
+```
+
+## Project status
+
+The active design and implementation history now live under `plans/`:
+
+- [`plans/rsrf_repo_plan_v3_hyperspectral_support.md`](plans/rsrf_repo_plan_v3_hyperspectral_support.md)
+- [`plans/rsrf_implementation_plan.md`](plans/rsrf_implementation_plan.md)