satcube 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

satcube-0.1.2.dist-info/METADATA

@@ -0,0 +1,224 @@
+Metadata-Version: 2.1
+Name: satcube
+Version: 0.1.2
+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.10,<4.0
+Classifier: Programming Language :: Python :: 3
+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.2)
+Requires-Dist: earthengine-api (>=0.1.4.0) ; extra == "full"
+Requires-Dist: fastcubo (>=0.0.999)
+Requires-Dist: mlstac (>=0.4.0)
+Requires-Dist: numpy (>=1.25.0)
+Requires-Dist: pandas (>=2.0.0)
+Requires-Dist: pydantic (>=2.8.0)
+Requires-Dist: rasterio (>=1.2.0) ; extra == "full"
+Requires-Dist: requests (>=2.26.0)
+Requires-Dist: satalign (>=0.0.999)
+Requires-Dist: scikit-learn (>=1.2.0) ; extra == "full"
+Requires-Dist: segmentation-models-pytorch (>=0.3.0) ; extra == "full"
+Requires-Dist: torch (>=2.0.0) ; extra == "full"
+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.2.dist-info/RECORD

@@ -0,0 +1,12 @@
+satcube/cloud_detection.py,sha256=QSzeqCF63kJHzejbrXKL10x-kLxK0iorHvJNALoHYbA,5848
+satcube/cloud_detection_old.py,sha256=7MviF8QlT2tj6QC3seepr8SZU0nHOK9Pji8AU94Z2q0,751
+satcube/dataclass.py,sha256=TAAKouyTts5eMtVXRmwWgJb5EaUXryEtkKMtt1O8TKM,934
+satcube/download.py,sha256=Tl6_o3ffYIQ5nYmy7D4g3nGoUmd9Zq9_CbhFCH92ffY,1587
+satcube/download_old.py,sha256=Y7dUgq7Gl7jVKHZl5x9cpxALN9T6dCjtZwNjBiq1CAA,2647
+satcube/main.py,sha256=BpQJbPXl6Ydj6X3pX2lFepH7w1-cfJ3LeTTsTmQih6s,14841
+satcube/utils.py,sha256=wQl4ZSrocSZSSU6hjwCA2CYIv8p3deiX8PUKxJRr3yc,1952
+satcube/utils_old.py,sha256=UBCI2oaL7E5MEjebobnyqGqgOtK6jU9O3t-c58JqZ0k,35057
+satcube-0.1.2.dist-info/LICENSE,sha256=YdB4BQMkMzWuKvXRIpQR4g91IQ_pwA5PSH2lNM97zFI,1070
+satcube-0.1.2.dist-info/METADATA,sha256=7zRn-OymbNtHGU3vUWBu7WNBvjcQI_I3xXDh6pW2i9Q,6777
+satcube-0.1.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+satcube-0.1.2.dist-info/RECORD,,

{satcube-0.1.0.dist-info → satcube-0.1.2.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.1.0
+Generator: poetry-core 1.9.0
 Root-Is-Purelib: true
 Tag: py3-none-any

satcube/__init__.py

@@ -1,3 +0,0 @@
-from satcube.dataclass import Sentinel2
-from satcube.main import SatCube
-from satcube.utils import download_weights, monthly_calendar

satcube-0.1.0.dist-info/METADATA

@@ -1,31 +0,0 @@
-Metadata-Version: 2.1
-Name: satcube
-Version: 0.1.0
-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.10,<4.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Requires-Dist: earthengine-api (>=0.1.4.0)
-Requires-Dist: fastcubo (>=0.0.999)
-Requires-Dist: matplotlib (>=3.7.0)
-Requires-Dist: numpy (>=1.25.0)
-Requires-Dist: pandas (>=2.0.0)
-Requires-Dist: phicloudmask (>=0.0.2)
-Requires-Dist: pydantic (>=2.8.0)
-Requires-Dist: rasterio (>=1.2.0)
-Requires-Dist: requests (>=2.26.0)
-Requires-Dist: satalign (>=0.0.999)
-Requires-Dist: scikit-learn (>=1.2.0)
-Requires-Dist: segmentation-models-pytorch (>=0.2.0)
-Requires-Dist: torch (>=2.0.0)
-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
-
-# satcube
-
-[colab code](https://colab.research.google.com/drive/1)

satcube-0.1.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-satcube/__init__.py,sha256=Tib3dgX1UTZZS9eO91bLicTYjnl4w5uYMQzB9l4R01k,134
-satcube/cloud_detection.py,sha256=7MviF8QlT2tj6QC3seepr8SZU0nHOK9Pji8AU94Z2q0,751
-satcube/dataclass.py,sha256=TAAKouyTts5eMtVXRmwWgJb5EaUXryEtkKMtt1O8TKM,934
-satcube/main.py,sha256=n77L_Oeip99G0KcBqHCunaE-uwn3_yVPmLNzGmfgffQ,14833
-satcube/utils.py,sha256=UBCI2oaL7E5MEjebobnyqGqgOtK6jU9O3t-c58JqZ0k,35057
-satcube-0.1.0.dist-info/LICENSE,sha256=YdB4BQMkMzWuKvXRIpQR4g91IQ_pwA5PSH2lNM97zFI,1070
-satcube-0.1.0.dist-info/WHEEL,sha256=bbU3AyvhQ312rVm7zzRQjs6axI1UYWC3nmFA2E6FFSI,88
-satcube-0.1.0.dist-info/METADATA,sha256=Jcrxcsiq4oBkdJ2FEO6ClyOQpq4fUErsfDxv5s4bzfI,1124
-satcube-0.1.0.dist-info/RECORD,,