Φ-Down Logo

Contents:

  • Getting Started
    • Prerequisites
    • Install Phi-Down
    • Configure S3 Credentials
    • First Search
    • First Download
    • Useful Next Steps
    • Common Issues
  • Installation
    • Requirements
    • Install from PyPI
    • Optional Dependency Groups
    • Install from Source
    • Using PDM
    • Install s5cmd
    • Configure .s5cfg
    • Verification
    • Troubleshooting
  • Command-Line Interface
    • Basic Usage
    • Download Commands
    • Download Modes
    • Listing Products
    • Burst Coverage Analysis
    • Examples
  • User Guide
    • Search Workflow
    • Common Filters
    • Manual Pagination With skip
    • Search by Product Name
    • .s5cfg Configuration
    • Downloads
    • Command Line Usage
    • Interactive Polygon Tools
    • Plotting Footprints
    • AIS Data
    • Tips
  • AIS Data Handler
    • Installation
    • Quick Start
      • Basic Usage
      • Time Filtering
      • Spatial Filtering with AOI
    • Advanced Usage
      • Using the AISDataHandler Class
      • Custom Hugging Face Repository
    • Data Format
    • Error Handling
    • Time Window Filtering
    • Spatial Filtering
    • Dependencies
    • Performance Notes
  • API Reference
    • phidown
      • Submodules
        • phidown.__main__
        • phidown.ais
        • phidown.cli
        • phidown.download_state
        • phidown.downloader
        • phidown.insar_workflow
        • phidown.interactive_tools
        • phidown.native_download
        • phidown.s5cmd_utils
        • phidown.search
        • phidown.viz
    • Main Classes and Functions
      • Search Module
      • Downloader Module
      • Visualization Module
      • Interactive Tools Module
  • Examples
    • Example 1: Sentinel-2 Search
    • Example 2: Query by Product Name
    • Example 3: Batch Download
    • Example 4: CLI Listing
    • Example 5: Burst Coverage Analysis
    • Example 6: Interactive Polygon Search
    • Example 7: Plot Product Footprints
    • Example 8: AIS Filtering
    • Example 9: Manual Pagination With skip
  • Burst Mode: Sentinel-1 SLC Burst Search and Download
    • Overview
    • What are Sentinel-1 Bursts?
      • Key Characteristics
    • Searching for Bursts
      • Enabling Burst Mode
      • Available Burst Parameters
    • Search Examples
      • Example 1: Basic Burst Search with Temporal Filter
      • Example 2: Burst Search with Spatial Filter (AOI)
      • Example 3: Search by Specific Burst ID
      • Example 4: Filter by Swath and Polarization
      • Example 5: Search Bursts from a Specific Parent Product
      • Example 6: Filter by Orbit Parameters
      • Example 7: Advanced Multi-Parameter Search
    • Downloading Bursts
      • Authentication
      • On-Demand Burst Download
      • Complete Download Workflow
    • Common Use Cases
      • InSAR Time Series
      • Regional Analysis
      • Product Decomposition
      • Systematic Monitoring
    • Valid Parameter Values
    • Important Notes
    • API Reference
      • get_token()
      • download_burst_on_demand()
  • Sentinel-1 Reference Guide
    • Overview
    • Search Parameters
      • Basic Parameters
        • Collection Name
      • Geographic Parameters
        • Geometry
      • Product Parameters
        • Product Types
        • Processing Level
        • Platform Serial Identifier
        • Swath Identifier
        • Instrument
        • Operational Mode
      • Orbit Parameters
        • Orbit Direction
        • Orbit Number
        • Relative Orbit Number
      • Polarization
      • Quality and Timeliness
        • Timeliness
        • Processing Baseline
        • Status
    • Practical Examples
      • Example 1: Basic IW GRD Search
      • Example 2: Interferometric SLC Search
      • Example 3: Ocean Applications
      • Example 4: Time Series Analysis
      • Example 5: Multi-Platform Search
    • Search Optimization Tips
    • Common Use Cases
    • Technical Specifications
  • Sentinel-1 SLC Burst Mode
    • Overview
    • What are Sentinel-1 Bursts?
    • Getting Started
      • Basic Burst Search
    • Burst-Specific Parameters
      • Core Identifiers
      • Swath and Acquisition
      • Polarization and Platform
      • Orbit Parameters
    • Common Use Cases
      • 1. InSAR Time Series Analysis
      • 2. Regional Coverage Analysis
      • 3. Parent Product Decomposition
      • 4. Multi-Parameter Filtering
    • Burst Result Structure
    • Combining with Standard Filters
      • Temporal Filtering
      • Spatial Filtering (AOI)
      • Orbit Direction
      • Result Pagination
    • Best Practices
    • API Endpoint
    • Examples Notebook
    • Troubleshooting
      • Common Issues
      • Debugging
    • API Reference
    • See Also
    • External Resources
  • Sentinel-2 Reference Guide
    • Overview
    • Search Parameters
      • Basic Parameters
        • Collection Name
      • Geographic Parameters
        • Geometry
        • Tile Identifier
      • Product Parameters
        • Product Types
        • Processing Level
        • Platform Serial Identifier
        • Instrument Short Name
        • Sensor Mode
      • Cloud Cover
        • Cloud Cover Percentage
      • Orbit Parameters
        • Orbit Direction
        • Orbit Number
        • Relative Orbit Number
      • Quality and Processing
        • Processing Baseline
        • Status
        • Mission Take ID
    • Practical Examples
      • Example 1: Basic Level-1C Search
      • Example 2: Level-2A Surface Reflectance
      • Example 3: Specific Tile Search
      • Example 4: Time Series Analysis
      • Example 5: Multi-Platform Comparison
      • Example 6: Processing Baseline Filtering
    • Search Optimization Tips
    • Common Use Cases
    • Technical Specifications
  • Sentinel-3 Reference Guide
    • Overview
    • Search Parameters
      • Basic Parameters
        • Collection Name
      • Geographic Parameters
        • Geometry
      • Product Parameters
        • Product Types
        • Processing Level
        • Platform Serial Identifier
        • Instrument Short Name
      • Cloud Cover
        • Cloud Cover Percentage
      • Orbit Parameters
        • Orbit Direction
        • Orbit Number
        • Relative Orbit Number
      • Quality and Timeliness
        • Timeliness
        • Processing Baseline
      • Additional Coverage Attributes
        • Coverage Types
        • Orbit Cycle Parameters
        • Other Attributes
    • Practical Examples
      • Example 1: Ocean Color Monitoring
      • Example 2: Land Surface Temperature
      • Example 3: Altimetry for Ocean Monitoring
      • Example 4: Synergy Products for Vegetation
      • Example 5: Fire Detection
      • Example 6: Multi-Platform Time Series
    • Search Optimization Tips
    • Common Use Cases
    • Technical Specifications
  • Landsat-8 Reference Guide
    • Overview
    • Search Parameters
      • Basic Parameters
        • Collection Name
      • Geographic Parameters
        • Geometry
      • Product Parameters
        • Product Types
        • Processing Level
        • Platform
        • Instrument
        • Sensor Mode
      • Cloud Cover
        • Cloud Cover Percentage
      • WRS-2 Path/Row Parameters
        • Path and Row
      • Orbit Parameters
        • Orbit Number
      • Solar Angle Parameters
        • Sun Azimuth and Elevation
      • Data Provider
        • Organisation Name
      • Quality and Status
        • Status
    • Practical Examples
      • Example 1: Agricultural Monitoring
      • Example 2: Urban Heat Island Analysis
      • Example 3: Forest Change Detection
      • Example 4: Coastal Water Quality
      • Example 5: Seasonal Vegetation Analysis
      • Example 6: Solar Angle Optimization
    • Search Optimization Tips
    • Common Use Cases
    • Technical Specifications
  • CCM (Copernicus Contributing Missions) Reference Guide
    • Overview
    • Registration and Access
    • Common Use Cases
    • Troubleshooting
    • Additional Resources
  • Contributing
    • Development Setup
    • Current Tooling
    • Running Tests
    • Linting
    • Documentation
    • Contribution Checklist
    • PR Notes
  • Changelog
    • [Unreleased]
    • [0.1.26] - 2026-03-15
    • [0.1.22] - 2025-10-18
    • [0.1.21] - 2025-10-17
    • [0.1.20] - 2025-10-07
    • [0.1.19] - 2024-09-20
    • [0.1.18] - 2024-08-19
    • [0.1.17] - 2024-08-01
    • [0.1.16] - 2024-07-15
    • [0.1.13] - 2024-12-XX
    • [0.1.12] - 2024-11-XX
    • [0.1.11] - 2024-10-XX
    • [0.1.10] - 2024-09-XX
    • [0.1.9] - 2024-08-XX
    • [0.1.8] - 2024-07-XX
    • [0.1.7] - 2024-06-XX
    • [0.1.6] - 2024-05-XX
    • [0.1.5] - 2024-04-XX
    • [0.1.4] - 2024-03-XX
    • [0.1.3] - 2024-02-XX
    • [0.1.2] - 2024-01-XX
    • [0.1.1] - 2023-12-XX
    • [0.1.0] - 2023-11-XX
  • Migration Guide
    • From 0.1.12 to 0.1.13
    • From 0.1.11 to 0.1.12
    • From 0.1.10 to 0.1.11
  • Support Policy
Φ-Down
  • Overview: module code

All modules for which code is available

  • phidown.ais
  • phidown.cli
  • phidown.download_state
  • phidown.downloader
  • phidown.insar_workflow
  • phidown.interactive_tools
  • phidown.native_download
  • phidown.s5cmd_utils
  • phidown.search
  • phidown.viz

© Copyright 2025, Roberto Del Prete.

Built with Sphinx using a theme provided by Read the Docs.