web
Web downloading utilities
CDDIS Archive Data downloader utilities.
Attributes
Classes
InvalidCDDISRequest
Bases: error_perm
Invalid e-mail authentication on CDDIS platform or file requested not found
Functions:
cddis_ftps_archive_downloader
cddis_ftps_archive_downloader(directory: str, filename: str, email: str, out_dir: str | Path) -> Path
Utility to download data from the CDDIS products archive.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
directory
|
str
|
directory on the server where to find the product to be downloaded |
required |
filename
|
str
|
name of the product to be downloaded |
required |
email
|
str
|
user e-mail for authentication purposes |
required |
out_dir
|
str | Path
|
output directory where to save the downloaded file |
required |
Returns:
| Type | Description |
|---|---|
Path
|
Path to the downloaded file on disk |
Ionosphere TEC maps downloader utilities.
Functions:
download_ionospheric_tec_maps
download_ionospheric_tec_maps(acq_date: PreciseDateTime, center: IonosphericAnalysisCenters, auth_email: str, output_dir: str | Path) -> Path
Fetching the ionospheric map for the acquisition time and analysis center provided from NASA CDDIS archive.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
acq_date
|
str
|
time of interest to retrieve the correct ionospheric data |
required |
center
|
PreciseDateTime
|
ionospheric map analysis center |
required |
auth_email
|
str
|
authentication e-mail of the user registered on the CDDIS portal |
required |
output_dir
|
str | Path
|
path to output directory where to save downloaded file |
required |
Returns:
| Type | Description |
|---|---|
Path
|
path to the downloaded map |
Troposphere products downloader utilities.
Attributes
Classes
TroposphericWebArchives
Bases: Enum
Tropospheric web archives where to download data from
Functions:
download_tropospheric_products
download_tropospheric_products(acq_date: PreciseDateTime, output_dir: str | Path, map_type: TroposphericMapType = TroposphericMapType.VMF3, map_grid_resolution: TroposphericGRIDResolution = TroposphericGRIDResolution.FINE) -> list[Path]
Fetching the tropospheric products for the input acquisition time from VMF archive.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
acq_date
|
PreciseDateTime
|
acquisition date of interest |
required |
output_dir
|
str | Path
|
path to output directory where to save downloaded files |
required |
map_type
|
TroposphericMapType
|
tropospheric product map type, by default TroposphericMapType.VMF3 |
VMF3
|
map_grid_resolution
|
TroposphericGRIDResolution
|
tropospheric GRID product map resolution, by default TroposphericGRIDResolution.FINE |
FINE
|
Returns:
| Type | Description |
|---|---|
Path
|
list of downloaded products Paths |