Φ-Down
Contents:
Getting Started
What is Φ-Down?
Prerequisites
First Steps
What’s Next?
Common Issues
Need Help?
Installation
Requirements
Dependencies
Installing from PyPI
Installing with Visualization Support
Installing from Source
Using PDM (Recommended for Development)
Conda Installation
Verification
Docker Installation
Troubleshooting
Upgrading
Uninstalling
User Guide
Setting Up S3 Credentials
Configuration File Method
Searching for Data
Basic Search
Search Parameters
Advanced Search
Supported Missions
Sentinel-1 (SAR)
Sentinel-2 (Optical)
Sentinel-3 (Ocean/Land)
Sentinel-5P (Atmospheric)
Working with Results
Displaying Results
Filtering Results
Downloading Data
Basic Download
Batch Download
Download with S3 (Faster)
Interactive Tools
Polygon Selection
Search with Polygon
Visualization
Best Practices
Error Handling
Configuration
Custom Configuration
Performance Tips
API Reference
phidown
Submodules
phidown.__main__
phidown.downloader
phidown.downloader_boto3_deprecated
phidown.interactive_tools
phidown.s5cmd_utils
phidown.search
phidown.viz
Classes
Functions
Package Contents
CopernicusDataSearcher
plot_kml_coordinates()
Main Classes and Functions
Search Module
Downloader Module
Visualization Module
Interactive Tools Module
Examples
Example 1: Basic Sentinel-2 Search
Example 2: Sentinel-1 SAR Data Search
Example 3: Multi-Mission Search
Example 4: Download with Progress Tracking
Example 5: Interactive Polygon Selection
Example 6: Time Series Analysis
Example 7: Batch Processing with Error Handling
Example 8: Advanced Filtering and Analysis
Example 9: Visualization and Mapping
Example 10: Configuration and Customization
Tips for Using Examples
Sentinel-1 Reference Guide
Overview
Search Parameters
Basic Parameters
Collection Name
Geographic Parameters
Geometry
Product Parameters
Product Types
Processing Level
Platform
Swath Identifier
Instrument
Sensor 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
Contributing
Getting Started
Development Setup
Development Tools
Setting Up Pre-commit
Virtual Environment
Running Tests
Writing Tests
Code Style
Formatting
Linting
Type Hints
Documentation
Writing Documentation
Building Documentation
Submitting Changes
Pull Request Process
Pull Request Template
Code Review
Bug Reports
Bug Report Template
Feature Requests
Feature Request Template
Development Guidelines
Adding New Features
Modifying Existing Code
Performance Considerations
Security
Release Process
Version Numbering
Community
Resources
Changelog
[Unreleased]
[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
|
I
|
L
|
M
|
O
|
P
|
Q
|
R
|
S
|
T
|
W
_
_add_aoi_filter() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
_add_attribute_filters() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
_add_cloud_cover_filter() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
_add_collection_filter() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
_add_date_filters() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
_add_orbit_direction_filter() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
_add_polygon() (phidown.interactive_tools.InteractivePolygonTool method)
_add_product_type_filter() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
_build_filter() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
_build_query() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
_change_basemap() (phidown.interactive_tools.InteractivePolygonTool method)
_clear_all() (phidown.interactive_tools.InteractivePolygonTool method)
_coordinates_to_wkt() (phidown.interactive_tools.InteractivePolygonTool method)
_copy_wkt() (phidown.interactive_tools.InteractivePolygonTool method)
_get_basemap_name() (phidown.interactive_tools.InteractivePolygonTool method)
_get_valid_product_types() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
_handle_data_change() (phidown.interactive_tools.InteractivePolygonTool method)
_handle_draw() (phidown.interactive_tools.InteractivePolygonTool method)
_initialize_placeholders() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
_load_config() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
_load_wkt() (phidown.interactive_tools.InteractivePolygonTool method)
_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)
_update_wkt_output() (phidown.interactive_tools.InteractivePolygonTool method)
_validate_aoi_wkt() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
_validate_attributes() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
_validate_cloud_cover_threshold() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
_validate_collection() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
_validate_orbit_direction() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
_validate_order_by() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
_validate_product_type() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
_validate_time() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
_validate_top() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
A
aoi_wkt (phidown.CopernicusDataSearcher attribute)
(phidown.search.CopernicusDataSearcher attribute)
attributes (phidown.CopernicusDataSearcher attribute)
(phidown.search.CopernicusDataSearcher attribute)
B
base_url (phidown.CopernicusDataSearcher attribute)
(phidown.search.CopernicusDataSearcher attribute)
basemap_layers (phidown.interactive_tools.InteractivePolygonTool attribute)
C
check_s3_access_from_token() (in module phidown.downloader_boto3_deprecated)
check_s3_permissions() (in module phidown.downloader_boto3_deprecated)
cloud_cover_threshold (phidown.CopernicusDataSearcher attribute)
(phidown.search.CopernicusDataSearcher attribute)
collection_name (phidown.CopernicusDataSearcher attribute)
(phidown.search.CopernicusDataSearcher attribute)
config (in module phidown.downloader_boto3_deprecated)
(phidown.CopernicusDataSearcher attribute)
(phidown.search.CopernicusDataSearcher attribute)
CopernicusDataSearcher (class in phidown)
(class in phidown.search)
count (phidown.CopernicusDataSearcher attribute)
(phidown.search.CopernicusDataSearcher attribute)
create_polygon_tool() (in module phidown.interactive_tools)
create_s3_client_with_retry() (in module phidown.downloader_boto3_deprecated)
current_basemap (phidown.interactive_tools.InteractivePolygonTool attribute)
D
display() (phidown.interactive_tools.InteractivePolygonTool method)
display_results() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
download() (in module phidown.s5cmd_utils)
download_file_s3() (in module phidown.downloader_boto3_deprecated)
download_product() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
download_s3_file_with_retry() (in module phidown.downloader_boto3_deprecated)
download_via_odata_api() (in module phidown.downloader_boto3_deprecated)
draw_control (phidown.interactive_tools.InteractivePolygonTool attribute)
E
end_date (phidown.CopernicusDataSearcher attribute)
(phidown.search.CopernicusDataSearcher attribute)
execute_query() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
F
format_filename() (in module phidown.downloader_boto3_deprecated)
G
get_access_token() (in module phidown.downloader_boto3_deprecated)
get_eo_product_details() (in module phidown.downloader_boto3_deprecated)
get_temporary_s3_credentials() (in module phidown.downloader_boto3_deprecated)
get_wkt_polygons() (phidown.interactive_tools.InteractivePolygonTool method)
I
InteractivePolygonTool (class in phidown.interactive_tools)
L
load_credentials() (in module phidown.downloader_boto3_deprecated)
logger (in module phidown.s5cmd_utils)
M
main() (in module phidown.__main__)
(in module phidown.downloader_boto3_deprecated)
map (phidown.interactive_tools.InteractivePolygonTool attribute)
module
phidown
phidown.__main__
phidown.downloader
phidown.downloader_boto3_deprecated
phidown.interactive_tools
phidown.s5cmd_utils
phidown.search
phidown.viz
O
orbit_direction (phidown.CopernicusDataSearcher attribute)
(phidown.search.CopernicusDataSearcher attribute)
order_by (phidown.CopernicusDataSearcher attribute)
(phidown.search.CopernicusDataSearcher attribute)
output (phidown.interactive_tools.InteractivePolygonTool attribute)
P
pandas (in module phidown.interactive_tools)
parse_s3_path() (in module phidown.downloader_boto3_deprecated)
parser (in module phidown.viz)
phidown
module
phidown.__main__
module
phidown.downloader
module
phidown.downloader_boto3_deprecated
module
phidown.interactive_tools
module
phidown.s5cmd_utils
module
phidown.search
module
phidown.viz
module
plot_kml_coordinates() (in module phidown)
(in module phidown.viz)
polygons (phidown.interactive_tools.InteractivePolygonTool attribute)
,
[1]
print_available_basemaps() (phidown.interactive_tools.InteractivePolygonTool method)
product_type (phidown.CopernicusDataSearcher attribute)
(phidown.search.CopernicusDataSearcher attribute)
pull_down() (in module phidown.downloader)
(in module phidown.downloader_boto3_deprecated)
Q
query_by_filter() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
query_by_name() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
R
run_s5cmd_with_config() (in module phidown.s5cmd_utils)
S
search_products_by_name_pattern() (phidown.CopernicusDataSearcher method)
(phidown.search.CopernicusDataSearcher method)
search_with_polygon() (in module phidown.interactive_tools)
show_basemap_switcher (phidown.interactive_tools.InteractivePolygonTool attribute)
,
[1]
start_date (phidown.CopernicusDataSearcher attribute)
(phidown.search.CopernicusDataSearcher attribute)
T
test_s3_connectivity() (in module phidown.downloader_boto3_deprecated)
test_s3_connectivity_detailed() (in module phidown.downloader_boto3_deprecated)
top (phidown.CopernicusDataSearcher attribute)
(phidown.search.CopernicusDataSearcher attribute)
traverse_and_download_s3() (in module phidown.downloader_boto3_deprecated)
W
wkt_output (phidown.interactive_tools.InteractivePolygonTool attribute)