ascat
Read and visualize data from the Advanced Scatterometer (ASCAT) on-board the series of Metop satellites.
Citation
If you use the software in a publication then please cite it using the Zenodo DOI. Be aware that this badge links to the latest package version.
Please select your specific version at https://doi.org/10.5281/zenodo.4610836 to get the DOI of that version. You should normally always use the DOI for the specific version of your record in citations. This is to ensure that other researchers can access the exact research artefact you used for reproducibility.
You can find additional information regarding DOI versioning at http://help.zenodo.org/#versioning
Installation
ASCAT data are distributed in BUFR, NetCDF, EPS Native and GRIB format. Unfortunately the GRIB reader does not work on Windows, so if you need that format then Linux or OS X are your only options.
Install the latest release from PyPI:
pip install ascat
Reading H SAF GRIB products requires pygrib, which is available through the
optional grib extra (Linux/OS X only):
pip install ascat[grib]
Supported datasets
This gives a short overview over the supported products. Please see the documentation for detailed examples of how to work with a product.
Read ASCAT data from different sources into a common format supported by pytesmo.
- H SAF
- Surface Soil Moisture (SSM) and Root Zone Soil Moisture (RZSM) products
- Copernicus Global Land Service (CGLS)
- CGLS Soil Water Index (SWI) products
- EUMETSAT
- ASCAT Soil Moisture at 12.5 km Swath Grid - Metop
- ASCAT Soil Moisture at 25 km Swath Grid - Metop
- ASCAT GDS Level 1 Sigma0 resampled at 12.5 km Swath Grid - Metop
- ASCAT GDS Level 1 Sigma0 resampled at 25 km Swath Grid - Metop
Command line interface
The latest ASCAT swath files (H122, H29, H129, H121) can be aggregated and/or regridded using a command line interface (CLI) provided by the ascat package.
Aggregation of ASCAT SSM swath files
Surface soil moisture and backscatter40 from ASCAT swath files can be aggregated over a user-defined time period (e.g. 1 day, 10 days, 1 month) choosing one of the following methods: "mean", "median", "mode", "std", "min", "max", "argmin", "argmax", "quantile", "first", "last". The time span for processing is determined by the start and end times specified. Additionally, thresholds can be set for masks - such as those for frozen soil probability, snow cover probability, subsurface scattering probability, and surface soil moisture sensitivity - to filter surface soil moisture data as part of the aggregation process.
By default, data from all Metop satellites will be aggregated together. To aggregate from a subset of satellites, pass a regex matching any combination of "A", "B", and "C" to the --sat argument. E.g. --sat A, --sat [AB], --sat *, --sat [ABC], etc.
ascat_swath_agg /path/to/input/h129_v1.0/swaths/ /path/to/output --start_dt 2020-06-15T00:00:00 --end_dt 2020-06-17T00:00:00 --t_delta 1D --agg mean --snow_cover_mask 80 --frozen_soil_mask 80 --subsurface_scattering_mask 10 --ssm_sensitivity_mask 1 --sat [AB]
There is also an option that no masking is applied using the argument --no-mask.
Re-gridding of ASCAT SSM swath files
ASCAT swath files contain data that are provided on a Discrete Global Grid (DGG) and can be converted to a regular lat/lon grid using a nearest neighbor approach. Either a single swath file or folder containing the swath files can be used as input argument.
ascat_swath_regrid /path/to/input/file /path/to/output 0.1 --grid_store /path/to/tmp/folder --suffix _regrid_0.1deg
Resampling of ASCAT SSM swath files
ASCAT swath files contain data that are provided on a Discrete Global Grid (DGG) and can be converted to a regular lat/lon grid using an inverse distance weighting. Either a single swath file or folder containing the swath files can be used as input argument.
ascat_swath_resample /path/to/input/file /path/to/output 0.1 --grid_store /path/to/tmp/folder --suffix _resample_0.1deg --neighbour 6 --radius 10000
Contribute
We are happy if you want to contribute. Please raise an issue explaining what is missing or if you find a bug. We will also gladly accept pull requests for new features or bug fixes.
Guidelines
If you want to contribute please follow these steps:
- Fork the ascat repository to your account
- Clone the repository, make sure you use
git clone --recursiveto also get the test data repository. - Set up the development environment with uv:
uv sync(add--extra gribfor GRIB support) - Make a new feature branch from the ascat master branch
- Add your feature
- Please include tests for your contributions in one of the test directories
- Run the tests with
uv run pytest - Submit a pull request
1 maintainer
Metadata
1 maintainer
Release files for ascat 2.8.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ascat-2.8.1.tar.gz | 347.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ascat-2.8.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 742.1 kB
Release files / ascat-2.8.1.tar.gz
| Download URL | ascat-2.8.1.tar.gz |
|---|---|
| Size | 347.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2cb405a54d54de8436addef6cfed84fcc11871ef86e313b7ba892a12d5441c2a
|
|
BLAKE2b-256 checksum How to use checksums |
e2f8c6bc6bb89b278014ac1828892cb395dff42043fe0f790925ea902132727f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.10 {"installer":{"name":"uv","version":"0.12.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / ascat-2.8.1-py3-none-any.whl
| Download URL | ascat-2.8.1-py3-none-any.whl |
|---|---|
| Size | 395.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ef90dbe95485069d4d23060d705a3608aa28ac1774a6bf6c099fbf6d9abf17e2
|
|
BLAKE2b-256 checksum How to use checksums |
df566e5b384604771d30150c877586d79127150d27d07a4f6a8135be7ce3b1ba
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.10 {"installer":{"name":"uv","version":"0.12.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
