s3lst-ds 0.1.1

A package for downscaling Sentinel-3 LST data using a scale-invariance-based model.

s3lst-ds: a package for downscaling Sentinel-3 LST data using a scale-invariance-based model

s3lst-ds provides pipelines for conveniently querying, downloading, filtering and downscaling Sentinel-3 LST data using either single or multi-timestamp scale-invariance-based models.

(Base) Installation

• Install the latest stable release from PyPI in the activated virtual environment using pip command:

  pip install s3lst-ds
  

  or uv:

  uv add s3lst-ds
  

Set CDSE credentials

CDSE credentials are required to download the Sentinel-3 data and must be safely set as environment variables in the system. This may be done through an appropriate script, either using the respective executable:

VENV/bin/s3lst-ds-set-cdse

(where VENV is the path to the installation directory of the virtual environment (e.g. .venv)), or, more conveniently, using uv:

uv run s3lst-ds-set-cdse

[!NOTE] The credentials will be written to file ~/.config/cdse_credentials.sh with read and write permissions solely issued to the user.

Note that if the user would like to remove the credentials at a later time, an appropriate script could be run through the respective excutable:

VENV/bin/s3lst-ds-unset-cdse

or, using uv:

uv run s3lst-ds-unset-cdse

(Optional) Snappy Installation

The base installation considers rioxarray for georeferencing the Sentinel-3 products. However, snappy has been found to produce better results, and, because of that, it is herein availed as an optional tool. The installation of this extra dependency requires two steps, in the following order:

1. Installation of the snappy Python package using pip:

   pip install s3lst-ds[snap]
   

   or uv:

   uv add s3lst-ds[snap]
   

2. Installation of the backend SNAP Java package and subsequent configuration using the respective executable:

   VENV/bin/s3lst-ds-install-snap
   

   or, more conveniently, using uv:

   uv run s3lst-ds-install-snap
   

[!WARNING] It is important to note that SNAP is configured with a limited amount of memory. To increase SNAP's maximum heap memory to for instance 64 GB, one would need to open file esa_snappy.ini nested in the installation directory of the virtual environment (herein assumed to be VENV) by doing

nano VENV/lib/python3.12/site-packages/esa_snappy/esa_snappy.ini

and writing in it:

[DEFAULT]
java_max_mem: 64G

[!NOTE] If the user would to like to uninstall SNAP at a later time, an appropriate script may be used, either through the respective executable:

VENV/bin/s3lst-ds-uninstall-snap

or, more conveniently, using uv:

uv run s3lst-ds-uninstall-snap

Documentation

To be built.

Development

Installation of development dependencies

• Create the development environment using all dependency groups:

  uv sync --all-groups
  

Linting

• Use ruff for Python linting:

  uv run ruff check --fix --diff
  

  The command above will check for bugs, suspicious code, style violations, dead code, complexity issues and import problems. It will further proposed fixes.

• Apply the fixes:

  uv run ruff check --fix
  

Formatting

• Use ruff for Python formatting:

  uv run ruff format --diff
  

  The command above will check the code structure, namely, the indentation, spaces, line breaks, quote style and long line wrapping. It will further show the proposed changes.

• Apply the changes:

  uv run ruff format
  

License

Pingi is licensed under the terms of the MIT license.