gee-acolite 1.0.0__tar.gz

gee_acolite-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+GNU GENERAL PUBLIC LICENSE
+Version 3, 29 June 2007
+
+Copyright (C) 2025 Sergio
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+---
+
+Full GPL 3.0 License Text: https://www.gnu.org/licenses/gpl-3.0.txt

gee_acolite-1.0.0/PKG-INFO

@@ -0,0 +1,161 @@
+Metadata-Version: 2.4
+Name: gee_acolite
+Version: 1.0.0
+Summary: ACOLITE atmospheric correction for Google Earth Engine
+Home-page: https://github.com/Aouei/gee_acolite
+Author: Sergio
+Author-email: Aouei <sergiohercar1@gmail.com>
+License: GPL-3.0
+Project-URL: Homepage, https://github.com/Aouei/gee_acolite
+Project-URL: Documentation, https://github.com/Aouei/gee_acolite
+Project-URL: Repository, https://github.com/Aouei/gee_acolite
+Project-URL: Bug Tracker, https://github.com/Aouei/gee_acolite/issues
+Keywords: earth-engine,atmospheric-correction,acolite,sentinel-2,remote-sensing,water-quality
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: GIS
+Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: earthengine-api>=0.1.350
+Requires-Dist: numpy>=1.20.0
+Requires-Dist: scipy>=1.7.0
+Requires-Dist: netcdf4>=1.7.0
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# GEE ACOLITE
+
+ACOLITE atmospheric correction implementation for Google Earth Engine (GEE).
+
+## Description
+
+This package provides atmospheric correction for Sentinel-2 imagery using the ACOLITE dark spectrum fitting method, optimized for Google Earth Engine workflows. It includes:
+
+- **Dark Spectrum Fitting**: Multiple methods (darkest, percentile, intercept)
+- **AOT Estimation**: Fixed geometry mode
+- **Atmospheric Correction**: Full LUT-based correction
+- **Water Quality Parameters**: SPM, turbidity, chlorophyll, bathymetry indices
+- **Cloud Masking**: Integration with Sentinel-2 Cloud Probability
+
+## Installation
+
+### From PyPI (when published)
+
+```bash
+pip install gee_acolite
+```
+
+### From source
+
+```bash
+git clone https://github.com/Aouei/gee_acolite.git
+cd gee_acolite
+pip install -e .
+```
+
+## Features
+
+### Atmospheric Correction Methods
+
+- **Fixed Geometry**: Single AOT estimation for entire image
+- **Dark Spectrum Options**:
+  - `darkest`: Use minimum values
+  - `percentile`: Use Nth percentile
+  - `intercept`: Linear regression intercept
+
+### Model Selection Criteria
+
+- `min_drmsd`: Minimum RMSD between observed and modeled reflectance
+- `min_dtau`: Minimum delta AOT between darkest bands
+- `taua_cv`: Minimum coefficient of variation
+
+### Water Quality Products
+
+- **SPM**: Suspended particulate matter (Nechad 2016)
+- **Turbidity**: Water turbidity (Nechad 2016)
+- **Chlorophyll**: Chl-a concentration (OC2, OC3, Mishra)
+- **Bathymetry**: Pseudo satellite-derived bathymetry (pSDB)
+- **Indices**: NDWI, custom band ratios
+
+## Requirements
+
+- Python ≥ 3.8
+- earthengine-api ≥ 0.1.350
+- numpy ≥ 1.20.0
+- scipy ≥ 1.7.0
+- **ACOLITE** (standalone installation required)
+
+### Installing ACOLITE
+
+This package requires the ACOLITE atmospheric correction software to be installed separately:
+
+```bash
+# Clone ACOLITE repository
+git clone https://github.com/acolite/acolite.git
+
+# Install ACOLITE
+cd acolite
+pip install -e .
+```
+
+**Important:** ACOLITE is not available on PyPI and must be installed from source.
+
+## Contributing
+
+Contributions are welcome! Please:
+
+1. Fork the repository
+2. Create a feature branch
+3. Add tests for new features
+4. Submit a pull request
+
+## License
+
+This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
+
+## Citation
+
+If you use this package in your research, please cite:
+
+```bibtex
+@software{gee_acolite,
+  author = {Sergio},
+  title = {GEE ACOLITE: Atmospheric Correction for Google Earth Engine},
+  year = {2025},
+  url = {https://github.com/Aouei/gee_acolite}
+}
+```
+
+And the original ACOLITE paper:
+
+```bibtex
+@article{vanhellemont2019,
+  title={Adaptation of the dark spectrum fitting atmospheric correction for aquatic applications of the Landsat and Sentinel-2 archives},
+  author={Vanhellemont, Quinten and Ruddick, Kevin},
+  journal={Remote Sensing of Environment},
+  volume={225},
+  pages={175--192},
+  year={2019},
+  publisher={Elsevier}
+}
+```
+
+## Acknowledgments
+
+This package is based on the ACOLITE software developed by RBINS (Royal Belgian Institute of Natural Sciences).
+
+## Contact
+
+- GitHub: [@Aouei](https://github.com/Aouei)
+- Email: sergiohercar1@gmail.com

gee_acolite-1.0.0/README.md

@@ -0,0 +1,125 @@
+# GEE ACOLITE
+
+ACOLITE atmospheric correction implementation for Google Earth Engine (GEE).
+
+## Description
+
+This package provides atmospheric correction for Sentinel-2 imagery using the ACOLITE dark spectrum fitting method, optimized for Google Earth Engine workflows. It includes:
+
+- **Dark Spectrum Fitting**: Multiple methods (darkest, percentile, intercept)
+- **AOT Estimation**: Fixed geometry mode
+- **Atmospheric Correction**: Full LUT-based correction
+- **Water Quality Parameters**: SPM, turbidity, chlorophyll, bathymetry indices
+- **Cloud Masking**: Integration with Sentinel-2 Cloud Probability
+
+## Installation
+
+### From PyPI (when published)
+
+```bash
+pip install gee_acolite
+```
+
+### From source
+
+```bash
+git clone https://github.com/Aouei/gee_acolite.git
+cd gee_acolite
+pip install -e .
+```
+
+## Features
+
+### Atmospheric Correction Methods
+
+- **Fixed Geometry**: Single AOT estimation for entire image
+- **Dark Spectrum Options**:
+  - `darkest`: Use minimum values
+  - `percentile`: Use Nth percentile
+  - `intercept`: Linear regression intercept
+
+### Model Selection Criteria
+
+- `min_drmsd`: Minimum RMSD between observed and modeled reflectance
+- `min_dtau`: Minimum delta AOT between darkest bands
+- `taua_cv`: Minimum coefficient of variation
+
+### Water Quality Products
+
+- **SPM**: Suspended particulate matter (Nechad 2016)
+- **Turbidity**: Water turbidity (Nechad 2016)
+- **Chlorophyll**: Chl-a concentration (OC2, OC3, Mishra)
+- **Bathymetry**: Pseudo satellite-derived bathymetry (pSDB)
+- **Indices**: NDWI, custom band ratios
+
+## Requirements
+
+- Python ≥ 3.8
+- earthengine-api ≥ 0.1.350
+- numpy ≥ 1.20.0
+- scipy ≥ 1.7.0
+- **ACOLITE** (standalone installation required)
+
+### Installing ACOLITE
+
+This package requires the ACOLITE atmospheric correction software to be installed separately:
+
+```bash
+# Clone ACOLITE repository
+git clone https://github.com/acolite/acolite.git
+
+# Install ACOLITE
+cd acolite
+pip install -e .
+```
+
+**Important:** ACOLITE is not available on PyPI and must be installed from source.
+
+## Contributing
+
+Contributions are welcome! Please:
+
+1. Fork the repository
+2. Create a feature branch
+3. Add tests for new features
+4. Submit a pull request
+
+## License
+
+This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
+
+## Citation
+
+If you use this package in your research, please cite:
+
+```bibtex
+@software{gee_acolite,
+  author = {Sergio},
+  title = {GEE ACOLITE: Atmospheric Correction for Google Earth Engine},
+  year = {2025},
+  url = {https://github.com/Aouei/gee_acolite}
+}
+```
+
+And the original ACOLITE paper:
+
+```bibtex
+@article{vanhellemont2019,
+  title={Adaptation of the dark spectrum fitting atmospheric correction for aquatic applications of the Landsat and Sentinel-2 archives},
+  author={Vanhellemont, Quinten and Ruddick, Kevin},
+  journal={Remote Sensing of Environment},
+  volume={225},
+  pages={175--192},
+  year={2019},
+  publisher={Elsevier}
+}
+```
+
+## Acknowledgments
+
+This package is based on the ACOLITE software developed by RBINS (Royal Belgian Institute of Natural Sciences).
+
+## Contact
+
+- GitHub: [@Aouei](https://github.com/Aouei)
+- Email: sergiohercar1@gmail.com

gee_acolite-1.0.0/gee_acolite/__init__.py

@@ -0,0 +1,49 @@
+"""
+GEE ACOLITE - Atmospheric correction for Google Earth Engine
+
+This package provides ACOLITE atmospheric correction optimized for 
+Google Earth Engine workflows with Sentinel-2 imagery.
+
+Main Features:
+- Dark spectrum fitting atmospheric correction
+- AOT estimation (fixed geometry)
+- Water quality parameter computation
+- Cloud masking integration
+
+Note: Requires ACOLITE package to be installed separately.
+Install from: https://github.com/acolite/acolite
+"""
+
+__version__ = "0.1.0"
+__author__ = "Sergio"
+__license__ = "GPL-3.0"
+
+# Main atmospheric correction class
+from gee_acolite.correction import ACOLITE
+
+# Bathymetry utilities
+from gee_acolite.bathymetry import multi_image
+
+# Water quality parameters
+from gee_acolite.water_quality import (
+    compute_water_bands,
+    compute_water_mask,
+    PRODUCTS
+)
+
+# Utility modules
+from gee_acolite import utils, sensors
+
+__all__ = [
+    # Main class
+    "ACOLITE",
+    # Bathymetry
+    "multi_image",
+    # Water quality
+    "compute_water_bands",
+    "compute_water_mask",
+    "PRODUCTS",
+    # Modules
+    "utils",
+    "sensors",
+]

gee_acolite-1.0.0/gee_acolite/bathymetry.py

@@ -0,0 +1,4 @@
+import ee
+
+def multi_image(images: ee.ImageCollection, band: str = 'pSDB_green') -> ee.Image:
+    return images.qualityMosaic(band)