allclear 0.2.0__tar.gz

allclear-0.2.0/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  push:
+    branches: [main, dev]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: uv sync --python ${{ matrix.python-version }}
+      - name: Run tests with coverage
+        run: uv run pytest allclear/tests/ -v --cov=allclear --cov-report=xml
+      - name: Upload coverage to Codecov
+        if: matrix.python-version == '3.12'
+        uses: codecov/codecov-action@v4
+        with:
+          files: coverage.xml
+          fail_ci_if_error: false
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

allclear-0.2.0/.gitignore

@@ -0,0 +1,220 @@
+# Project data & outputs
+example_images/
+extr/
+catalog/
+/*.png
+/*.gif
+/*.jpg
+/*.json
+*.fits
+.python-version
+fit_distortion.py
+reports/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

allclear-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Zach Gazak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

allclear-0.2.0/Makefile

@@ -0,0 +1,50 @@
+# AllClear Makefile
+
+.PHONY: help install install-dev test coverage badges build clean publish publish-test
+
+PYTHON := uv run python
+
+help:
+	@echo "Available targets:"
+	@echo "  install       - Install package"
+	@echo "  install-dev   - Install with dev dependencies"
+	@echo "  test          - Run tests"
+	@echo "  coverage      - Run tests with coverage + generate badges"
+	@echo "  build         - Build wheel and sdist"
+	@echo "  clean         - Remove build artifacts"
+	@echo "  publish-test  - Upload to TestPyPI"
+	@echo "  publish       - Upload to PyPI"
+
+install:
+	uv pip install -e .
+
+install-dev:
+	uv pip install -e ".[dev]"
+
+test:
+	uv run pytest allclear/tests/ -v
+
+coverage:
+	uv run pytest allclear/tests/ -v \
+		--junitxml=reports/junit/junit.xml \
+		--cov=allclear \
+		--cov-report=term-missing \
+		--cov-report=xml \
+		--cov-report=html
+	uv run genbadge tests -o tests.svg
+	uv run genbadge coverage -i coverage.xml -o coverage.svg
+	@echo "Coverage report: htmlcov/index.html"
+
+build: clean
+	$(PYTHON) -m build
+
+clean:
+	rm -rf build/ dist/ *.egg-info/
+	rm -rf .pytest_cache/ htmlcov/ .coverage coverage.xml reports/
+	find . -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || true
+
+publish-test: build
+	uv run twine upload --repository testpypi dist/*
+
+publish: build
+	uv run twine upload dist/*

allclear-0.2.0/PKG-INFO

@@ -0,0 +1,190 @@
+Metadata-Version: 2.4
+Name: allclear
+Version: 0.2.0
+Summary: All-sky camera cloud detection via stellar transmission mapping
+Project-URL: Homepage, https://github.com/zgazak/allclear
+Project-URL: Issues, https://github.com/zgazak/allclear/issues
+Author-email: Zach <jzg@alum.mit.edu>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: all-sky,astronomy,cloud-detection,fisheye,photometry,transmission
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Requires-Python: >=3.10
+Requires-Dist: astropy
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: photutils
+Requires-Dist: scipy
+Provides-Extra: dev
+Requires-Dist: build>=1.4.0; extra == 'dev'
+Requires-Dist: genbadge[coverage,tests]>=1.1.3; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: twine>=6.2.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# allclear
+
+![Tests](tests.svg) ![Coverage](coverage.svg)
+
+All-sky camera cloud detection via stellar transmission mapping.
+
+`allclear` takes FITS images from all-sky cameras, blind-solves the camera
+geometry by matching detected stars against a catalog, and produces
+full-hemisphere cloud transmission maps with annotated PNG output.
+
+|             Clear sky              |               Obscured sky               |
+| :--------------------------------: | :--------------------------------------: |
+| ![Clear sky](docs/clear_blink.gif) | ![Obscured sky](docs/obscured_blink.gif) |
+
+*Blink comparison: star identification (red circles = catalog, green crosshairs = matched) and transmission overlay (green = clear, red = cloudy).*
+
+## How it works
+
+1. **Detection** -- Background-subtracted star detection using DAOStarFinder
+2. **Catalog** -- Hipparcos/BSC5 bright star catalog (~9000 stars, V <= 6.5) projected to observer alt/az with atmospheric refraction and extinction
+3. **Blind solve** -- Hypothesis-and-verify pattern matching: for each bright (detection, catalog star) pair, hypothesize camera parameters, count matches. Best hypothesis seeds iterative refinement.
+4. **Camera model** -- Least-squares refinement of a fisheye camera model (center, focal length, boresight, roll, radial distortion) with automatic projection type selection
+5. **Guided matching** -- For each catalog star, project to pixel position and find the nearest bright peak. Sub-pixel centroiding. Avoids DAOStarFinder artifacts from domes/obstructions.
+6. **Transmission** -- Per-star photometric transmission from local-background-subtracted flux vs catalog magnitude, calibrated against a global clear-sky zeropoint. Unmatched catalog stars contribute zero transmission. Interpolated via RBF.
+
+## Installation
+
+```
+pip install allclear
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```
+uv add allclear
+uv sync
+```
+
+Requires Python >= 3.10. Dependencies: numpy, scipy, astropy, photutils, matplotlib.
+
+## Quick start
+
+### 1. Characterize camera geometry (one-time)
+
+```
+allclear instrument-fit \
+    --frames your_sky_image.fits \
+    --lat 20.7458 --lon -156.4317 \
+    --output instrument_model.json
+```
+
+This blind-solves the camera model and saves it as JSON, including a
+photometric zeropoint calibrated from the (presumably clear) input frame.
+Typically matches 400-550 stars at 2-3 pixel RMS.
+
+Supports FITS, JPG, PNG, and TIFF. For non-FITS images, provide the
+observation time with `--time`:
+
+```
+allclear instrument-fit \
+    --frames sky_photo.jpg \
+    --lat 20.7458 --lon -156.4317 \
+    --time "2024-01-15 03:30:00-10:00" \
+    --output instrument_model.json
+```
+
+### 2. Process frames with known model (fast)
+
+```
+allclear solve \
+    --frames "sky_images/*.fits" \
+    --model instrument_model.json
+```
+
+For each frame, produces:
+- `<stem>_solved.png` -- Annotated image with star matches (green crosshairs = matched, red circles = catalog)
+- `<stem>_transmission.png` -- Same image with RdYlGn transmission overlay (green = clear, red = cloudy/obstructed)
+- `<stem>_blink.gif` -- Animated blink between solved and transmission views
+
+Use `--no-plot` to suppress image output. Use `--output-dir <dir>` to write to a specific directory.
+
+### 3. Quick sky check
+
+```
+allclear check \
+    --frame sky_image.fits \
+    --model instrument_model.json \
+    --target-ra 83.63 --target-dec -5.39 --target-name "Orion Nebula"
+```
+
+Reports overall clear fraction and transmission at a specific sky position.
+
+## Camera model
+
+The fisheye projection model supports four lens types:
+
+| Type          | Formula               |
+| ------------- | --------------------- |
+| Equidistant   | r = f * theta         |
+| Equisolid     | r = 2f * sin(theta/2) |
+| Stereographic | r = 2f * tan(theta/2) |
+| Orthographic  | r = f * sin(theta)    |
+
+Parameters: optical center (cx, cy), boresight direction (az0, alt0),
+roll angle (rho), focal length (f), and radial distortion coefficients (k1, k2).
+
+The instrument model is saved as a JSON file with camera geometry,
+site coordinates, detection settings, photometric zeropoint, and fit quality
+metadata.
+
+## Transmission mapping
+
+Transmission is measured on an **absolute scale**: the photometric zeropoint
+from `instrument-fit` (clear sky) defines transmission = 1.0. Subsequent
+`solve` frames measure dimming relative to that reference.
+
+- Stars behind obstructions (domes, telescopes) are detected via
+  local-background contrast -- bright diffuse glow is distinguished from
+  point-source starlight
+- Unmatched catalog stars (bright, in-frame, but no detectable point source)
+  contribute zero transmission to the interpolation
+- If a solve frame has a *better* zeropoint than the model, a warning
+  suggests re-running `instrument-fit` with the clearer frame
+
+## Project structure
+
+```
+allclear/
+    __init__.py          # Package init
+    cli.py               # Command-line interface (instrument-fit, solve, check)
+    strategies.py        # Blind solve pipeline, pattern matching, guided refinement
+    solver.py            # Fast solve with known model (guided matching + pointing refinement)
+    instrument.py        # InstrumentModel dataclass + JSON persistence
+    projection.py        # Fisheye camera model (4 projection types, sky<->pixel)
+    catalog.py           # BrightStarCatalog (Hipparcos/BSC5, refraction, extinction)
+    detection.py         # Star detection (Background2D + DAOStarFinder)
+    matching.py          # KDTree 1-to-1 matching, triangle-hash blind matching
+    transmission.py      # Per-star photometry, RBF interpolation, TransmissionMap
+    plotting.py          # Annotated frame rendering, grid overlay, planets
+    synthetic.py         # Synthetic frame generation for testing
+    utils.py             # FITS I/O, coordinate math, extinction
+    data/                # Cached star catalog (ECSV)
+    tests/               # Test suite (32 tests)
+```
+
+## Development
+
+```bash
+git clone https://github.com/zgazak/allclear.git
+cd allclear
+uv sync                          # install with dev dependencies
+uv run pytest allclear/tests/ -v # run tests (32 tests)
+```
+
+## License
+
+See [LICENSE](LICENSE).

allclear-0.2.0/README.md

@@ -0,0 +1,157 @@
+# allclear
+
+![Tests](tests.svg) ![Coverage](coverage.svg)
+
+All-sky camera cloud detection via stellar transmission mapping.
+
+`allclear` takes FITS images from all-sky cameras, blind-solves the camera
+geometry by matching detected stars against a catalog, and produces
+full-hemisphere cloud transmission maps with annotated PNG output.
+
+|             Clear sky              |               Obscured sky               |
+| :--------------------------------: | :--------------------------------------: |
+| ![Clear sky](docs/clear_blink.gif) | ![Obscured sky](docs/obscured_blink.gif) |
+
+*Blink comparison: star identification (red circles = catalog, green crosshairs = matched) and transmission overlay (green = clear, red = cloudy).*
+
+## How it works
+
+1. **Detection** -- Background-subtracted star detection using DAOStarFinder
+2. **Catalog** -- Hipparcos/BSC5 bright star catalog (~9000 stars, V <= 6.5) projected to observer alt/az with atmospheric refraction and extinction
+3. **Blind solve** -- Hypothesis-and-verify pattern matching: for each bright (detection, catalog star) pair, hypothesize camera parameters, count matches. Best hypothesis seeds iterative refinement.
+4. **Camera model** -- Least-squares refinement of a fisheye camera model (center, focal length, boresight, roll, radial distortion) with automatic projection type selection
+5. **Guided matching** -- For each catalog star, project to pixel position and find the nearest bright peak. Sub-pixel centroiding. Avoids DAOStarFinder artifacts from domes/obstructions.
+6. **Transmission** -- Per-star photometric transmission from local-background-subtracted flux vs catalog magnitude, calibrated against a global clear-sky zeropoint. Unmatched catalog stars contribute zero transmission. Interpolated via RBF.
+
+## Installation
+
+```
+pip install allclear
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```
+uv add allclear
+uv sync
+```
+
+Requires Python >= 3.10. Dependencies: numpy, scipy, astropy, photutils, matplotlib.
+
+## Quick start
+
+### 1. Characterize camera geometry (one-time)
+
+```
+allclear instrument-fit \
+    --frames your_sky_image.fits \
+    --lat 20.7458 --lon -156.4317 \
+    --output instrument_model.json
+```
+
+This blind-solves the camera model and saves it as JSON, including a
+photometric zeropoint calibrated from the (presumably clear) input frame.
+Typically matches 400-550 stars at 2-3 pixel RMS.
+
+Supports FITS, JPG, PNG, and TIFF. For non-FITS images, provide the
+observation time with `--time`:
+
+```
+allclear instrument-fit \
+    --frames sky_photo.jpg \
+    --lat 20.7458 --lon -156.4317 \
+    --time "2024-01-15 03:30:00-10:00" \
+    --output instrument_model.json
+```
+
+### 2. Process frames with known model (fast)
+
+```
+allclear solve \
+    --frames "sky_images/*.fits" \
+    --model instrument_model.json
+```
+
+For each frame, produces:
+- `<stem>_solved.png` -- Annotated image with star matches (green crosshairs = matched, red circles = catalog)
+- `<stem>_transmission.png` -- Same image with RdYlGn transmission overlay (green = clear, red = cloudy/obstructed)
+- `<stem>_blink.gif` -- Animated blink between solved and transmission views
+
+Use `--no-plot` to suppress image output. Use `--output-dir <dir>` to write to a specific directory.
+
+### 3. Quick sky check
+
+```
+allclear check \
+    --frame sky_image.fits \
+    --model instrument_model.json \
+    --target-ra 83.63 --target-dec -5.39 --target-name "Orion Nebula"
+```
+
+Reports overall clear fraction and transmission at a specific sky position.
+
+## Camera model
+
+The fisheye projection model supports four lens types:
+
+| Type          | Formula               |
+| ------------- | --------------------- |
+| Equidistant   | r = f * theta         |
+| Equisolid     | r = 2f * sin(theta/2) |
+| Stereographic | r = 2f * tan(theta/2) |
+| Orthographic  | r = f * sin(theta)    |
+
+Parameters: optical center (cx, cy), boresight direction (az0, alt0),
+roll angle (rho), focal length (f), and radial distortion coefficients (k1, k2).
+
+The instrument model is saved as a JSON file with camera geometry,
+site coordinates, detection settings, photometric zeropoint, and fit quality
+metadata.
+
+## Transmission mapping
+
+Transmission is measured on an **absolute scale**: the photometric zeropoint
+from `instrument-fit` (clear sky) defines transmission = 1.0. Subsequent
+`solve` frames measure dimming relative to that reference.
+
+- Stars behind obstructions (domes, telescopes) are detected via
+  local-background contrast -- bright diffuse glow is distinguished from
+  point-source starlight
+- Unmatched catalog stars (bright, in-frame, but no detectable point source)
+  contribute zero transmission to the interpolation
+- If a solve frame has a *better* zeropoint than the model, a warning
+  suggests re-running `instrument-fit` with the clearer frame
+
+## Project structure
+
+```
+allclear/
+    __init__.py          # Package init
+    cli.py               # Command-line interface (instrument-fit, solve, check)
+    strategies.py        # Blind solve pipeline, pattern matching, guided refinement
+    solver.py            # Fast solve with known model (guided matching + pointing refinement)
+    instrument.py        # InstrumentModel dataclass + JSON persistence
+    projection.py        # Fisheye camera model (4 projection types, sky<->pixel)
+    catalog.py           # BrightStarCatalog (Hipparcos/BSC5, refraction, extinction)
+    detection.py         # Star detection (Background2D + DAOStarFinder)
+    matching.py          # KDTree 1-to-1 matching, triangle-hash blind matching
+    transmission.py      # Per-star photometry, RBF interpolation, TransmissionMap
+    plotting.py          # Annotated frame rendering, grid overlay, planets
+    synthetic.py         # Synthetic frame generation for testing
+    utils.py             # FITS I/O, coordinate math, extinction
+    data/                # Cached star catalog (ECSV)
+    tests/               # Test suite (32 tests)
+```
+
+## Development
+
+```bash
+git clone https://github.com/zgazak/allclear.git
+cd allclear
+uv sync                          # install with dev dependencies
+uv run pytest allclear/tests/ -v # run tests (32 tests)
+```
+
+## License
+
+See [LICENSE](LICENSE).

allclear-0.2.0/allclear/__init__.py

@@ -0,0 +1,3 @@
+"""AllClear — all-sky camera cloud detection via star matching."""
+
+__version__ = "0.2.0"