Skip to main content

Python API to SURFEX

Project description

https://coveralls.io/repos/github/metno/pysurfex/badge.svg?branch=master

https://coveralls.io/github/metno/pysurfex

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

  • A scheduler setup to run offline SURFEX experiments

  • 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)

pip3 install pysurfex

User installation:

pip3 install pysurfex --user

Installation 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

The following depencies are needed. Install the non-standard ones e.g. with pip or your system installation system.

General dependencies (from pypi)

numpy
netCDF4
cfunits
pyproj
pyyaml
toml
netCDF4
f90nml
requests

To read NetCDF files:

NetCDF4

To read grib files:

eccodes

from ECMWF https://software.ecmwf.int/wiki/display/ECC/Releases installed with ENABLE_PYTHON=ON

To plot:

matplotlib

To get observations from frost.met.no API:

requests

For Quality control of observations

titanlib
db-sqlite3

For optimal interpolation and observation operators

gridpp

For testing:

pytest

Download the source code, then install pysurfex by executing the following inside the extracted folder:

Install pysurfex

poetry install

Create documentation

cd docs
# Create html documentation
make html

Examples

See https://metno.github.io/pysurfex/#examples

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pysurfex-0.0.3.1.tar.gz (136.7 kB view hashes)

Uploaded Source

Built Distribution

pysurfex-0.0.3.1-py3-none-any.whl (148.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page