Φ-Down
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
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
_
__post_init__() (phidown.insar_workflow.BurstSearchConfig method)
_add_aoi_filter() (phidown.search.CopernicusDataSearcher method)
_add_attribute_filters() (phidown.search.CopernicusDataSearcher method)
_add_burst_filters() (phidown.search.CopernicusDataSearcher method)
_add_cloud_cover_filter() (phidown.search.CopernicusDataSearcher method)
_add_collection_filter() (phidown.search.CopernicusDataSearcher method)
_add_coverage_column() (phidown.search.CopernicusDataSearcher method)
_add_date_filters() (phidown.search.CopernicusDataSearcher method)
_add_orbit_direction_filter() (phidown.search.CopernicusDataSearcher method)
_add_polygon() (phidown.interactive_tools.InteractivePolygonTool method)
_add_product_type_filter() (phidown.search.CopernicusDataSearcher method)
_ASIA_AUSTRALIA_LON_BOUNDS (phidown.search.CopernicusDataSearcher attribute)
_build_filter() (phidown.search.CopernicusDataSearcher method)
_build_query() (phidown.search.CopernicusDataSearcher method)
_build_record() (in module phidown.native_download)
_build_s3_client() (in module phidown.native_download)
_build_time_mask() (phidown.ais.AISDataHandler method)
_calculate_aoi_coverage() (phidown.search.CopernicusDataSearcher method)
_centroid_coordinates_from_body() (in module phidown.search)
_change_basemap() (phidown.interactive_tools.InteractivePolygonTool method)
_clear_all() (phidown.interactive_tools.InteractivePolygonTool method)
_compute_backoff_delay() (in module phidown.cli)
(in module phidown.downloader)
(in module phidown.s5cmd_utils)
(in module phidown.search)
_coordinates_from_sequence() (in module phidown.search)
_coordinates_to_wkt() (phidown.interactive_tools.InteractivePolygonTool method)
_copy_wkt() (phidown.interactive_tools.InteractivePolygonTool method)
_coverage_to_color() (in module phidown.viz)
_dir_has_files() (in module phidown.cli)
_download_root() (in module phidown.native_download)
_ensure_parent() (in module phidown.native_download)
_errors (phidown.ais.AISDataHandler attribute)
_EUROPE_AMERICA_LON_BOUNDS (phidown.search.CopernicusDataSearcher attribute)
_execute_paginated_query() (phidown.search.CopernicusDataSearcher method)
_existing_object_progress() (in module phidown.native_download)
_extract_date_start() (in module phidown.search)
_filter_by_aoi() (phidown.ais.AISDataHandler method)
_find_column() (phidown.ais.AISDataHandler method)
_geojson_coordinate_pairs() (in module phidown.viz)
_get_aoi_centroid() (phidown.search.CopernicusDataSearcher method)
_get_basemap_name() (phidown.interactive_tools.InteractivePolygonTool method)
_get_recommended_orbit_direction() (phidown.search.CopernicusDataSearcher method)
_get_valid_product_types() (phidown.search.CopernicusDataSearcher method)
_handle_data_change() (phidown.interactive_tools.InteractivePolygonTool method)
_handle_draw() (phidown.interactive_tools.InteractivePolygonTool method)
_import_boto3_modules() (in module phidown.native_download)
_initialize_placeholders() (phidown.search.CopernicusDataSearcher method)
_iterate_dates() (phidown.ais.AISDataHandler method)
_list_objects() (in module phidown.native_download)
_load() (phidown.download_state.DownloadStateStore method)
_load_ais_points() (phidown.ais.AISDataHandler method)
_load_config() (phidown.search.CopernicusDataSearcher method)
_load_wkt() (phidown.interactive_tools.InteractivePolygonTool method)
_main_list_subcommand() (in module phidown.cli)
_MATPLOTLIB_AVAILABLE (in module phidown.insar_workflow)
(in module phidown.search)
_normalize_column_key() (phidown.ais.AISDataHandler method)
_normalize_etag() (in module phidown.native_download)
_normalize_footprint() (in module phidown.viz)
_object_output_path() (in module phidown.native_download)
_object_state_map() (in module phidown.native_download)
_parse_bbox_to_wkt() (in module phidown.cli)
_parse_bool() (in module phidown.native_download)
_parse_cdse_s3_path() (in module phidown.native_download)
_parse_columns() (in module phidown.cli)
_parse_coordinate() (in module phidown.search)
_parse_date() (phidown.ais.AISDataHandler method)
_parse_time() (phidown.ais.AISDataHandler method)
_parse_wkt_geometry() (in module phidown.search)
_parse_wkt_polygon() (in module phidown.viz)
_persist() (phidown.download_state.DownloadStateStore method)
_platform_filter() (in module phidown.insar_workflow)
_read_s3_config() (in module phidown.native_download)
_resolve_download_mode() (in module phidown.cli)
_resolve_product_download_mode() (in module phidown.search)
_resolve_request_timeout() (in module phidown.downloader)
_save_coverage_plot() (in module phidown.insar_workflow)
_setup_basemap_layers() (phidown.interactive_tools.InteractivePolygonTool method)
_setup_controls() (phidown.interactive_tools.InteractivePolygonTool method)
_setup_map() (phidown.interactive_tools.InteractivePolygonTool method)
_setup_ui() (phidown.interactive_tools.InteractivePolygonTool method)
_SHAPELY_AVAILABLE (in module phidown.search)
_split_command_args() (in module phidown.s5cmd_utils)
_split_wkt_components() (in module phidown.search)
_state (phidown.download_state.DownloadStateStore attribute)
_stream_body_to_file() (in module phidown.native_download)
_strip_closing_coordinate() (in module phidown.search)
_strip_wrapping_quotes() (in module phidown.s5cmd_utils)
_SUBSWATH_PRIORITY (phidown.search.CopernicusDataSearcher attribute)
_SUPPORTED_AOI_WKT_TYPES (in module phidown.search)
_unwrap_wkt_group() (in module phidown.search)
_update_wkt_output() (phidown.interactive_tools.InteractivePolygonTool method)
_validate_aoi_wkt() (phidown.search.CopernicusDataSearcher method)
_validate_attributes() (phidown.search.CopernicusDataSearcher method)
_validate_burst_parameters() (phidown.search.CopernicusDataSearcher method)
_validate_cloud_cover_threshold() (phidown.search.CopernicusDataSearcher method)
_validate_collection() (phidown.search.CopernicusDataSearcher method)
_validate_coordinate() (in module phidown.search)
_validate_coordinate_sequence() (in module phidown.search)
_validate_linestring_body() (in module phidown.search)
_validate_list_args() (in module phidown.cli)
_validate_multilinestring_body() (in module phidown.search)
_validate_multipoint_body() (in module phidown.search)
_validate_multipolygon_body() (in module phidown.search)
_validate_orbit_direction() (phidown.search.CopernicusDataSearcher method)
_validate_order_by() (phidown.search.CopernicusDataSearcher method)
_validate_point_body() (in module phidown.search)
_validate_polygon_body() (in module phidown.search)
_validate_polygon_ring() (in module phidown.search)
_validate_product_type() (phidown.search.CopernicusDataSearcher method)
_validate_skip() (phidown.search.CopernicusDataSearcher method)
_validate_supported_aoi_wkt() (in module phidown.search)
_validate_time() (phidown.search.CopernicusDataSearcher method)
_validate_top() (phidown.search.CopernicusDataSearcher method)
_warn_deprecated_option() (in module phidown.cli)
_WKT_COORDINATE_RE (in module phidown.search)
_WKT_NUMBER_PATTERN (in module phidown.search)
A
absolute_burst_id (phidown.search.CopernicusDataSearcher attribute)
access_token (phidown.downloader.TokenManager attribute)
,
[1]
AISDataHandler (class in phidown.ais)
aoi_wkt (phidown.insar_workflow.BurstSearchConfig attribute)
(phidown.search.CopernicusDataSearcher attribute)
attributes (phidown.search.CopernicusDataSearcher attribute)
B
base_url (phidown.search.CopernicusDataSearcher attribute)
basemap_layers (phidown.interactive_tools.InteractivePolygonTool attribute)
bucket (phidown.native_download.S3ObjectMeta attribute)
build_burst_workflow_config() (in module phidown.insar_workflow)
burst_coverage_analysis() (in module phidown.cli)
burst_id (phidown.insar_workflow.BurstSearchConfig attribute)
(phidown.search.CopernicusDataSearcher attribute)
burst_mode (phidown.search.CopernicusDataSearcher attribute)
BurstSearchConfig (class in phidown.insar_workflow)
BurstWorkflowConfig (class in phidown.insar_workflow)
bytes_transferred (phidown.native_download.NativeDownloadResult attribute)
C
CLIENT_ID (in module phidown.downloader)
client_id (phidown.downloader.TokenManager attribute)
,
[1]
cloud_cover_threshold (phidown.search.CopernicusDataSearcher attribute)
collection_name (phidown.search.CopernicusDataSearcher attribute)
compute_burst_statistics() (in module phidown.insar_workflow)
compute_temporal_statistics() (phidown.search.CopernicusDataSearcher method)
config (phidown.search.CopernicusDataSearcher attribute)
CopernicusDataSearcher (class in phidown.search)
count (phidown.search.CopernicusDataSearcher attribute)
create_polygon_tool() (in module phidown.interactive_tools)
current_basemap (phidown.interactive_tools.InteractivePolygonTool attribute)
D
datatake_id (phidown.search.CopernicusDataSearcher attribute)
date_format (phidown.ais.AISDataHandler attribute)
,
[1]
debug_burst_summary() (in module phidown.insar_workflow)
default_state_file() (in module phidown.download_state)
display() (phidown.interactive_tools.InteractivePolygonTool method)
display_results() (phidown.search.CopernicusDataSearcher method)
download (in module phidown.s5cmd_utils)
download_ais_data() (in module phidown.ais)
download_burst_on_demand() (in module phidown.downloader)
,
[1]
download_bursts() (phidown.search.CopernicusDataSearcher method)
download_by_name() (in module phidown.cli)
download_by_s3path() (in module phidown.cli)
download_product() (phidown.search.CopernicusDataSearcher method)
download_products() (phidown.search.CopernicusDataSearcher method)
download_s3_resumable() (in module phidown.native_download)
DownloadStateStore (class in phidown.download_state)
draw_control (phidown.interactive_tools.InteractivePolygonTool attribute)
E
end_date (phidown.insar_workflow.BurstSearchConfig attribute)
(phidown.search.CopernicusDataSearcher attribute)
ensure_s5cmd_config() (in module phidown.s5cmd_utils)
etag (phidown.native_download.S3ObjectMeta attribute)
execute_query() (phidown.search.CopernicusDataSearcher method)
expiry (phidown.downloader.TokenManager attribute)
,
[1]
EXPIRY_BUFFER_SECONDS (phidown.downloader.TokenManager attribute)
F
file_template (phidown.ais.AISDataHandler attribute)
,
[1]
find_optimal_bursts() (phidown.search.CopernicusDataSearcher method)
find_optimal_orbit() (phidown.search.CopernicusDataSearcher method)
find_orbit_configuration() (in module phidown.insar_workflow)
G
get() (phidown.download_state.DownloadStateStore method)
get_access_token() (phidown.downloader.TokenManager method)
get_ais_data() (phidown.ais.AISDataHandler method)
get_directory_size() (in module phidown.s5cmd_utils)
get_errors() (phidown.ais.AISDataHandler method)
get_token() (in module phidown.downloader)
,
[1]
get_wkt_polygons() (phidown.interactive_tools.InteractivePolygonTool method)
H
hf_repo_id (phidown.ais.AISDataHandler attribute)
,
[1]
I
InteractivePolygonTool (class in phidown.interactive_tools)
is_non_empty_file() (in module phidown.download_state)
is_product_complete() (in module phidown.download_state)
K
key (phidown.native_download.S3ObjectMeta attribute)
L
list_products() (in module phidown.cli)
logger (in module phidown.cli)
(in module phidown.download_state)
(in module phidown.downloader)
(in module phidown.native_download)
(in module phidown.s5cmd_utils)
(in module phidown.search)
M
main() (in module phidown.cli)
(in module phidown.downloader)
map (phidown.interactive_tools.InteractivePolygonTool attribute)
mark() (phidown.download_state.DownloadStateStore method)
max_results (phidown.insar_workflow.BurstSearchConfig attribute)
module
phidown
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
N
NativeDownloadResult (class in phidown.native_download)
O
object_count (phidown.native_download.NativeDownloadResult attribute)
operational_mode (phidown.search.CopernicusDataSearcher attribute)
orbit_direction (phidown.insar_workflow.BurstSearchConfig attribute)
(phidown.search.CopernicusDataSearcher attribute)
order_by (phidown.search.CopernicusDataSearcher attribute)
output (phidown.interactive_tools.InteractivePolygonTool attribute)
output_path (phidown.native_download.NativeDownloadResult attribute)
output_statistics (phidown.insar_workflow.BurstWorkflowConfig attribute)
P
pandas (in module phidown.interactive_tools)
parent_product_id (phidown.search.CopernicusDataSearcher attribute)
parent_product_name (phidown.search.CopernicusDataSearcher attribute)
parent_product_type (phidown.search.CopernicusDataSearcher attribute)
parser (in module phidown.viz)
password (phidown.downloader.TokenManager attribute)
,
[1]
path (phidown.download_state.DownloadStateStore attribute)
phidown
module
phidown.__main__
module
phidown.ais
module
phidown.cli
module
phidown.download_state
module
phidown.downloader
module
phidown.insar_workflow
module
phidown.interactive_tools
module
phidown.native_download
module
phidown.s5cmd_utils
module
phidown.search
module
phidown.viz
module
platform_serial_identifier (phidown.search.CopernicusDataSearcher attribute)
platforms (phidown.insar_workflow.BurstSearchConfig attribute)
plot_kml_coordinates() (in module phidown.viz)
plot_product_footprints() (in module phidown.viz)
plot_temporal_distribution() (phidown.search.CopernicusDataSearcher method)
polarisation (phidown.insar_workflow.BurstSearchConfig attribute)
polarisation_channels (phidown.search.CopernicusDataSearcher attribute)
polygons (phidown.interactive_tools.InteractivePolygonTool attribute)
,
[1]
print_available_basemaps() (phidown.interactive_tools.InteractivePolygonTool method)
product_type (phidown.search.CopernicusDataSearcher attribute)
pull_down() (in module phidown.s5cmd_utils)
Q
query_by_filter() (phidown.search.CopernicusDataSearcher method)
query_by_name() (phidown.search.CopernicusDataSearcher method)
R
refresh_access_token() (phidown.downloader.TokenManager method)
relative_orbit (phidown.insar_workflow.BurstSearchConfig attribute)
relative_orbit_number (phidown.search.CopernicusDataSearcher attribute)
REQUEST_TIMEOUT_SECONDS (in module phidown.downloader)
(in module phidown.search)
run_burst_workflow() (in module phidown.insar_workflow)
run_s5cmd_with_config() (in module phidown.s5cmd_utils)
S
S3ObjectMeta (class in phidown.native_download)
save_results_csv (phidown.insar_workflow.BurstWorkflowConfig attribute)
save_workflow_outputs() (in module phidown.insar_workflow)
search (phidown.insar_workflow.BurstWorkflowConfig attribute)
search_bursts() (in module phidown.insar_workflow)
search_products_by_name_pattern() (phidown.search.CopernicusDataSearcher method)
search_with_polygon() (in module phidown.interactive_tools)
set() (phidown.download_state.DownloadStateStore method)
SHAPELY_AVAILABLE (in module phidown.ais)
show_basemap_switcher (phidown.interactive_tools.InteractivePolygonTool attribute)
,
[1]
size (phidown.native_download.S3ObjectMeta attribute)
skip (phidown.search.CopernicusDataSearcher attribute)
start_date (phidown.insar_workflow.BurstSearchConfig attribute)
(phidown.search.CopernicusDataSearcher attribute)
status (phidown.native_download.NativeDownloadResult attribute)
swath_identifier (phidown.insar_workflow.BurstSearchConfig attribute)
(phidown.search.CopernicusDataSearcher attribute)
T
TOKEN_URL (in module phidown.downloader)
token_url (phidown.downloader.TokenManager attribute)
,
[1]
TokenManager (class in phidown.downloader)
top (phidown.search.CopernicusDataSearcher attribute)
U
username (phidown.downloader.TokenManager attribute)
,
[1]
utc_now_iso() (in module phidown.download_state)
V
validate_burst_results() (in module phidown.insar_workflow)
verbose (phidown.ais.AISDataHandler attribute)
,
[1]
W
wkt_output (phidown.interactive_tools.InteractivePolygonTool attribute)