Skip to main content

A python application that provides an easy way to set up, run, and monitor (long) Weather Research and Forecasting (WRF) simulations.

Project description

https://img.shields.io/badge/License-Apache%202.0-blue.svg https://travis-ci.org/ERA-URBAN/wrfpy.svg?branch=master https://zenodo.org/badge/DOI/10.5281/zenodo.1420109.svg https://badge.fury.io/py/WRFpy.svg

WRFpy

What is WRFpy:

WRFpy is a python application that provides an easy way to set up, run, and monitor (long) Weather Research and Forecasting (WRF) simulations. It provides a simple user-editable JSON configuration file and integrates with Cylc to access distributed computing and storage resources as well as monitoring. Optionally, WRFpy allows for data assimilation using WRF data assimilation system (WRFDA) and postprocessing of wrfinput files using the NCEP Unified Post Processing System (UPP).

Installation

WRFpy is installable via pip:

pip install wrfpy

Usage

WRFpy provides functionality depending on the used command-line switches:

usage: wrfpy [-h] [--init] [--create] [--basedir BASEDIR] suitename

WRFpy

positional arguments:
  suitename          name of suite

optional arguments:
  -h, --help         show this help message and exit
  --init             Initialize suite (default: False)
  --create           Create suite config (default: False)
  --basedir BASEDIR  basedir in which suites are installed (default:
                     ${HOME}/cylc-suites)

In order to set up a new cylc suite, we first need to initialize one. This is done using the following command:

wrfpy --init testsuite

This creates a configuration file (config.json) that needs to be filled in by the user before continueing. WRFpy points the user to the location of this file.

After the configuration file has been filled, it is time to create the actual configuration that will be used by the CYLC workflow engine. To create the CYLC suite, use the following command:

wrfpy --create testsuite

The final configuration lives in a file called suite.rc. If you want to make further (specialized) changes to the workflow by adding/tweaking steps, you can directly edit the suite.rc file with your favorite editor.

Now it is time to register the suite with CYLC. CYLC is available at

https://cylc.github.io/cylc/

and has great documentation. From now on you are using CYLC to control your WRF runs. Please consult the CYLC documentation for the relevant commands.

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

WRFpy-0.2.1.tar.gz (34.9 kB view details)

Uploaded Source

Built Distribution

WRFpy-0.2.1-py2-none-any.whl (51.2 kB view details)

Uploaded Python 2

File details

Details for the file WRFpy-0.2.1.tar.gz.

File metadata

  • Download URL: WRFpy-0.2.1.tar.gz
  • Upload date:
  • Size: 34.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/2.7.15

File hashes

Hashes for WRFpy-0.2.1.tar.gz
Algorithm Hash digest
SHA256 e31a9cbc5df83f4757a49cb1e9178f2b99108b9a1a22e28f4965207ffec2fed4
MD5 23690f1472cc92477d429ea085c61d0a
BLAKE2b-256 6d466ecf0a797b5e085af78ff1c9f211634c142836422184162e95bec6d3cce1

See more details on using hashes here.

File details

Details for the file WRFpy-0.2.1-py2-none-any.whl.

File metadata

  • Download URL: WRFpy-0.2.1-py2-none-any.whl
  • Upload date:
  • Size: 51.2 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/2.7.15

File hashes

Hashes for WRFpy-0.2.1-py2-none-any.whl
Algorithm Hash digest
SHA256 4ce3678790615d690881e93c5c463aa94886034a279b75fce13fed780d257979
MD5 6a9d695e05b3213cffcddc17f18a5026
BLAKE2b-256 0b3c7c1c0426b7b951bdb2392d791d433a4f9d8aa52c82405588ad2e314e566a

See more details on using hashes here.

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