Sentinel EOF

https://pypi.org/project/sentineleof/
Admin
Tool to download Sentinel 1 precise/restituted orbit files (.EOF files) for processing SLCs.
Tokens:3,494
Snippets:37
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install sentineleof using pip

Source: https://pypi.org/project/sentineleof/0.12.0

Install the sentineleof package using pip. This command ensures you get the specific version 0.12.0.

```bash
pip install sentineleof==0.12.0
```

--------------------------------

### Install sentineleof using conda

Source: https://pypi.org/project/sentineleof/0.12.0

Install the sentineleof package using conda from the conda-forge channel.

```bash
conda install -c conda-forge sentineleof
```

--------------------------------

### Install sentineleof using pip

Source: https://pypi.org/project/sentineleof

Use this command to install the sentineleof package via pip. This makes the 'eof' executable available on your system's PATH.

```bash
pip install sentineleof
```

--------------------------------

### Command Line Help for eof Tool

Source: https://pypi.org/project/sentineleof/0.12.0

Displays all available options and their descriptions for the 'eof' command-line tool. Use this to understand various parameters for downloading Sentinel precise orbit files.

```bash
$ eof --help
Usage: eof [OPTIONS]

  Download Sentinel precise orbit files.

  Saves files to `save-dir` (default = current directory)

  Download EOFs for specific date, or searches for Sentinel files in --path.
  Will find both ".SAFE" and ".zip" files matching Sentinel-1 naming
  convention. With no arguments, searches current directory for Sentinel 1
  products

Options:
  -p, --search-path DIRECTORY     Path of interest for finding Sentinel
                                  products.   [default: .]
  --save-dir DIRECTORY            Directory to save output .EOF files into
                                  [default: .]
  --sentinel-file PATH            Specify path to download only 1 .EOF for a
                                  Sentinel-1 file/folder
  -d, --date TEXT                 Alternative to specifying Sentinel products: 
                                  choose date to download for.
  -m, --mission [S1A|S1B|S1C]     If using `--date`, optionally specify
                                  Sentinel satellite to download (default:
                                  gets S1A, S1B, and S1C)
  --orbit-type [precise|restituted]
                                  Optionally specify the type of orbit file to
                                  get (default: precise (POEORB), but fallback
                                  to restituted (RESORB))
  --force-asf                     Force the downloader to search ASF instead
                                  of ESA.
  --debug                         Set logging level to DEBUG
  --cdse-access-token TEXT        Copernicus Data Space Ecosystem access-
                                  token. The access token can be generated
                                  beforehand. See https://documentation.datasp
                                  ace.copernicus.eu/APIs/Token.html
  --cdse-user TEXT                Copernicus Data Space Ecosystem username. If
                                  not provided the program asks for it
  --cdse-password TEXT            Copernicus Data Space Ecosystem password. If
                                  not provided the program asks for it
  --cdse-2fa-token TEXT           Copernicus Data Space Ecosystem Two-Factor
                                  Token. Optional, unless 2FA Authentification
                                  has been enabled in user profile.
  --ask-password                  ask for passwords interactively if needed
  --update-netrc                  save credentials provided interactively in
                                  the ~/.netrc file if necessary
  --netrc-file TEXT               Path to .netrc file. Default: ~/.netrc
  --max-workers INTEGER           Number of parallel downloads to run. Note
                                  that CDSE has a limit of 4
  --help                          Show this message and exit.

```

--------------------------------

### Sentinel EOF Downloader CLI Help

Source: https://pypi.org/project/sentineleof

Displays the full list of available options and usage instructions for the command-line tool. Use this to understand all configurable parameters for downloading Sentinel precise orbit files.

```bash
$ eof --help
Usage: eof [OPTIONS]

  Download Sentinel precise orbit files.

  Saves files to `save-dir` (default = current directory)

  Download EOFs for specific date, or searches for Sentinel files in --path.
  Will find both ".SAFE" and ".zip" files matching Sentinel-1 naming
  convention. With no arguments, searches current directory for Sentinel 1
  products

Options:
  -p, --search-path DIRECTORY     Path of interest for finding Sentinel
                                  products.   [default: .]
  --save-dir DIRECTORY            Directory to save output .EOF files into
                                  [default: .]
  --sentinel-file PATH            Specify path to download only 1 .EOF for a
                                  Sentinel-1 file/folder
  -d, --date TEXT                 Alternative to specifying Sentinel products:
                                  choose date to download for.
  -m, --mission [S1A|S1B|S1C]     If using `--date`, optionally specify
                                  Sentinel satellite to download (default:
                                  gets S1A, S1B, and S1C)
  --orbit-type [precise|restituted]
                                  Optionally specify the type of orbit file to
                                  get (default: precise (POEORB), but fallback
                                  to restituted (RESORB))
  --force-asf                     Force the downloader to search ASF instead
                                  of ESA.
  --debug                         Set logging level to DEBUG
  --cdse-access-token TEXT        Copernicus Data Space Ecosystem access-
                                  token. The access token can be generated
                                  beforehand. See https://documentation.datasp
                                  ace.copernicus.eu/APIs/Token.html
  --cdse-user TEXT                Copernicus Data Space Ecosystem username. If
                                  not provided the program asks for it
  --cdse-password TEXT            Copernicus Data Space Ecosystem password. If
                                  not provided the program asks for it
  --cdse-2fa-token TEXT           Copernicus Data Space Ecosystem Two-Factor
                                  Token. Optional, unless 2FA Authentification
                                  has been enabled in user profile.
  --ask-password                  ask for passwords interactively if needed
  --update-netrc                  save credentials provided interactively in
                                  the ~/.netrc file if necessary
  --netrc-file TEXT               Path to .netrc file. Default: ~/.netrc
  --max-workers INTEGER           Number of parallel downloads to run. Note
                                  that CDSE has a limit of 4
  --help                          Show this message and exit.

```

--------------------------------

### Run eof tool with search path and save directory

Source: https://pypi.org/project/sentineleof/0.12.0

Use the 'eof' command with specific paths to search for Sentinel 1 scenes and save the downloaded orbit files. The tool will create the save directory if it does not exist.

```bash
eof --search-path /path/to/safe_files/ --save-dir ./orbits/
```

--------------------------------

### Configure .netrc for CDSE authentication

Source: https://pypi.org/project/sentineleof/0.12.0

Configure your ~/.netrc file (or _netrc on Windows) with your Copernicus Data Space Ecosystem (CDSE) credentials. This is required for authenticated downloads.

```ini
machine dataspace.copernicus.eu
  login MYUSERNAME
  password MYPASSWORD

```

--------------------------------

### Run eof tool to download orbit files

Source: https://pypi.org/project/sentineleof/0.12.0

Execute the 'eof' command to automatically download precise or restituted orbit files for Sentinel 1 scenes found in your working directory. This assumes .netrc is configured.

```bash
eof
```

--------------------------------

### Force download from ASF S3 bucket

Source: https://pypi.org/project/sentineleof

This flag bypasses the default Copernicus Data Space Ecosystem (CDSE) and forces the tool to download orbit files directly from the ASF public S3 bucket. No Earthdata credentials are required when using this option.

```bash
--force-asf
```

--------------------------------

### Python Function to Download EOFs

Source: https://pypi.org/project/sentineleof/0.12.0

Use the `download_eofs` function from the `eof.download` module to fetch precise orbit files. It accepts dates as datetime objects or strings and can optionally filter by mission.

```python
from eof.download import download_eofs

download_eofs([datetime.datetime(2018, 5, 3, 0, 0, 0)])
```

```python
download_eofs(['20180503', '20180507'], ['S1A', 'S1B', 'S1C'])
```

--------------------------------

### Force ASF S3 bucket usage

Source: https://pypi.org/project/sentineleof/0.12.0

Bypass the default Copernicus Data Space Ecosystem (CDSE) and force the use of the ASF S3 bucket for downloading orbit files by using the --force-asf flag.

```bash
eof --force-asf
```
Tokens:
Raw