izisat 0.1.0__tar.gz

izisat-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 anderson stolfi
+
+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.

izisat-0.1.0/PKG-INFO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.4
+Name: izisat
+Version: 0.1.0
+Summary: Add your description here
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: geopandas>=1.1.1
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: requests>=2.32.4
+Requires-Dist: tqdm>=4.67.1
+Dynamic: license-file
+
+# izisat
+
+`izisat` is a Python library designed to facilitate the automated download of Sentinel-2 satellite imagery bands from the Copernicus Open Access Hub (previously SciHub). It provides functionalities to connect to the Copernicus API, construct queries based on geographical footprints and time ranges, retrieve product information, and download specified bands to a local directory structure.
+
+## Features
+
+*   **API Connection:** Securely connect to the Copernicus Open Access Hub using provided credentials.
+*   **Query Construction:** Build complex queries for Sentinel-2 products based on:
+    *   Geographical footprint (WKT format)
+    *   Start and End Dates
+    *   Cloud Cover Percentage
+    *   Product Type (e.g., L2A)
+    *   Platform Name (e.g., SENTINEL-2)
+*   **Product Retrieval:** Fetch a list of available Sentinel-2 products matching the constructed query.
+*   **Automated Folder Creation:** Organize downloaded bands into a structured directory based on product information (e.g., `auxiliary/Sentinel-2/YYYY/MM/DD/TILE/L2A/RESOLUTION/`).
+*   **Band Downloading:** Download specific Sentinel-2 bands (e.g., B02, B03, B04, B08) for retrieved products.
+
+## Installation
+
+*(Placeholder: Add installation instructions here, e.g., using pip and a `requirements.txt` or `pyproject.toml`)*
+
+## Usage
+
+The `IZISentinel` class is the main entry point for interacting with the library. Below is an example demonstrating how to use `izisat` to download Sentinel-2 bands.
+
+```python
+import geopandas as gpd
+from datetime import datetime, timedelta
+from izisat.izisentinel import IZISentinel
+
+# Configuration
+DOWNLOAD_FOLDER = '/home/ppz/Documentos/coding/izisat/auxiliary' # Adjust as needed
+MAX_CLOUD_COVER = 99
+BANDS_DICT = {"L2A":{"10m": ["B02", "B03","B04", "B08"]}} # Specify bands and resolutions
+PLATFORM_NAME = "SENTINEL-2"
+SATELLITE_TYPE = 'L2A' # Level 2A products (bottom-of-atmosphere corrected)
+COPERNICUS_USER='your_copernicus_username' # Replace with your Copernicus username
+COPERNICUS_PASSWD='your_copernicus_password' # Replace with your Copernicus password
+
+# Define date range
+today = datetime.now().strftime('%Y-%m-%d')
+one_week_ago = (datetime.now() - timedelta(days=7)).strftime('%Y-%m-%d')
+
+# Initialize the downloader
+downloader = IZISentinel(output_base_path=DOWNLOAD_FOLDER)
+
+# 1. Connect to Copernicus API
+access_token, refresh_token, dt_access_token = downloader.connect_to_api(
+    username=COPERNICUS_USER,
+    password=COPERNICUS_PASSWD
+)
+
+# 2. Load geographical footprint (example using a GeoJSON file)
+# Replace 'path/to/your/farm.geojson' with the actual path to your GeoJSON file
+# The GeoJSON should contain a polygon representing your area of interest.
+try:
+    farm = gpd.read_file('/home/ppz/Documentos/coding/forestry_monitor/data/vectors/farms/farms.geojson')
+    footprint = farm.iloc[0].geometry.wkt # Assuming the first feature's geometry is the desired footprint
+except Exception as e:
+    print(f"Error loading GeoJSON or extracting footprint: {e}")
+    print("Please ensure 'forestry_monitor/data/vectors/farms/farms.geojson' exists and is valid, or provide a WKT string directly.")
+    footprint = "POLYGON ((<lon1> <lat1>, <lon2> <lat2>, ...))" # Example placeholder for direct WKT
+
+# 3. Construct the query
+query = downloader.construct_query(
+    footprint=footprint,
+    end_date=today,
+    start_date=one_week_ago,
+    cloud_cover_percentage=MAX_CLOUD_COVER,
+    type=SATELLITE_TYPE,
+    platform_name=PLATFORM_NAME
+)
+
+# 4. Retrieve products
+products = downloader.products_from_sentinel_2(query)
+
+# 5. Download specified bands
+if products:
+    images_downloaded = downloader.download_sentinel2_bands(
+        access_token,
+        products,
+        BANDS_DICT,
+        dt_access_token,
+        refresh_token,
+        tile=None # Specify a tile if you want to filter by tile, otherwise None
+    )
+    print(f"Downloaded images info: {images_downloaded}")
+else:
+    print("No products found for the given query.")
+```
+
+## Dependencies
+
+The core dependencies for `izisat` include:
+
+*   `loguru`: For logging.
+*   `geopandas`: For handling geographical data (used in the example for footprint).
+*   `datetime`: For date and time operations.
+
+*(Note: Specific versions and other implicit dependencies from `izisat.misc` modules would be listed in `pyproject.toml` or `requirements.txt`)*
+
+## Project Structure
+
+```
+.
+├── auxiliary/
+│   └── Sentinel-2/  # Default download location for Sentinel-2 bands
+├── src/
+│   └── izisat/
+│       ├── __init__.py
+│       ├── izisentinel.py  # Main class for Sentinel-2 band downloading
+│       └── misc/
+│           ├── __init__.py
+│           ├── connections.py # Handles API connections to Copernicus
+│           ├── dates.py       # Utility functions for date handling
+│           ├── files.py       # Utility functions for file and directory operations
+│           └── utils.py       # General utility functions (e.g., query construction, product info retrieval)
+├── .gitignore
+├── LICENSE
+├── pyproject.toml
+├── README.md
+└── uv.lock
+```
+
+## How to Contribute
+
+We welcome contributions to `izisat`! If you'd like to contribute, please follow these guidelines:
+
+1.  **Reporting Bugs:** If you find a bug, please open an issue on the GitHub repository. Provide a clear and concise description of the bug, steps to reproduce it, and expected behavior.
+2.  **Suggesting Features:** For new features or enhancements, open an issue to discuss your ideas.
+3.  **Submitting Pull Requests:**
+    *   Fork the repository and create a new branch for your changes.
+    *   Ensure your code adheres to the project's coding style.
+    *   Write clear and concise commit messages.
+    *   Include tests for new features or bug fixes.
+    *   Submit a pull request with a detailed description of your changes.
+
+Thank you for your contributions!

izisat-0.1.0/README.md

@@ -0,0 +1,138 @@
+# izisat
+
+`izisat` is a Python library designed to facilitate the automated download of Sentinel-2 satellite imagery bands from the Copernicus Open Access Hub (previously SciHub). It provides functionalities to connect to the Copernicus API, construct queries based on geographical footprints and time ranges, retrieve product information, and download specified bands to a local directory structure.
+
+## Features
+
+*   **API Connection:** Securely connect to the Copernicus Open Access Hub using provided credentials.
+*   **Query Construction:** Build complex queries for Sentinel-2 products based on:
+    *   Geographical footprint (WKT format)
+    *   Start and End Dates
+    *   Cloud Cover Percentage
+    *   Product Type (e.g., L2A)
+    *   Platform Name (e.g., SENTINEL-2)
+*   **Product Retrieval:** Fetch a list of available Sentinel-2 products matching the constructed query.
+*   **Automated Folder Creation:** Organize downloaded bands into a structured directory based on product information (e.g., `auxiliary/Sentinel-2/YYYY/MM/DD/TILE/L2A/RESOLUTION/`).
+*   **Band Downloading:** Download specific Sentinel-2 bands (e.g., B02, B03, B04, B08) for retrieved products.
+
+## Installation
+
+*(Placeholder: Add installation instructions here, e.g., using pip and a `requirements.txt` or `pyproject.toml`)*
+
+## Usage
+
+The `IZISentinel` class is the main entry point for interacting with the library. Below is an example demonstrating how to use `izisat` to download Sentinel-2 bands.
+
+```python
+import geopandas as gpd
+from datetime import datetime, timedelta
+from izisat.izisentinel import IZISentinel
+
+# Configuration
+DOWNLOAD_FOLDER = '/home/ppz/Documentos/coding/izisat/auxiliary' # Adjust as needed
+MAX_CLOUD_COVER = 99
+BANDS_DICT = {"L2A":{"10m": ["B02", "B03","B04", "B08"]}} # Specify bands and resolutions
+PLATFORM_NAME = "SENTINEL-2"
+SATELLITE_TYPE = 'L2A' # Level 2A products (bottom-of-atmosphere corrected)
+COPERNICUS_USER='your_copernicus_username' # Replace with your Copernicus username
+COPERNICUS_PASSWD='your_copernicus_password' # Replace with your Copernicus password
+
+# Define date range
+today = datetime.now().strftime('%Y-%m-%d')
+one_week_ago = (datetime.now() - timedelta(days=7)).strftime('%Y-%m-%d')
+
+# Initialize the downloader
+downloader = IZISentinel(output_base_path=DOWNLOAD_FOLDER)
+
+# 1. Connect to Copernicus API
+access_token, refresh_token, dt_access_token = downloader.connect_to_api(
+    username=COPERNICUS_USER,
+    password=COPERNICUS_PASSWD
+)
+
+# 2. Load geographical footprint (example using a GeoJSON file)
+# Replace 'path/to/your/farm.geojson' with the actual path to your GeoJSON file
+# The GeoJSON should contain a polygon representing your area of interest.
+try:
+    farm = gpd.read_file('/home/ppz/Documentos/coding/forestry_monitor/data/vectors/farms/farms.geojson')
+    footprint = farm.iloc[0].geometry.wkt # Assuming the first feature's geometry is the desired footprint
+except Exception as e:
+    print(f"Error loading GeoJSON or extracting footprint: {e}")
+    print("Please ensure 'forestry_monitor/data/vectors/farms/farms.geojson' exists and is valid, or provide a WKT string directly.")
+    footprint = "POLYGON ((<lon1> <lat1>, <lon2> <lat2>, ...))" # Example placeholder for direct WKT
+
+# 3. Construct the query
+query = downloader.construct_query(
+    footprint=footprint,
+    end_date=today,
+    start_date=one_week_ago,
+    cloud_cover_percentage=MAX_CLOUD_COVER,
+    type=SATELLITE_TYPE,
+    platform_name=PLATFORM_NAME
+)
+
+# 4. Retrieve products
+products = downloader.products_from_sentinel_2(query)
+
+# 5. Download specified bands
+if products:
+    images_downloaded = downloader.download_sentinel2_bands(
+        access_token,
+        products,
+        BANDS_DICT,
+        dt_access_token,
+        refresh_token,
+        tile=None # Specify a tile if you want to filter by tile, otherwise None
+    )
+    print(f"Downloaded images info: {images_downloaded}")
+else:
+    print("No products found for the given query.")
+```
+
+## Dependencies
+
+The core dependencies for `izisat` include:
+
+*   `loguru`: For logging.
+*   `geopandas`: For handling geographical data (used in the example for footprint).
+*   `datetime`: For date and time operations.
+
+*(Note: Specific versions and other implicit dependencies from `izisat.misc` modules would be listed in `pyproject.toml` or `requirements.txt`)*
+
+## Project Structure
+
+```
+.
+├── auxiliary/
+│   └── Sentinel-2/  # Default download location for Sentinel-2 bands
+├── src/
+│   └── izisat/
+│       ├── __init__.py
+│       ├── izisentinel.py  # Main class for Sentinel-2 band downloading
+│       └── misc/
+│           ├── __init__.py
+│           ├── connections.py # Handles API connections to Copernicus
+│           ├── dates.py       # Utility functions for date handling
+│           ├── files.py       # Utility functions for file and directory operations
+│           └── utils.py       # General utility functions (e.g., query construction, product info retrieval)
+├── .gitignore
+├── LICENSE
+├── pyproject.toml
+├── README.md
+└── uv.lock
+```
+
+## How to Contribute
+
+We welcome contributions to `izisat`! If you'd like to contribute, please follow these guidelines:
+
+1.  **Reporting Bugs:** If you find a bug, please open an issue on the GitHub repository. Provide a clear and concise description of the bug, steps to reproduce it, and expected behavior.
+2.  **Suggesting Features:** For new features or enhancements, open an issue to discuss your ideas.
+3.  **Submitting Pull Requests:**
+    *   Fork the repository and create a new branch for your changes.
+    *   Ensure your code adheres to the project's coding style.
+    *   Write clear and concise commit messages.
+    *   Include tests for new features or bug fixes.
+    *   Submit a pull request with a detailed description of your changes.
+
+Thank you for your contributions!

izisat-0.1.0/pyproject.toml

@@ -0,0 +1,12 @@
+[project]
+name = "izisat"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "geopandas>=1.1.1",
+    "loguru>=0.7.3",
+    "requests>=2.32.4",
+    "tqdm>=4.67.1",
+]

izisat-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

izisat-0.1.0/src/izisat/izisentinel.py

@@ -0,0 +1,161 @@
+
+from izisat.misc.raster_processing import RasterProcessing        
+from izisat.misc.connections import Connections
+from izisat.misc.utils import Utils
+from izisat.misc.files import Files
+from loguru import logger
+import geopandas as gpd
+from datetime import datetime, timedelta
+from shapely.geometry import box
+
+
+class IZISentinel:
+    def __init__(self, output_base_path, username, password):
+        """Initializes the Sentinel2_Band_Downloader instance."""
+        self.output_base_path = output_base_path
+        self.access_token, self.refresh_token, self.dt_access_token = self.connect_to_api(username, password)
+        
+    def connect_to_api(self, username, password):
+        """Connects to the Sentinel API and obtains an access token."""
+        connections = Connections()
+        access_token, refresh_token, dt_access_token = connections.access_token(username, password)
+        return access_token, refresh_token, dt_access_token
+                                      
+    def construct_query(self, geodataframe, end_date, cloud_cover_percentage, type, platform_name):
+        """Constructs a query for retrieving Sentinel-2 products based on specified parameters."""
+        utils = Utils()
+        start_date = (end_date - timedelta(days=1)).strftime('%Y-%m-%d')
+        end_date = end_date.strftime('%Y-%m-%d')
+        projected_gdf = gdf.to_crs(geodataframe.estimate_utm_crs('SIRGAS 2000'))
+        geodataframe = projected_gdf.buffer(1000)
+        geodataframe = geodataframe.to_crs(4674)
+        minx, miny, maxx, maxy = geodataframe.total_bounds
+        bbox_geom = box(minx, miny, maxx, maxy)
+        bbox_gdf = gpd.GeoDataFrame(geometry=[bbox_geom], crs=geodataframe.crs)
+        footprint = bbox_gdf.iloc[0].geometry.wkt
+        query = utils.construct_query_for_sentinel2_products(footprint, start_date, end_date, cloud_cover_percentage, type, platform_name)
+        return query
+        
+    def products_from_sentinel_2(self, params):
+        """Retrieves Sentinel-2 products based on the provided query parameters."""
+        connections = Connections()
+        products = connections.retrieve_sent_prod_from_query(params)
+        return products
+    
+    def get_products_info(self, products):
+        """Retrieves information about Sentinel-2 products."""
+        utils = Utils()
+        products_info = utils.retrieve_products_info(products)
+        return products_info
+    
+    def output_folder(self, products_info, bands_dict):
+        """Creates output folders to save downloaded bands."""
+        files = Files()
+        directory_paths = files.create_output_folders(self.output_base_path, products_info, bands_dict)
+        return directory_paths
+    
+    def get_bands_links(self, products_info, bands_dict):
+        """Retrieves links to bands for Sentinel-2 products."""
+        connections = Connections()
+        bands_links = connections.retrieve_bands_links(self.access_token, products_info, bands_dict)
+        return bands_links
+    
+    def download_band(self, products_info, bands_link, base_dir, tile):
+        """Downloads bands for Sentinel-2 products based on the provided links."""
+        connections = Connections()
+        connections.download_bands(self.access_token, products_info, bands_link, base_dir, self.dt_access_token, self.refresh_token, tile)
+
+    def download_sentinel2_bands(self, products, bands_dict, tile):
+        """Orchestrates the download process for Sentinel-2 bands."""
+        utils = Utils()
+        if products is None:
+            logger.warning("Stopping further execution.")
+        else:
+            products_info = self.get_products_info(products)
+            self.output_folder(products_info, bands_dict)
+            links = self.get_bands_links(products_info, bands_dict)
+            products=self.download_band(products_info, links, self.output_base_path, tile)
+
+            downloaded_dict = utils.generate_sentinel2_band_paths_nested_by_tile(self.output_base_path, products_info)
+            return downloaded_dict
+        
+    def get_composite_data(self, gdf, downloaded_dict, output_rgb=None, output_ndvi=None, output_evi=None):
+        raster_processing = RasterProcessing()
+        first_key = next(iter(downloaded_dict))
+        first_entry = downloaded_dict[first_key]
+        if len(first_entry) == 1:
+            band_paths = first_entry[0]
+            b02_array, b03_array, b04_array, b08_array, profile = raster_processing.get_cropped_bands_no_merge(gdf, band_paths)
+        elif len(first_entry) > 1:
+            b02_array, b03_array, b04_array, b08_array, profile = raster_processing.get_cropped_bands_with_merge(gdf, first_entry)
+
+        if output_rgb is not None:
+            raster_processing.create_rgb(b02_array, b03_array, b04_array, profile, output_rgb)
+
+        if output_ndvi is not None:
+            raster_processing.create_ndvi(b04_array, b08_array, profile, output_ndvi)
+
+        if output_evi is not None:
+            raster_processing.create_evi(b04_array, b04_array, b08_array, profile, output_evi)
+
+    def get_satellite_image(self, geodataframe, end_date, cloud_cover_percentage, type='L2A', platform_name='SENTINEL-2', bands_dict={"L2A":{"10m": ["B02", "B03","B04", "B08"]}}, output_rgb=None, output_ndvi=None, output_evi=None):
+        query = self.construct_query(geodataframe, end_date, cloud_cover_percentage, type, platform_name)
+        products = self.products_from_sentinel_2(query)
+        if products == None:
+            return
+        downloaded_dict = self.download_sentinel2_bands(products, bands_dict, None)
+        self.get_composite_data(geodataframe, downloaded_dict, output_rgb, output_ndvi, output_evi)
+
+
+if __name__ == '__main__':
+    DOWNLOAD_FOLDER = '/home/ppz/Documentos/coding/izisat/auxiliary'
+    MAX_CLOUD_COVER = 99
+    BANDS_DICT = {"L2A":{"10m": ["B02", "B03","B04", "B08"]}}
+    PLATFORM_NAME = "SENTINEL-2"
+    SATELLITE_TYPE = 'L2A'
+    COPERNICUS_USER=''
+    COPERNICUS_PASSWD='!'
+
+    zona_unica=False
+
+    ###TESTE ZONA UNICA###
+    downloader = IZISentinel(output_base_path=DOWNLOAD_FOLDER, username=COPERNICUS_USER, password=COPERNICUS_PASSWD)
+    if zona_unica is True:
+        today = datetime(2025, 4, 14, 1, 0, 0)
+        gdf = gpd.read_file('/home/ppz/Documentos/coding/izisat/auxiliary/base_ldcelulose/base_cadastral/FULL_20250709_VIEW.shp')
+        gdf = gdf.loc[(gdf['TALHAO'] == '0112') & (gdf['ID_PROJETO'] == '5822')]
+
+        output_rgb = '/home/ppz/Documentos/coding/izisat/auxiliary/raster_lake/rgb/teste_rgb.tif'
+        output_ndvi = '/home/ppz/Documentos/coding/izisat/auxiliary/raster_lake/ndvi/teste_ndvi.tif'
+        downloader.get_satellite_image(
+                           geodataframe=gdf,
+                           end_date=today,
+                           cloud_cover_percentage=MAX_CLOUD_COVER,
+                           type=SATELLITE_TYPE,
+                           platform_name=PLATFORM_NAME,
+                           bands_dict=BANDS_DICT,
+                           output_rgb=output_rgb,
+                           output_ndvi=output_ndvi,
+                           )
+
+    elif zona_unica is not True:
+        today = datetime(2025, 4, 9, 1, 0, 0)
+        gdf = gpd.read_file('/home/ppz/Documentos/coding/izisat/auxiliary/base_ldcelulose/base_filtrada.geojson')
+        gdf = gdf.dissolve(by='PROJETO').reset_index()    
+        #gdf = gpd.read_file('/home/ppz/Documentos/coding/izisat/testing.geojson')
+        for index, row in gdf.iterrows():
+            print(f'linha - {index} de {len(gdf)} -- TALHAO: {row.TALHAO}')
+            row_gdf = gdf.iloc[[index]]
+            output_rgb = f'/home/ppz/Documentos/coding/izisat/auxiliary/raster_lake/rgb/teste_rgb_{row.TALHAO}.tif'
+            output_ndvi = f'/home/ppz/Documentos/coding/izisat/auxiliary/raster_lake/ndvi/teste_ndvi_{row.TALHAO}.tif'
+            output_evi = f'/home/ppz/Documentos/coding/izisat/auxiliary/raster_lake/evi/teste_evi_{row.TALHAO}.tif'
+            downloader.get_satellite_image(
+                            geodataframe=row_gdf,
+                            end_date=today,
+                            cloud_cover_percentage=MAX_CLOUD_COVER,
+                            type=SATELLITE_TYPE,
+                            platform_name=PLATFORM_NAME,
+                            bands_dict=BANDS_DICT,
+                            output_rgb=output_rgb,
+                            output_ndvi=output_ndvi,
+                            output_evi=output_evi)