Skip to main content

s1wvcalibration

Geophysical calibration of Sentinel-1 Wave Mode (WV) observations.

Actions Status Documentation Status

PyPI version PyPI platforms Coverage

Purpose

s1wvcalibration computes a geophysical calibration constant (a bias in dB) for Sentinel-1 Wave Mode acquisitions. WV mode has no corner reflectors or transponders, so the calibration is relative: each 20x20 km WV imagette is compared against an empirical Geophysical Model Function (GMF) — CMOD5n — fed with colocated ECMWF winds. The difference between the (denoised) SAR NRCS and the GMF-predicted NRCS is the calibration bias, computed per sub-swath (WV1 / WV2).

The library is a clean-room re-packaging of the long-running Ifremer MPC-Sentinel1 WV calibration pipeline (computeWVconstantecalibration.py).

Reading the products

  • Level-1 SLC (.tiff measurement) — read with xsar, which replaces the legacy cerbere/sarimage mapper.
  • Level-2 OCN (.nc measurement) — read directly with xarray.

GMF (NRCS model)

The GMF NRCS is computed with xsarsea (windspeed.get_model("cmod5n")), which replaces the legacy sar.utils.gmf.

Configuration

All cluster-specific paths and calibration constants live in a packaged config.yaml, overridable by a localconfig.yaml (or $S1WVCALIB_CONFIG). This replaces the legacy shared_information module.

Dependencies

Package Role
xsar Sentinel-1 Level-1 SLC reader
xsarsea GMF (cmod5n / cmod5 / cmodifremer) NRCS models
numpy, scipy numerical core
xarray, netCDF4, h5netcdf NetCDF I/O

Installation

pip install s1wvcalibration

Usage

Run the calibration for a single SAFE:

s1wvcalib \
  --input-safe /path/to/S1A_WV_SLC__1SSV_...SAFE \
  --ecmwf 0100 \
  --overwrite

Full CLI reference:

usage: s1wvcalib [-h] [-o OUTPUT] -i INPUT [--maxlat MAXLAT]
                 [--ecmwf {0125,0100}] [--overwrite] [--dev] [-v]

Per-SAFE NetCDF calibration files are written under the configured analysis_dir (see config.yaml).

Configuration

The packaged config.yaml holds the root_directory (under which all the paths.* entries are resolved) and the calibration constants (high-latitude threshold, wind ranges, ECMWF version, ...). To point the library at your cluster's data tree, drop a localconfig.yaml next to it (or set $S1WVCALIB_CONFIG to its path); it is deep-merged over the defaults, so a single-leaf override is enough:

# localconfig.yaml
paths:
  root_directory: /path/to/mpc-sentinel1

Project structure

s1wvcalibration/
├── src/
│   └── s1wvcalibration/
│       ├── __init__.py        # Package entry point, exposes __version__
│       ├── calibration.py     # Core calibration engine + CLI entry point
│       ├── config.py          # config.yaml loading (replaces shared_information)
│       ├── config.yaml        # Default paths & calibration constants
│       └── _legacy/           # Modules ported from mpcsentinellibs
│                              # (gmf, xsar_reader, ecmwf, ww3, ...)
├── tests/
│   ├── test_package.py        # Package metadata tests
│   ├── test_gmf_parity.py     # GMF / azimuth parity vs the legacy code
│   ├── test_l1_parity.py      # L1 reader parity vs a production NetCDF
│   └── test_netcdf_parity.py  # End-to-end NetCDF parity
├── docs/                      # Sphinx documentation
├── pyproject.toml
└── README.md

Metadata

Release files for s1wvcalibration 2026.10.13

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for s1wvcalibration 2026.10.13
File Size Uploaded Provenance Actions
s1wvcalibration-2026.10.13.tar.gz 37.5 kB With provenance Details for s1wvcalibration-2026.10.13.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for s1wvcalibration 2026.10.13
File Interpreter ABI Platform Actions
s1wvcalibration-2026.10.13-py3-none-any.whl Python 3 none any Details for s1wvcalibration-2026.10.13-py3-none-any.whl

Total release size: 82.7 kB

Release files / s1wvcalibration-2026.10.13.tar.gz

Download URL s1wvcalibration-2026.10.13.tar.gz
Size 37.5 kB
Tags Source
SHA-256 checksum
How to use checksums
ccbba7c1d949d2e1b84f29d0dd983571846bea6eb9fa0e0569aa845617881638
BLAKE2b-256 checksum
How to use checksums
4fe04d0bd81dd5ffc28591ba81c24041bd3b5ce230bd1cf9f5eab7abc8abfc73
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 13, 2026.

Transparency log

Release files / s1wvcalibration-2026.10.13-py3-none-any.whl

Download URL s1wvcalibration-2026.10.13-py3-none-any.whl
Size 45.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3dd42b444cdc50cf0ba08232cb000e74b0f5c458f6c409ab5239d224bdf02b2c
BLAKE2b-256 checksum
How to use checksums
db8b100b1409e49c17c5b036931c82470f1c2647f9f2b6559e1a5869dac8d4f2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 13, 2026.

Transparency log

Security for s1wvcalibration 2026.10.13

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for s1wvcalibration-2026.10.13.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 13, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page