RadGEEToolbox 1.6.0__tar.gz → 1.6.2__tar.gz

radgeetoolbox-1.6.2/PKG-INFO

@@ -0,0 +1,194 @@
+Metadata-Version: 2.4
+Name: RadGEEToolbox
+Version: 1.6.2
+Summary: Streamlined Multispectral & SAR Analysis for Google Earth Engine Python API
+Home-page: https://github.com/radwinskis/RadGEEToolbox
+Author: Mark Radwin
+Author-email: Mark Radwin <markradwin@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/radwinskis/RadGEEToolbox
+Project-URL: Documentation, https://radgeetoolbox.readthedocs.io/en/latest/
+Project-URL: Issues, https://github.com/radwinskis/RadGEEToolbox/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: GIS
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: earthengine-api
+Requires-Dist: numpy
+Requires-Dist: pandas
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+[![PyPI version](https://badge.fury.io/py/RadGEEToolbox.svg)](https://pypi.org/project/RadGEEToolbox/)
+
+# RadGEEToolbox 🛠
+
+![](image-1.png)
+
+### 🌎 Streamlined Multispectral & SAR Analysis for Google Earth Engine Python API
+
+### [See documentation here](https://radgeetoolbox.readthedocs.io/en/latest/)
+
+**RadGEEToolbox** is an open-source Python package that simplifies the processing and analysis of satellite imagery using the Google Earth Engine Python API. It provides ready-to-use tools for filtering, masking, mosaicking, spectral index calculations, and extracting statistics from multispectral (Landsat, Sentinel-2) and SAR (Sentinel-1) datasets.
+
+Designed for both new and advanced users of Google Earth Engine, RadGEEToolbox minimizes repetitive scripting, accelerates common remote sensing workflows, and aims to maximize efficiency within the constraints of the Google Earth Engine API. Whether you’re building a time series of vegetation indices or extracting surface properties along transects, this package helps get results faster.
+
+_________
+
+## Key Features
+
+- Modular tools for processing **Landsat, Sentinel-1 SAR, and Sentinel-2** imagery
+- Efficient filtering, masking, and mosaicking of Earth Engine image collections
+- Built-in support for computing **spectral indices** (NDWI, NDVI, LST, turbidity, chlorophyll, etc.)
+- SAR utilities for **multilooking**, **speckle filtering**, and **backscatter conversion**
+- Automated extraction of **transect and zonal statistics** across image collections
+- Easy conversion between RadGEEToolbox and standard Earth Engine objects
+- Server-side–friendly workflows and caching for faster, scalable processing
+
+🔍 For a full breakdown of available tools, see the [RadGEEToolbox documentation »](https://radgeetoolbox.readthedocs.io/en/latest/)
+
+_____________
+
+## Installation Instructions
+
+### Prerequisites
+
+- **Python**: Ensure you have version 3.6 or higher installed.
+- **pip**: This is Python's package installer. 
+- **conda-forge**: Community led Conda package installer channel
+
+### Installing via pip
+
+To install `RadGEEToolbox` version 1.6.2 using pip (NOTE: it is recommended to create a new virtual environment):
+
+```bash
+pip install RadGEEToolbox==1.6.2
+```
+
+### Installing via Conda
+
+To install `RadGEEToolbox` version 1.6.2 using conda-forge (NOTE: it is recommended to create a new virtual environment):
+
+```bash
+conda install conda-forge::radgeetoolbox
+```
+
+### Manual Installation from Source
+
+1. **Clone the Repository**: 
+   ```bash
+   git clone https://github.com/radwinskis/RadGEEToolbox.git
+   ```
+
+2. **Navigate to Directory**: 
+   ```bash
+   cd RadGEEToolbox
+   ```
+
+3. **Install the Package**:
+   ```bash
+   pip install .
+   ```
+
+### ✅ Verifying the Installation
+
+To verify that `RadGEEToolbox` was installed correctly:
+
+```python
+python -c "import RadGEEToolbox; print(RadGEEToolbox.__version__)"
+```
+
+You should see `1.6.2` printed as the version number.
+
+________
+# Usage Example
+
+Below is an example use case using the `LandsatCollection` module to create an NDWI image collection, create water classification maps, and create a time series of water area.
+
+### 1. Create a Filtered Landsat Image Collection
+
+```python
+# 1. Import necessary packages and modules
+import ee
+from RadGEEToolbox import LandsatCollection
+
+# 2. Authenticate & Initialize GEE API
+ee.Authenticate()
+ee.Initialize()
+
+# 3. Define study area boundary - in this case Lake Powell, Utah
+study_area = ee.Geometry.Polygon(
+        [[[-111.35875055487008, 37.19999663127137],
+          [-111.35875055487008, 37.00119876939416],
+          [-111.12048456365915, 37.00119876939416],
+          [-111.12048456365915, 37.19999663127137]]])
+
+# 3. Create a Landsat image collection for a given time range and study area
+# includes filtering imagery based on areal percentage of cloud cover
+# WRS-2 tile(s) can also be used for filtering instead of an ROI geometry
+collection = LandsatCollection(
+    start_date='2020-01-01', #date formats of 'YYYY-MM-DD'
+    end_date='2025-01-01',
+    cloud_percentage_threshold=10, #filtering to <10% cloud coverage
+    boundary=study_area #ee.Geometry() of your study area
+    )
+
+# 4. Check collection by printing the dates of all images in the collection
+dates = collection.dates 
+print(dates)
+```
+### 2. Apply a Cloud Mask and Compute NDWI
+```python
+# 1. Mask clouds 
+cloud_masked_collection = collection.masked_clouds_collection
+# 2. Create a collection of singleband NDWI images with band names of 'ndwi'
+cloud_masked_NDWI_collection = cloud_masked_collection.ndwi
+# BONUS - 3. Create water classification maps using a user-set binary NDWI threshold
+water_classification_maps = cloud_masked_collection.ndwi_collection(
+      threshold=0
+      )
+```
+![Visualization of true color and classified water (in blue) from one of the dates in the collection](image-3.png)
+
+Visualization of true color and classified water (in blue) from one of the dates in the collection
+
+### 3. Calculate Water Area Time Series
+```python
+calculate_water_area = cloud_masked_NDWI_collection.PixelAreaSumCollection(
+      band_name='ndwi', #specify band to use from collection
+      geometry=study_area), #ee.Geometry() of your study area
+      threshold=0, #binary classification threshold for unclassified rasters,
+      scale=90 #pixel size for zonal statistics
+      )
+water_area_time_series = calculate_water_area.aggregate_array('ndwi').getInfo()
+print('List of square meters of water in images:', water_area_time_series)
+```
+
+![Plotted Results from Above Example - All Processed in Less Than 5 Seconds!](image-4.png)
+
+Plotted Results from Above Example - All Processed in Less Than 5 Seconds!
+
+For details about Sentinel-1 SAR and Sentinel-2 MSI modules, and all other available Landsat or cross-module functions, please refer to the [RadGEEToolbox documentation](https://radgeetoolbox.readthedocs.io/en/latest/). You can also explore [`/Example Notebooks`](https://github.com/radwinskis/RadGEEToolbox/tree/main/Example%20Notebooks) for more usage examples.
+
+________
+
+
+## Contributing
+
+Contributions are welcome! If you’d like to suggest a feature, report a bug, or contribute code or documentation, please visit the [GitHub Issues](https://github.com/radwinskis/RadGEEToolbox/issues) page to get started or view the `CONTRIBUTING.md` file in the main directory.
+
+____ 
+
+## License
+
+RadGEEToolbox is released under the MIT License.
+
+

radgeetoolbox-1.6.2/README.md

@@ -0,0 +1,165 @@
+[![PyPI version](https://badge.fury.io/py/RadGEEToolbox.svg)](https://pypi.org/project/RadGEEToolbox/)
+
+# RadGEEToolbox 🛠
+
+![](image-1.png)
+
+### 🌎 Streamlined Multispectral & SAR Analysis for Google Earth Engine Python API
+
+### [See documentation here](https://radgeetoolbox.readthedocs.io/en/latest/)
+
+**RadGEEToolbox** is an open-source Python package that simplifies the processing and analysis of satellite imagery using the Google Earth Engine Python API. It provides ready-to-use tools for filtering, masking, mosaicking, spectral index calculations, and extracting statistics from multispectral (Landsat, Sentinel-2) and SAR (Sentinel-1) datasets.
+
+Designed for both new and advanced users of Google Earth Engine, RadGEEToolbox minimizes repetitive scripting, accelerates common remote sensing workflows, and aims to maximize efficiency within the constraints of the Google Earth Engine API. Whether you’re building a time series of vegetation indices or extracting surface properties along transects, this package helps get results faster.
+
+_________
+
+## Key Features
+
+- Modular tools for processing **Landsat, Sentinel-1 SAR, and Sentinel-2** imagery
+- Efficient filtering, masking, and mosaicking of Earth Engine image collections
+- Built-in support for computing **spectral indices** (NDWI, NDVI, LST, turbidity, chlorophyll, etc.)
+- SAR utilities for **multilooking**, **speckle filtering**, and **backscatter conversion**
+- Automated extraction of **transect and zonal statistics** across image collections
+- Easy conversion between RadGEEToolbox and standard Earth Engine objects
+- Server-side–friendly workflows and caching for faster, scalable processing
+
+🔍 For a full breakdown of available tools, see the [RadGEEToolbox documentation »](https://radgeetoolbox.readthedocs.io/en/latest/)
+
+_____________
+
+## Installation Instructions
+
+### Prerequisites
+
+- **Python**: Ensure you have version 3.6 or higher installed.
+- **pip**: This is Python's package installer. 
+- **conda-forge**: Community led Conda package installer channel
+
+### Installing via pip
+
+To install `RadGEEToolbox` version 1.6.2 using pip (NOTE: it is recommended to create a new virtual environment):
+
+```bash
+pip install RadGEEToolbox==1.6.2
+```
+
+### Installing via Conda
+
+To install `RadGEEToolbox` version 1.6.2 using conda-forge (NOTE: it is recommended to create a new virtual environment):
+
+```bash
+conda install conda-forge::radgeetoolbox
+```
+
+### Manual Installation from Source
+
+1. **Clone the Repository**: 
+   ```bash
+   git clone https://github.com/radwinskis/RadGEEToolbox.git
+   ```
+
+2. **Navigate to Directory**: 
+   ```bash
+   cd RadGEEToolbox
+   ```
+
+3. **Install the Package**:
+   ```bash
+   pip install .
+   ```
+
+### ✅ Verifying the Installation
+
+To verify that `RadGEEToolbox` was installed correctly:
+
+```python
+python -c "import RadGEEToolbox; print(RadGEEToolbox.__version__)"
+```
+
+You should see `1.6.2` printed as the version number.
+
+________
+# Usage Example
+
+Below is an example use case using the `LandsatCollection` module to create an NDWI image collection, create water classification maps, and create a time series of water area.
+
+### 1. Create a Filtered Landsat Image Collection
+
+```python
+# 1. Import necessary packages and modules
+import ee
+from RadGEEToolbox import LandsatCollection
+
+# 2. Authenticate & Initialize GEE API
+ee.Authenticate()
+ee.Initialize()
+
+# 3. Define study area boundary - in this case Lake Powell, Utah
+study_area = ee.Geometry.Polygon(
+        [[[-111.35875055487008, 37.19999663127137],
+          [-111.35875055487008, 37.00119876939416],
+          [-111.12048456365915, 37.00119876939416],
+          [-111.12048456365915, 37.19999663127137]]])
+
+# 3. Create a Landsat image collection for a given time range and study area
+# includes filtering imagery based on areal percentage of cloud cover
+# WRS-2 tile(s) can also be used for filtering instead of an ROI geometry
+collection = LandsatCollection(
+    start_date='2020-01-01', #date formats of 'YYYY-MM-DD'
+    end_date='2025-01-01',
+    cloud_percentage_threshold=10, #filtering to <10% cloud coverage
+    boundary=study_area #ee.Geometry() of your study area
+    )
+
+# 4. Check collection by printing the dates of all images in the collection
+dates = collection.dates 
+print(dates)
+```
+### 2. Apply a Cloud Mask and Compute NDWI
+```python
+# 1. Mask clouds 
+cloud_masked_collection = collection.masked_clouds_collection
+# 2. Create a collection of singleband NDWI images with band names of 'ndwi'
+cloud_masked_NDWI_collection = cloud_masked_collection.ndwi
+# BONUS - 3. Create water classification maps using a user-set binary NDWI threshold
+water_classification_maps = cloud_masked_collection.ndwi_collection(
+      threshold=0
+      )
+```
+![Visualization of true color and classified water (in blue) from one of the dates in the collection](image-3.png)
+
+Visualization of true color and classified water (in blue) from one of the dates in the collection
+
+### 3. Calculate Water Area Time Series
+```python
+calculate_water_area = cloud_masked_NDWI_collection.PixelAreaSumCollection(
+      band_name='ndwi', #specify band to use from collection
+      geometry=study_area), #ee.Geometry() of your study area
+      threshold=0, #binary classification threshold for unclassified rasters,
+      scale=90 #pixel size for zonal statistics
+      )
+water_area_time_series = calculate_water_area.aggregate_array('ndwi').getInfo()
+print('List of square meters of water in images:', water_area_time_series)
+```
+
+![Plotted Results from Above Example - All Processed in Less Than 5 Seconds!](image-4.png)
+
+Plotted Results from Above Example - All Processed in Less Than 5 Seconds!
+
+For details about Sentinel-1 SAR and Sentinel-2 MSI modules, and all other available Landsat or cross-module functions, please refer to the [RadGEEToolbox documentation](https://radgeetoolbox.readthedocs.io/en/latest/). You can also explore [`/Example Notebooks`](https://github.com/radwinskis/RadGEEToolbox/tree/main/Example%20Notebooks) for more usage examples.
+
+________
+
+
+## Contributing
+
+Contributions are welcome! If you’d like to suggest a feature, report a bug, or contribute code or documentation, please visit the [GitHub Issues](https://github.com/radwinskis/RadGEEToolbox/issues) page to get started or view the `CONTRIBUTING.md` file in the main directory.
+
+____ 
+
+## License
+
+RadGEEToolbox is released under the MIT License.
+
+

{radgeetoolbox-1.6.0 → radgeetoolbox-1.6.2}/RadGEEToolbox/CollectionStitch.py

@@ -6,12 +6,12 @@ def CollectionStitch(img_col1, img_col2, copy_properties_from=1):
     Returned image collection is an eeImageCollection object. NOTE this is different from the CollectionStitch function available in the LandsatCollection and SentinelCollection classes.
 
     Args:
-    img_col2: primary LandsatCollection image collection to be mosaiced with the secondary image collection
-    img_col2: secondary LandsatCollection image collection to be mosaiced with the primary image collection
-    copy_properties_from: image collection used for copying image properties
+        img_col1 (RadGEEToolbox object): primary RadGEEToolbox image collection to be mosaiced with the secondary image collection
+        img_col2 (RadGEEToolbox object): secondary RadGEEToolbox image collection to be mosaiced with the primary image collection
+        copy_properties_from (int): image collection used for copying image properties, options of 1 or 2 for primary or secondary respectively. Default is 1.
 
     Returns:
-    image collection: eeImageCollection image collection with mosaiced imagery and image properties from chosen collection
+        ee.ImageCollection: ee.ImageCollection image collection with mosaiced imagery and image properties from chosen collection
     """
     image_list = []
     dates_list = img_col1.dates_list + img_col2.dates_list
@@ -39,10 +39,10 @@ def MosaicByDate(img_col):
     Function to mosaic collection images that share the same date. Server-side friendly. Requires images to have date property of "Date_Filter"
 
     Args:
-    img_col: eeImageCollection object
+        img_col(RadGEEToolbox object): eeImageCollection object
 
     Returns:
-    image collection: eeImageCollection with mosaiced imagery
+        ee.ImageCollection: ee.ImageCollection with mosaiced imagery
     """
     input_collection = img_col
 # Function to mosaic images of the same date and accumulate them

{radgeetoolbox-1.6.0 → radgeetoolbox-1.6.2}/RadGEEToolbox/GetPalette.py

@@ -3,10 +3,10 @@ def get_palette(name):
     Returns the color palette associated with the given name.
 
     Args:
-    name: options: 'algae', 'dense', 'greens', 'haline', 'inferno', 'jet', 'matter', 'pubu', 'soft_blue_green_red', 'thermal', 'turbid', 'ylord'
+        name (str): options are 'algae', 'dense', 'greens', 'haline', 'inferno', 'jet', 'matter', 'pubu', 'soft_blue_green_red', 'thermal', 'turbid', 'ylord'
     
     Returns:
-    list: list of colors to be used for image visualization in GEE vis params
+        list: list of colors to be used for image visualization in GEE vis params
     
     """
     palettes = {