satchange 0.1.0__tar.gz

satchange-0.1.0/.gitignore

@@ -0,0 +1,49 @@
+# Secrets / credentials
+.env
+scripts/config/elevenlabs.txt
+scripts/config/ee-geodetic.json
+scripts/config/*.json
+scripts/config/*.txt
+*-service-account*.json
+
+# Raw satellite inputs (large / licensed) — keep the folder's README
+data/*
+!data/README.md
+
+# Generated change-detection result images (reproduce with detect.py)
+images/deforestation_*
+images/mining_*
+images/urbanization_*
+images/urban-trend_*
+images/flood_*
+images/burn_*
+images/water_*
+
+# Per-run change-detection outputs (detect.py writes output/<run-id>/)
+output/
+
+# Generated map products (reproduce with detect.py --map / make_map.py)
+maps/
+
+# Large binary outputs (regenerate with scripts)
+audio/
+scenes/
+*.mp4
+*.mp3
+
+# Temp files
+/tmp/
+*.pyc
+__pycache__/
+
+# macOS
+.DS_Store
+
+# Python packaging build artifacts
+build/
+dist/
+*.egg-info/
+.eggs/
+
+# API docs are generated in CI (pdoc) and deployed by the docs workflow
+docs/api/

satchange-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Firman Hadi
+
+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.

satchange-0.1.0/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: satchange
+Version: 0.1.0
+Summary: Multipurpose satellite change detection (deforestation, mining, urbanisation, floods, burns, water, urban growth) via Google Earth Engine or Microsoft Planetary Computer.
+Project-URL: Homepage, https://github.com/firmanhadi21/rs-change-detection
+Project-URL: Documentation, https://firmanhadi21.github.io/rs-change-detection/
+Project-URL: Repository, https://github.com/firmanhadi21/rs-change-detection
+Author-email: Firman Hadi <firmanhadi21@lecturer.undip.ac.id>
+Maintainer-email: Firman Hadi <firmanhadi21@lecturer.undip.ac.id>
+License: MIT
+License-File: LICENSE
+Keywords: change-detection,deforestation,earth-engine,flood,geospatial,gis,landsat,ndbi,ndvi,planetary-computer,remote-sensing,sentinel
+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.11
+Classifier: Topic :: Scientific/Engineering :: GIS
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Requires-Python: >=3.11
+Requires-Dist: requests
+Provides-Extra: all
+Requires-Dist: contextily; extra == 'all'
+Requires-Dist: earthengine-api; extra == 'all'
+Requires-Dist: matplotlib; extra == 'all'
+Requires-Dist: numpy; extra == 'all'
+Requires-Dist: odc-stac; extra == 'all'
+Requires-Dist: planetary-computer; extra == 'all'
+Requires-Dist: pystac-client; extra == 'all'
+Requires-Dist: rasterio; extra == 'all'
+Requires-Dist: rioxarray; extra == 'all'
+Provides-Extra: gee
+Requires-Dist: earthengine-api; extra == 'gee'
+Provides-Extra: maps
+Requires-Dist: contextily; extra == 'maps'
+Requires-Dist: matplotlib; extra == 'maps'
+Requires-Dist: numpy; extra == 'maps'
+Requires-Dist: rasterio; extra == 'maps'
+Provides-Extra: mpc
+Requires-Dist: numpy; extra == 'mpc'
+Requires-Dist: odc-stac; extra == 'mpc'
+Requires-Dist: planetary-computer; extra == 'mpc'
+Requires-Dist: pystac-client; extra == 'mpc'
+Requires-Dist: rasterio; extra == 'mpc'
+Requires-Dist: rioxarray; extra == 'mpc'
+Description-Content-Type: text/markdown
+
+# satchange
+
+**Multipurpose satellite change detection in pure Python.** Map deforestation,
+mining, urbanisation, floods, burns, surface-water change and multi-epoch urban
+growth anywhere on Earth from free Sentinel-1/2 and Landsat data — via **Google
+Earth Engine** or **Microsoft Planetary Computer** (no account needed). Export
+georeferenced GeoTIFFs, quick-look PNGs, statistics, and print-ready A4 maps.
+
+- 📖 **Full hands-on tutorial (English & Bahasa Indonesia):** <https://firmanhadi21.github.io/rs-change-detection/>
+- 💻 **Source, examples & case study:** <https://github.com/firmanhadi21/rs-change-detection>
+
+## Install
+
+Heavy dependencies are optional *extras*, so the install stays lean:
+
+```bash
+pip install 'satchange[gee]'       # Google Earth Engine backend (free account)
+pip install 'satchange[mpc,maps]'  # Planetary Computer + maps (no account)
+pip install 'satchange[all]'       # everything
+```
+
+## Quick start
+
+```bash
+# Deforestation around a coordinate, with a finished map
+satchange -s deforestation --lat -3.333 --lon 122.25 --radius 6 --map
+
+# Flood extent from Sentinel-1 SAR — no Earth Engine account needed
+satchange -s flood --lat 27.2 --lon 68.3 \
+    --pre 2022-07-01:2022-07-25 --post 2022-08-20:2022-09-10 --backend mpc
+
+# Urban growth timing across 2010/2015/2020 (Landsat 5/8/9)
+satchange -s urban-trend --lat -6.30 --lon 107.15 --map
+
+# List everything
+satchange --list
+```
+
+Each run writes a self-contained `output/<run-id>/` folder containing the PNG,
+GeoTIFF, statistics JSON, metadata, and any maps.
+
+## Scenarios
+
+| Scenario | Method | Sensor |
+|----------|--------|--------|
+| `deforestation` | NDVI loss | Sentinel-2 |
+| `urbanization` | Built-up gain — `NDBI` (default), `UI`, `BU`, `IBI`, or thermal `NDISI`/`EBBI` via `--method` | Sentinel-2 / Landsat |
+| `water` | NDWI change | Sentinel-2 |
+| `burn` | dNBR severity | Sentinel-2 |
+| `mining` | SIRAD radar temporal + NDVI loss | Sentinel-1 + S2 |
+| `flood` | SAR water extent (event vs baseline) | Sentinel-1 |
+| `urban-trend` | NDBI at 3 epochs → RGB growth-timing map | Landsat 5/8/9 |
+
+## Two backends
+
+| `--backend` | Data source | Account? |
+|-------------|-------------|----------|
+| `gee` (default) | Google Earth Engine | free account + `earthengine authenticate` |
+| `mpc` | Microsoft Planetary Computer (STAC) | **none** — streams COGs, processes locally |
+
+Optical scenarios build cloud-masked median composites; radar scenarios
+auto-select the Sentinel-1 orbit with coverage. The AOI is a square centred on
+your coordinate. Landsat 7 is skipped (SLC-off gaps).
+
+## Make maps from a finished run
+
+```bash
+satmap output/<run-id>            # render A4 map sheets offline (no GEE)
+```
+
+Map sheets include an OpenStreetMap basemap, the change layer, legend, a
+statistics panel, a location inset, coordinate grid, scale bar and north arrow.
+
+## License
+
+MIT © Firman Hadi. Data: Copernicus Sentinel (ESA) and Landsat (USGS/NASA),
+via Google Earth Engine or Microsoft Planetary Computer.

satchange-0.1.0/PUBLISHING.md

@@ -0,0 +1,79 @@
+# Publishing `satchange` to PyPI
+
+The package lives in [`satchange/`](satchange/) and is configured by
+[`pyproject.toml`](pyproject.toml). These steps build and upload it. **Nothing
+here uploads automatically** — you run the final step with your own PyPI token.
+
+## 0. One-time prerequisites
+
+```bash
+pip install --upgrade build twine
+```
+
+- Create accounts on **[TestPyPI](https://test.pypi.org/)** and **[PyPI](https://pypi.org/)**.
+- Create an **API token** for each (Account → API tokens). You'll paste it as the
+  password with username `__token__`.
+- **Check the name is free:** https://pypi.org/project/satchange/ must 404.
+  If taken, change `name = "..."` in `pyproject.toml` (the import package
+  `satchange/` can keep its name, but the PyPI distribution name must be unique).
+
+## 1. Build the distributions
+
+```bash
+python -m build          # writes dist/satchange-0.1.0.tar.gz and .whl
+python -m twine check dist/*
+```
+
+## 2. Test on TestPyPI first
+
+```bash
+python -m twine upload --repository testpypi dist/*
+# then try installing it in a clean venv:
+pip install --index-url https://test.pypi.org/simple/ \
+  --extra-index-url https://pypi.org/simple 'satchange[all]'
+satchange --list
+```
+
+## 3. Upload to the real PyPI
+
+```bash
+python -m twine upload dist/*
+```
+
+Then anyone can:
+
+```bash
+pip install 'satchange[gee]'      # Earth Engine backend
+pip install 'satchange[mpc,maps]' # Planetary Computer + maps, no GEE account
+pip install 'satchange[all]'      # everything
+satchange -s deforestation --lat -3.333 --lon 122.25 --map
+```
+
+## Cutting a new version
+
+1. Bump `version` in `pyproject.toml` (PyPI versions are immutable — you can't
+   re-upload the same one).
+2. Rebuild (`rm -rf dist && python -m build`) and re-upload.
+3. Tag the release: `git tag v0.1.0 && git push --tags`.
+
+## Regenerating the API docs
+
+The API reference under `docs/api/` is generated from the docstrings with
+[pdoc](https://pdoc.dev) and served by GitHub Pages at `…/rs-change-detection/api/`.
+Rebuild it after changing public functions/docstrings:
+
+```bash
+pip install pdoc
+pdoc satchange -o docs/api      # needs the package importable (pip install -e .)
+git add docs/api && git commit -m "docs: regenerate API reference"
+```
+
+## Notes
+
+- **Extras** keep the install lean: core is tiny (`requests`); `gee`, `mpc`,
+  `maps` pull only what that path needs.
+- The Capkala investigation (`data-collection/`, `scripts/`, `narration/`,
+  `images/`) is **not** shipped in the wheel — only the `satchange/` package is.
+- Outputs are written to `./output/<run-id>/` in the current directory, and the
+  GEE service-account key (if used) is read from `./scripts/config/ee-geodetic.json`
+  or `~/.config/earthengine/` — never bundled.

satchange-0.1.0/PYPI_README.md

@@ -0,0 +1,77 @@
+# satchange
+
+**Multipurpose satellite change detection in pure Python.** Map deforestation,
+mining, urbanisation, floods, burns, surface-water change and multi-epoch urban
+growth anywhere on Earth from free Sentinel-1/2 and Landsat data — via **Google
+Earth Engine** or **Microsoft Planetary Computer** (no account needed). Export
+georeferenced GeoTIFFs, quick-look PNGs, statistics, and print-ready A4 maps.
+
+- 📖 **Full hands-on tutorial (English & Bahasa Indonesia):** <https://firmanhadi21.github.io/rs-change-detection/>
+- 💻 **Source, examples & case study:** <https://github.com/firmanhadi21/rs-change-detection>
+
+## Install
+
+Heavy dependencies are optional *extras*, so the install stays lean:
+
+```bash
+pip install 'satchange[gee]'       # Google Earth Engine backend (free account)
+pip install 'satchange[mpc,maps]'  # Planetary Computer + maps (no account)
+pip install 'satchange[all]'       # everything
+```
+
+## Quick start
+
+```bash
+# Deforestation around a coordinate, with a finished map
+satchange -s deforestation --lat -3.333 --lon 122.25 --radius 6 --map
+
+# Flood extent from Sentinel-1 SAR — no Earth Engine account needed
+satchange -s flood --lat 27.2 --lon 68.3 \
+    --pre 2022-07-01:2022-07-25 --post 2022-08-20:2022-09-10 --backend mpc
+
+# Urban growth timing across 2010/2015/2020 (Landsat 5/8/9)
+satchange -s urban-trend --lat -6.30 --lon 107.15 --map
+
+# List everything
+satchange --list
+```
+
+Each run writes a self-contained `output/<run-id>/` folder containing the PNG,
+GeoTIFF, statistics JSON, metadata, and any maps.
+
+## Scenarios
+
+| Scenario | Method | Sensor |
+|----------|--------|--------|
+| `deforestation` | NDVI loss | Sentinel-2 |
+| `urbanization` | Built-up gain — `NDBI` (default), `UI`, `BU`, `IBI`, or thermal `NDISI`/`EBBI` via `--method` | Sentinel-2 / Landsat |
+| `water` | NDWI change | Sentinel-2 |
+| `burn` | dNBR severity | Sentinel-2 |
+| `mining` | SIRAD radar temporal + NDVI loss | Sentinel-1 + S2 |
+| `flood` | SAR water extent (event vs baseline) | Sentinel-1 |
+| `urban-trend` | NDBI at 3 epochs → RGB growth-timing map | Landsat 5/8/9 |
+
+## Two backends
+
+| `--backend` | Data source | Account? |
+|-------------|-------------|----------|
+| `gee` (default) | Google Earth Engine | free account + `earthengine authenticate` |
+| `mpc` | Microsoft Planetary Computer (STAC) | **none** — streams COGs, processes locally |
+
+Optical scenarios build cloud-masked median composites; radar scenarios
+auto-select the Sentinel-1 orbit with coverage. The AOI is a square centred on
+your coordinate. Landsat 7 is skipped (SLC-off gaps).
+
+## Make maps from a finished run
+
+```bash
+satmap output/<run-id>            # render A4 map sheets offline (no GEE)
+```
+
+Map sheets include an OpenStreetMap basemap, the change layer, legend, a
+statistics panel, a location inset, coordinate grid, scale bar and north arrow.
+
+## License
+
+MIT © Firman Hadi. Data: Copernicus Sentinel (ESA) and Landsat (USGS/NASA),
+via Google Earth Engine or Microsoft Planetary Computer.