RadGEEToolbox 1.6.2__py3-none-any.whl → 1.6.3__py3-none-any.whl

RadGEEToolbox/__init__.py

@@ -1,6 +1,18 @@
+__version__ = "1.6.3"
+
 from .CollectionStitch import CollectionStitch, MosaicByDate
 from .GetPalette import get_palette
 from .LandsatCollection import LandsatCollection
 from .Sentinel1Collection import Sentinel1Collection
 from .Sentinel2Collection import Sentinel2Collection
-from .VisParams import get_visualization_params
+from .VisParams import get_visualization_params
+
+__all__ = [
+    "CollectionStitch",
+    "MosaicByDate",
+    "get_palette",
+    "LandsatCollection",
+    "Sentinel1Collection",
+    "Sentinel2Collection",
+    "get_visualization_params"
+]

{radgeetoolbox-1.6.2.dist-info → radgeetoolbox-1.6.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RadGEEToolbox
-Version: 1.6.2
+Version: 1.6.3
 Summary: Streamlined Multispectral & SAR Analysis for Google Earth Engine Python API
 Home-page: https://github.com/radwinskis/RadGEEToolbox
 Author: Mark Radwin
@@ -31,7 +31,7 @@ Dynamic: requires-python
 
 # RadGEEToolbox 🛠
 
-![](image-1.png)
+![](ReadMeCover.png)
 
 ### 🌎 Streamlined Multispectral & SAR Analysis for Google Earth Engine Python API
 
@@ -41,6 +41,69 @@ Dynamic: requires-python
 
 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.
 
+_________
+## Getting Started with Google Earth Engine
+
+**RadGEEToolbox requires [access](https://developers.google.com/earth-engine/guides/access) to [Google Earth Engine (GEE)](https://earthengine.google.com/) and proper [authentication](https://developers.google.com/earth-engine/guides/auth) with the Python API.**
+
+For more details, see the official [Google Earth Engine Python API Getting Started Guide](https://developers.google.com/earth-engine/guides/quickstart_python) or [Python Installation Guide](https://developers.google.com/earth-engine/guides/python_install).
+
+
+### 1. Sign Up for Earth Engine
+Apply for access here: [https://earthengine.google.com/signup/](https://earthengine.google.com/signup/) using a Google account. Approval typically takes a few days.
+
+### 2. Install the Earth Engine Python API
+**The Earth Engine API is installed automatically when you install `RadGEEToolbox`.** However, if you would like to install manually:
+
+```bash
+pip install earthengine-api
+```
+
+### 3. Authenticate & Initialize
+Prior to using the Earth Engine Python client library, you need to authenticate and use the resultant credentials to initialize the Python client. The authentication flows use Cloud Projects to authenticate, and they're used for unpaid (free, noncommercial) use as well as paid use.
+
+
+**Run the following during your first use:**
+```python
+import ee
+ee.Authenticate()
+```
+***NOTE: Your GEE credentials will not permanantly be stored on your PC and you will periodically need to re-run `ee.Authenticate()` when `ee.Initialize()` returns an authentication error.***
+
+`ee.Autheticate()` will select the best authentication mode for your environment, and prompt you to confirm access for your scripts. To initialize, you will need to provide a project that you own, or have permissions to use. This project will be used for running all Earth Engine operations:
+
+```python
+ee.Initialize(project='my-project')
+```
+Replacing 'my-project' with the name of the Google Cloud Project you created on sign-up or any Google Cloud Project that has the GEE API enabled.
+
+### 4. Authentication Best Practices
+It is reccomended to use the following authentication procedure once you have completed your initial authentication:
+```python
+import ee
+
+try:
+    ee.Initialize()
+except Exception as e:
+    ee.Authenticate()
+    ee.Initialize()
+```
+
+### 5. Troubleshooting
+`AttributeError: module 'ee' has no attribute 'Initialize'`
+
+➤ Ensure that earthengine-api is installed properly.
+
+`403 Access Denied`
+
+➤ Your GEE account might not be approved, or the API is not enabled for your project.
+
+`Initialization fails`
+
+➤ Try using `ee.Initialize(project='your-project-id')` explicitly in case you are just calling `ee.Initialize()`
+
+See the official [GEE documentation for authentication »](https://developers.google.com/earth-engine/guides/auth)
+
 _________
 
 ## Key Features
@@ -67,15 +130,15 @@ _____________
 
 ### Installing via pip
 
-To install `RadGEEToolbox` version 1.6.2 using pip (NOTE: it is recommended to create a new virtual environment):
+To install `RadGEEToolbox` version 1.6.3 using pip (NOTE: it is recommended to create a new virtual environment):
 
 ```bash
-pip install RadGEEToolbox==1.6.2
+pip install RadGEEToolbox==1.6.3
 ```
 
 ### Installing via Conda
 
-To install `RadGEEToolbox` version 1.6.2 using conda-forge (NOTE: it is recommended to create a new virtual environment):
+To install `RadGEEToolbox` version 1.6.3 using conda-forge (NOTE: it is recommended to create a new virtual environment):
 
 ```bash
 conda install conda-forge::radgeetoolbox
@@ -106,8 +169,32 @@ To verify that `RadGEEToolbox` was installed correctly:
 python -c "import RadGEEToolbox; print(RadGEEToolbox.__version__)"
 ```
 
-You should see `1.6.2` printed as the version number.
+You should see `1.6.3` printed as the version number.
+
+### Want to Visualize Data? Install These Too
+
+The core functionality of this package is focused on the processing of geospatial and remote sensing data using Google Earth Engine. It does **not** include interactive mapping functionality by default.
 
+**If you wish to view GEE data on interactive maps (e.g., following along with the mapping portions of the [example notebooks](https://github.com/radwinskis/RadGEEToolbox/tree/main/Example%20Notebooks)), you will need to install the [optional `geemap` package](https://geemap.org) in the environment that `RadGEEToolbox` is installed:**
+
+```python
+pip install geemap
+```
+or 
+
+```bash
+conda install conda-forge::geemap
+```
+**If you plan to use `geemap` in a Jupyter Notebook, you will also need to install `ipykernel`:**
+
+```python
+pip install ipykernel
+```
+or 
+
+```bash
+conda install anaconda::ipykernel
+```
 ________
 # Usage Example
 
@@ -122,7 +209,7 @@ from RadGEEToolbox import LandsatCollection
 
 # 2. Authenticate & Initialize GEE API
 ee.Authenticate()
-ee.Initialize()
+ee.Initialize(project='my-cloud-project-ID) #replace with your Google Cloud project ID
 
 # 3. Define study area boundary - in this case Lake Powell, Utah
 study_area = ee.Geometry.Polygon(
@@ -145,6 +232,9 @@ collection = LandsatCollection(
 dates = collection.dates 
 print(dates)
 ```
+```
+['2020-01-13', '2020-02-14', '2020-05-04', '2020-05-20', '2020-07-07', '2020-08-08', '2020-08-24', '2020-09-25', '2020-10-11', '2020-10-27', '2020-11-28', '2020-12-30', '2021-01-15', '2021-01-31', '2021-04-05', '2021-05-07', '2021-06-08', '2021-07-10', '2021-08-27', '2021-10-30', '2021-11-10', '2021-11-10', '2021-12-01', '2021-12-17', '2022-01-02', '2022-01-10', '2022-01-26', '2022-02-11', '2022-02-19', '2022-02-27', '2022-03-23', '2022-04-08', '2022-05-02', '2022-05-18', '2022-05-26', '2022-06-11', '2022-06-27', '2022-07-13', '2022-08-06', '2022-08-22', '2022-08-30', '2022-09-07', '2022-09-23', '2022-10-01', '2022-10-09', '2022-10-17', '2022-10-25', '2022-11-10', '2023-01-21', '2023-03-18', '2023-04-11', '2023-06-22', '2023-06-30', '2023-07-08', '2023-07-16', '2023-09-18', '2023-09-26', '2023-10-04', '2023-10-20', '2023-11-13', '2023-11-21', '2023-12-07', '2023-12-15', '2023-12-31', '2024-01-16', '2024-03-20', '2024-04-13', '2024-04-21', '2024-05-07', '2024-05-23', '2024-06-08', '2024-06-16', '2024-07-02', '2024-07-10', '2024-07-26', '2024-08-19', '2024-08-27', '2024-09-04', '2024-09-12', '2024-09-20', '2024-09-28', '2024-10-06', '2024-10-22', '2024-10-30', '2024-11-07', '2024-11-15', '2024-12-01']
+```
 ### 2. Apply a Cloud Mask and Compute NDWI
 ```python
 # 1. Mask clouds 
@@ -156,15 +246,16 @@ 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
+![Visualization of true color and classified water (in blue) from one of the dates in the collection](LakePowellNDWI.png)
+
+***Visualization of true color and classified water (in blue) from one of the dates in the collection. To see the code used to display this image, please view [this Example Notebook](https://github.com/radwinskis/RadGEEToolbox/blob/main/Example%20Notebooks/Complete_ReadMe_Example.ipynb)***
 
 ### 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
+      geometry=study_area, #ee.Geometry() of your study area
       threshold=0, #binary classification threshold for unclassified rasters,
       scale=90 #pixel size for zonal statistics
       )
@@ -172,9 +263,9 @@ 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!](LakePowellPlot.png)
 
-Plotted Results from Above Example - All Processed in Less Than 5 Seconds!
+***To see the code used to display this plot, please view [this Example Notebook](https://github.com/radwinskis/RadGEEToolbox/blob/main/Example%20Notebooks/Complete_ReadMe_Example.ipynb)***
 
 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.
 

{radgeetoolbox-1.6.2.dist-info → radgeetoolbox-1.6.3.dist-info}/RECORD

@@ -4,9 +4,9 @@ RadGEEToolbox/LandsatCollection.py,sha256=Tq-hwFPolqZI1rL-ORS5dPcjBa3QGEy2ruhc_T
 RadGEEToolbox/Sentinel1Collection.py,sha256=Z32YszIUC_eswMtravMGrNHCP0RA5LK_qyPHQT6stVk,62040
 RadGEEToolbox/Sentinel2Collection.py,sha256=6jx5sMKKDgkr6okQzDQogUBE6t_aBubViZ1OIuIt5K8,67494
 RadGEEToolbox/VisParams.py,sha256=knGnu0zdxkDC1jqvgybNUKUY5IrJaQGgd-7j4odcRQE,5197
-RadGEEToolbox/__init__.py,sha256=t0qJcUKAO0EIh0zLDPyjO7zQOjnrSLJUjZ4Q_k1w_Ig,304
-radgeetoolbox-1.6.2.dist-info/licenses/LICENSE.txt,sha256=5Xj9dwVkawz6d8zhCwJy0SmXvm0U4K_msJnOrkHLO1w,1089
-radgeetoolbox-1.6.2.dist-info/METADATA,sha256=33beAetm-2ONOHRR4u_EvWNtXAPOaMCpodol2DoBLzc,7713
-radgeetoolbox-1.6.2.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
-radgeetoolbox-1.6.2.dist-info/top_level.txt,sha256=W2E520tugQoptDkhctKFbzsheL2l_DyYLKqKXkD9G_E,14
-radgeetoolbox-1.6.2.dist-info/RECORD,,
+RadGEEToolbox/__init__.py,sha256=2ZG1sQoQVj7g7xTLQE2sbu0uchpPeto8lsq7CGg7pTM,529
+radgeetoolbox-1.6.3.dist-info/licenses/LICENSE.txt,sha256=5Xj9dwVkawz6d8zhCwJy0SmXvm0U4K_msJnOrkHLO1w,1089
+radgeetoolbox-1.6.3.dist-info/METADATA,sha256=7XOL6h_su7U0ncn45se2dNh9M3q04mouNz1YcrUbxc4,13145
+radgeetoolbox-1.6.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+radgeetoolbox-1.6.3.dist-info/top_level.txt,sha256=W2E520tugQoptDkhctKFbzsheL2l_DyYLKqKXkD9G_E,14
+radgeetoolbox-1.6.3.dist-info/RECORD,,

{radgeetoolbox-1.6.2.dist-info → radgeetoolbox-1.6.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.8.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any