Python API to SURFEX
Project description
Python API to SURFEX (pysurfex)
- An API in python to the external surface model SURFEX.
Prepare input and namelists to a SURFEX binary
Create atmospheric forcing for offline SURFEX runs
Read SURFEX output
Quality control of observations with titanlib
Optimal interpolation with gridpp
Monitor the observations usage
See online documentation in https://metno.github.io/pysurfex/
Installation of pregenerated packages from pypi (pip)
All releases will trigger an autmomatic pre-built package on pypi which can be installed by pip
pip3 install pysurfexUser installation:
pip3 install pysurfex --userRun pysurfex from pre-built container
Releases also trigger an update of the pysurfex container in the github container registry. Below is an example to run pgd without any arguments.
podman run -it ghcr.io/metno/pysurfex:latest poetry run pgdInstallation on debian based Linux system
Install the required pacakges (some might be obsolete if the pip packages contain the needed depedencies):
sudo apt-get update
sudo apt-get install -y libudunits2-dev libproj-dev libeccodes0 libeccodes-dev libnetcdf-dev netcdf-bin ca-certificatesThe following depencies are needed. Install the non-standard ones e.g. with pip or your system installation system.
General dependencies (from pypi)
numpy
pyproj
pyyaml
toml
f90nmlTo read NetCDF files:
NetCDF4
cfunitsTo read grib files:
eccodesfrom ECMWF https://software.ecmwf.int/wiki/display/ECC/Releases installed with ENABLE_PYTHON=ON
To plot:
matplotlibTo get observations from frost.met.no API:
requestsFor Quality control of observations
titanlibFor optimal interpolation and observation operators
gridppFor testing:
pytestInstall pysurfex
Download the source code, then install pysurfex by executing the following inside the extracted folder:
poetry installThis will install pysurfex in a poetry environment and this environment can be activated interactively by:
poetry shellor
Run pysurfex client applications
poetry run [command]
# e.g.
poetry run python # will run python inside the pysurfex poetry environmentRun pysurfex client applications
import sys
from pysurfex.cli import parse_args_surfex_binary, run_surfex_binary
argv = sys.argv[1:]
kwargs = parse_args_surfex_binary(argv, "pgd")
run_surfex_binary("pgd", **kwargs)Examples
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 pysurfex-0.0.4.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7a1ee7d1bce51fa4493d8e42700c257dbc2c59bc2ce747423ea615109e8877f8 |
|
| MD5 | 755682f966e870ffe956e74ff9161ae0 |
|
| BLAKE2b-256 | 66d9a641d74c9af8b266213d9fd5eb2b7b89c0adb745c56514501476d59ac502 |
