satcube 0.1.29__tar.gz

satcube-0.1.29/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024, Cesar Aybar
+
+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.
+

satcube-0.1.29/PKG-INFO

@@ -0,0 +1,222 @@
+Metadata-Version: 2.1
+Name: satcube
+Version: 0.1.29
+Summary: A Python package to create cloud-free monthly composites by fusing Landsat and Sentinel-2 data.
+Home-page: https://github.com/IPL-UV/satcube
+Author: Cesar Aybar
+Author-email: fcesar.aybar@uv.es
+Requires-Python: >=3.9
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Provides-Extra: full
+Requires-Dist: cubexpress (==0.1.25)
+Requires-Dist: mlstac (>=0.4.5)
+Requires-Dist: phicloudmask (>=0.0.2)
+Requires-Dist: requests (>=2.26.0)
+Requires-Dist: satalign (==0.1.16)
+Requires-Dist: scikit-learn (>=1.2.0)
+Requires-Dist: segmentation-models-pytorch (>=0.3.0)
+Requires-Dist: sen2sr (>=0.8.5)
+Requires-Dist: torch (>=2.0.0) ; extra == "full"
+Requires-Dist: tqdm (>=4.67.1)
+Requires-Dist: xarray (>=2023.7.0)
+Project-URL: Documentation, https://ipl-uv.github.io/satcube/
+Project-URL: Repository, https://github.com/IPL-UV/satcube
+Description-Content-Type: text/markdown
+
+# 
+
+<p align="center">
+  <img src="https://huggingface.co/datasets/JulioContrerasH/DataMLSTAC/resolve/main/banner_satcube.png" width="33%">
+</p>
+
+<p align="center">
+    <em>A python package for managing Sentinel-2 satellite data cubes</em> 🚀
+</p>
+
+<p align="center">
+<a href='https://pypi.python.org/pypi/satcube'>
+    <img src='https://img.shields.io/pypi/v/satcube.svg' alt='PyPI' />
+</a>
+<a href="https://opensource.org/licenses/MIT" target="_blank">
+    <img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License">
+</a>
+<a href="https://github.com/psf/black" target="_blank">
+    <img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Black">
+</a>
+<a href="https://pycqa.github.io/isort/" target="_blank">
+    <img src="https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336" alt="isort">
+</a>
+</p>
+
+---
+
+**GitHub**: [https://github.com/IPL-UV/satcube](https://github.com/IPL-UV/satcube) 🌐
+
+**PyPI**: [https://pypi.org/project/satcube/](https://pypi.org/project/satcube/) 🛠️
+
+---
+
+## **Overview** 📊
+
+**satcube** is a Python package designed for efficient management, processing, and analysis of Sentinel-2 satellite image cubes. It allows for downloading, cloud masking, gap filling, and super-resolving Sentinel-2 imagery, as well as creating monthly composites and performing interpolation.
+
+## **Key Features** ✨
+- **Satellite image download**: Retrieve Sentinel-2 images from Earth Engine efficiently. 🛰️
+- **Cloud masking**: Automatically remove clouds from Sentinel-2 images. ☁️
+- **Gap filling**: Fill missing data using methods like linear interpolation and histogram matching. 🧩
+- **Super-resolution**: Apply super-resolution models to enhance image quality. 🔍
+- **Monthly composites**: Aggregate images into monthly composites with various statistical methods. 📅
+- **Temporal smoothing**: Smooth reflectance values across time using interpolation techniques. 📈
+## **Installation** ⚙️
+
+Install the latest version from PyPI:
+
+```bash
+pip install satcube
+```
+
+## **How to use** 🛠️
+
+### **Basic usage: working with sentinel-2 data** 🌍
+
+#### **Load libraries**
+
+```python
+import ee
+import satcube
+```
+
+#### **Authenticate and initialize earth engine**
+
+```python
+ee.Authenticate()
+ee.Initialize(project="ee-csaybar-real")
+```
+#### **Download model weights**
+```python
+outpath = satcube.download_weights(path="weights")
+```
+
+#### **Create a satellite dataCube**
+```python
+datacube = satcube.SatCube(
+    coordinates=(-77.68598590138802,-8.888223962022263),
+    sensor=satcube.Sentinel2(weight_path=outpath, edge_size=384),
+    output_dir="wendy01",
+    max_workers=12,
+    device="cuda",
+)
+```
+
+
+### **Query and process sentinel-2 data** 🛰️
+
+#### **Query the sentinel-2 image collection**
+
+```python
+# Query the Sentinel-2 image collection
+table_query = datacube.metadata_s2()
+
+# Filter images based on cloud cover and remove duplicates
+table_query_subset = table_query[table_query["cs_cdf"] > 0.30]
+table_query_subset = table_query_subset.drop_duplicates(subset="img_date")
+mgrs_tile_max = table_query_subset["mgrs_title"].value_counts().idxmax()
+table_query_subset = table_query_subset[table_query_subset["mgrs_title"] == mgrs_tile_max]
+```
+
+#### **Download sentinel-2 images**
+
+```python
+table_download = datacube.download_s2_image(table_query_subset)
+```
+#### **Cloud masking**
+
+```python
+# Remove clouds from the images
+table_nocloud = datacube.cloudmasking_s2(table_download)
+table_nocloud = table_nocloud[table_nocloud["cloud_cover"] < 0.75]
+table_nocloud.reset_index(drop=True, inplace=True)
+```
+
+#### **Gap filling**
+
+```python
+# Fill missing data in the images
+table_nogaps = datacube.gapfilling_s2(table_nocloud)
+table_nogaps = table_nogaps[table_nogaps["match_error"] < 0.1]
+```
+### **Monthly composites and image smoothing 📅**
+
+#### **Create monthly composites**
+
+```python
+# Generate monthly composites
+table_composites = datacube.monthly_composites_s2(
+    table_nogaps, agg_method="median", date_range=("2016-01-01", "2024-07-31")
+)
+```
+
+#### **Interpolate missing data**
+
+```python
+# Interpolate missing months if necessary
+table_interpolate = datacube.interpolate_s2(table=table_composites)
+```
+
+#### **Smooth reflectance values**
+
+```python
+# Smooth reflectance values across time
+table_smooth = datacube.smooth_s2(table=table_interpolate)
+```
+
+### **Super-resolution and visualization** 📐
+
+
+
+#### **Super-resolution**
+
+```python
+# Apply super-resolution to the image cube
+# table_final = datacube.super_s2(table_smooth)
+```
+
+
+#### **Display images**
+
+```python
+# Display the images from the data cube
+datacube.display_images(table=table_smooth)
+```
+
+#### **Create a GIF**
+
+```python
+# !apt-get install imagemagick
+import os
+os.system("convert -delay 20 -loop 0 wendy01/z_s2_07_smoothed_png/temp_07*.png animation.gif")
+
+from IPython.display import Image
+Image(filename='animation.gif', width=500)
+```
+
+<p align="center">
+  <img src="https://huggingface.co/datasets/JulioContrerasH/DataMLSTAC/resolve/main/gif_satcube.gif" width="100%">
+</p>
+
+#### **Smooth reflectance values**
+
+```python
+# Smooth reflectance values across time
+table_smooth = datacube.smooth_s2(table=table_interpolate)
+```
+
+## **Supported features and filters** ✨
+
+- **Cloud masking:** Efficient removal of clouds from satellite images.
+- **Resampling methods:** Various methods for resampling and aligning imagery.
+- **Super-resolution:** ONNX-based models for improving image resolution.

satcube-0.1.29/README.md

@@ -0,0 +1,193 @@
+# 
+
+<p align="center">
+  <img src="https://huggingface.co/datasets/JulioContrerasH/DataMLSTAC/resolve/main/banner_satcube.png" width="33%">
+</p>
+
+<p align="center">
+    <em>A python package for managing Sentinel-2 satellite data cubes</em> 🚀
+</p>
+
+<p align="center">
+<a href='https://pypi.python.org/pypi/satcube'>
+    <img src='https://img.shields.io/pypi/v/satcube.svg' alt='PyPI' />
+</a>
+<a href="https://opensource.org/licenses/MIT" target="_blank">
+    <img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License">
+</a>
+<a href="https://github.com/psf/black" target="_blank">
+    <img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Black">
+</a>
+<a href="https://pycqa.github.io/isort/" target="_blank">
+    <img src="https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336" alt="isort">
+</a>
+</p>
+
+---
+
+**GitHub**: [https://github.com/IPL-UV/satcube](https://github.com/IPL-UV/satcube) 🌐
+
+**PyPI**: [https://pypi.org/project/satcube/](https://pypi.org/project/satcube/) 🛠️
+
+---
+
+## **Overview** 📊
+
+**satcube** is a Python package designed for efficient management, processing, and analysis of Sentinel-2 satellite image cubes. It allows for downloading, cloud masking, gap filling, and super-resolving Sentinel-2 imagery, as well as creating monthly composites and performing interpolation.
+
+## **Key Features** ✨
+- **Satellite image download**: Retrieve Sentinel-2 images from Earth Engine efficiently. 🛰️
+- **Cloud masking**: Automatically remove clouds from Sentinel-2 images. ☁️
+- **Gap filling**: Fill missing data using methods like linear interpolation and histogram matching. 🧩
+- **Super-resolution**: Apply super-resolution models to enhance image quality. 🔍
+- **Monthly composites**: Aggregate images into monthly composites with various statistical methods. 📅
+- **Temporal smoothing**: Smooth reflectance values across time using interpolation techniques. 📈
+## **Installation** ⚙️
+
+Install the latest version from PyPI:
+
+```bash
+pip install satcube
+```
+
+## **How to use** 🛠️
+
+### **Basic usage: working with sentinel-2 data** 🌍
+
+#### **Load libraries**
+
+```python
+import ee
+import satcube
+```
+
+#### **Authenticate and initialize earth engine**
+
+```python
+ee.Authenticate()
+ee.Initialize(project="ee-csaybar-real")
+```
+#### **Download model weights**
+```python
+outpath = satcube.download_weights(path="weights")
+```
+
+#### **Create a satellite dataCube**
+```python
+datacube = satcube.SatCube(
+    coordinates=(-77.68598590138802,-8.888223962022263),
+    sensor=satcube.Sentinel2(weight_path=outpath, edge_size=384),
+    output_dir="wendy01",
+    max_workers=12,
+    device="cuda",
+)
+```
+
+
+### **Query and process sentinel-2 data** 🛰️
+
+#### **Query the sentinel-2 image collection**
+
+```python
+# Query the Sentinel-2 image collection
+table_query = datacube.metadata_s2()
+
+# Filter images based on cloud cover and remove duplicates
+table_query_subset = table_query[table_query["cs_cdf"] > 0.30]
+table_query_subset = table_query_subset.drop_duplicates(subset="img_date")
+mgrs_tile_max = table_query_subset["mgrs_title"].value_counts().idxmax()
+table_query_subset = table_query_subset[table_query_subset["mgrs_title"] == mgrs_tile_max]
+```
+
+#### **Download sentinel-2 images**
+
+```python
+table_download = datacube.download_s2_image(table_query_subset)
+```
+#### **Cloud masking**
+
+```python
+# Remove clouds from the images
+table_nocloud = datacube.cloudmasking_s2(table_download)
+table_nocloud = table_nocloud[table_nocloud["cloud_cover"] < 0.75]
+table_nocloud.reset_index(drop=True, inplace=True)
+```
+
+#### **Gap filling**
+
+```python
+# Fill missing data in the images
+table_nogaps = datacube.gapfilling_s2(table_nocloud)
+table_nogaps = table_nogaps[table_nogaps["match_error"] < 0.1]
+```
+### **Monthly composites and image smoothing 📅**
+
+#### **Create monthly composites**
+
+```python
+# Generate monthly composites
+table_composites = datacube.monthly_composites_s2(
+    table_nogaps, agg_method="median", date_range=("2016-01-01", "2024-07-31")
+)
+```
+
+#### **Interpolate missing data**
+
+```python
+# Interpolate missing months if necessary
+table_interpolate = datacube.interpolate_s2(table=table_composites)
+```
+
+#### **Smooth reflectance values**
+
+```python
+# Smooth reflectance values across time
+table_smooth = datacube.smooth_s2(table=table_interpolate)
+```
+
+### **Super-resolution and visualization** 📐
+
+
+
+#### **Super-resolution**
+
+```python
+# Apply super-resolution to the image cube
+# table_final = datacube.super_s2(table_smooth)
+```
+
+
+#### **Display images**
+
+```python
+# Display the images from the data cube
+datacube.display_images(table=table_smooth)
+```
+
+#### **Create a GIF**
+
+```python
+# !apt-get install imagemagick
+import os
+os.system("convert -delay 20 -loop 0 wendy01/z_s2_07_smoothed_png/temp_07*.png animation.gif")
+
+from IPython.display import Image
+Image(filename='animation.gif', width=500)
+```
+
+<p align="center">
+  <img src="https://huggingface.co/datasets/JulioContrerasH/DataMLSTAC/resolve/main/gif_satcube.gif" width="100%">
+</p>
+
+#### **Smooth reflectance values**
+
+```python
+# Smooth reflectance values across time
+table_smooth = datacube.smooth_s2(table=table_interpolate)
+```
+
+## **Supported features and filters** ✨
+
+- **Cloud masking:** Efficient removal of clouds from satellite images.
+- **Resampling methods:** Various methods for resampling and aligning imagery.
+- **Super-resolution:** ONNX-based models for improving image resolution.

satcube-0.1.29/pyproject.toml

@@ -0,0 +1,65 @@
+[tool.poetry]
+name    = "satcube"
+version = "0.1.29"
+description = "A Python package to create cloud-free monthly composites by fusing Landsat and Sentinel-2 data."
+authors = ["Cesar Aybar <fcesar.aybar@uv.es>"]
+repository     = "https://github.com/IPL-UV/satcube"
+documentation  = "https://ipl-uv.github.io/satcube/"
+readme         = "README.md"
+packages       = [{ include = "satcube" }]
+
+[tool.poetry.dependencies]
+python          = ">=3.9"
+cubexpress      = "0.1.25"
+mlstac          = ">=0.4.5"
+satalign        = "0.1.16"         
+segmentation-models-pytorch = ">=0.3.0"
+phicloudmask    = ">=0.0.2" 
+scikit-learn    = ">=1.2.0"
+requests        = ">=2.26.0"
+xarray          = ">=2023.7.0"  
+tqdm            = ">=4.67.1"
+torch           = ">=2.0.0"
+sen2sr          = ">=0.8.5"
+
+[tool.poetry.extras]
+full = ["torch"]
+
+# --- tooling fixes ----------------------------------------------------------
+[tool.mypy]
+files                   = ["satcube"]
+disallow_untyped_defs   = true
+disallow_any_unimported = true
+no_implicit_optional    = true
+check_untyped_defs      = true
+warn_return_any         = true
+warn_unused_ignores     = true
+show_error_codes        = true
+
+[tool.ruff]
+target-version = "py310"
+line-length = 120
+fix = true
+
+[tool.ruff.lint]
+select = ["YTT","S","B","A","C4","T10","SIM","I","C90","E","W","F","PGH","UP","RUF","TRY"]
+ignore = [
+    "E501",   
+    "E731",   
+    "RUF002", 
+    "SIM108", 
+    "RUF059", 
+    "TRY003", 
+    "C901",   
+    "TRY300", 
+    "S112",   
+    "S110",   
+    "SIM101", 
+    "S101",   
+    "RUF003", 
+]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401", "E402"]  
+"_quiet.py" = ["E402"]            
+"utils.py" = ["S101"]             

satcube-0.1.29/satcube/__init__.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+import importlib as _importlib
+
+_importlib.import_module("satcube._quiet")
+from satcube.download import metadata  # noqa: E402
+from satcube.objects import SatCubeMetadata  # noqa: E402
+
+from_directory = SatCubeMetadata.from_directory
+
+__all__ = ["SatCubeMetadata", "from_directory", "metadata"]
+
+try:
+    from importlib.metadata import version
+
+    __version__ = version("satcube")
+except Exception:
+    __version__ = "0.0.0-dev"