A Python utility for downloading Sentinel-1 Orbit files from the Registry of Open Data on AWS
Project description
s1-orbits
A Python utility for downloading Sentinel-1 Orbit files from the Registry of Open Data on AWS.
>>> import s1_orbits
>>> orbit_file = s1_orbits.fetch_for_scene('S1A_IW_SLC__1SDV_20230727T075102_20230727T075131_049606_05F70A_AE0A')
>>> orbit_file
PosixPath('S1A_OPER_AUX_POEORB_OPOD_20230816T080815_V20230726T225942_20230728T005942.EOF')
Installation
In order to easily manage dependencies, we recommend using dedicated project environments via Anaconda/Miniconda or Python virtual environments.
s1_orbits
can be installed into a conda environment with:
conda install -c conda-forge s1_orbits
or into a virtual environment with:
python -m pip install s1_orbits
Usage
s1-orbits provides one function - fetch_for_scene
- to download the "best available" orbit file for a given scene. This means it will download the AUX_POEORB file if it exists; otherwise, it will download the AUX_RESORB file. For a more full-featured API, see sentineleof or CDSE's APIs.
fetch_for_scene(scene: str, dir: Union[pathlib.Path, str] = '.') -> pathlib.Path
"""
For the given scene, downloads the AUX_POEORB file if available, otherwise downloads the AUX_RESORB file.
Args:
scene: The scene name for which to download the orbit file.
dir: The directory that the orbit file should download into.
Raises:
InvalidSceneError: Thrown if the scene name is not a proper Sentinel-1 scene name.
OrbitNotFoundError: Thrown if an orbit cannot be found for the provided scene.
Returns:
download_path: The path to the downloaded file.
"""
Development
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for s1_orbits-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 465e66116d402ee738fc5c7fbc5bf16adfc1604f8103a2d887d72649540fbc1d |
|
MD5 | fd890bc51c4ed2436517f414a673ae3c |
|
BLAKE2b-256 | 2078b5fbe0224b2faf5f63db441d411326c1680a8d04baa51820f52b3632380d |