QUICKSTART.md

Quick Start Guide

This guide will get you up and running with the CDSE scripts in under 5 minutes.

Prerequisites

• Python 3.8+ installed
• Sentinel Hub account with CDSE access
• Your Client ID and Client Secret

Step 1: Setup

1. Install dependencies:

   pip install -r requirements.txt

2. Configure credentials:

   python scripts/setup_config.py

   Enter your Sentinel Hub credentials when prompted.

Step 2: Test Connection

python scripts/test_connection.py

If successful, you'll see "Connection successful!"

Step 3: Run Your First Extraction

Option A: Sentinel Hub Processing API (Recommended)

python scripts/example_vegetation_indices.py

This will extract NDVI, EVI, MNDWI, SAVI, BSI, and NDMI for the example area.

Option B: OpenEO API (Alternative)

python scripts/example_openeo_lake_monitoring.py

This demonstrates OpenEO workflows using Sentinel-3 SLSTR data for lake monitoring.

Step 4: Generate Visualizations

python scripts/example_visualization.py

View your results in the outputs/visualizations/ directory.

Configuration

• Time period: Currently set to 7 months (July 2023 - January 2024)
• Resolution: Fixed at 10 meters
• Study area: example_area.geojson (modify as needed)
• Cloud coverage: Maximum 30%

Customization

1. Change study area: Replace example_area.geojson with your own
2. Modify time period: Edit dates in the example scripts
3. Adjust parameters: Modify values in configs/my_config.json

Output Files

• Indices: outputs/indices/ (GeoTIFF format)
• Water mask: outputs/water_mask.tif
• True color: outputs/truecolor.tif
• Visualizations: outputs/visualizations/

Troubleshooting

• No data found: Extend time period or check study area
• Authentication error: Verify credentials in config file
• Empty outputs: Check geometry file format

Next Steps

• Explore the full README.md for detailed documentation
• Modify scripts for your specific research needs
• Integrate with your existing analysis workflows