Skip to main content

esm-viz allows you to monitor and visualize ongoing simulations

Project description

esm-viz Documentation Status

ESM Viz is a command line tool to schedule automatic monitoring of Earth System Model simulations.

First Steps

The easiest way to get started is:

$ esm_viz --help

This will display a series of options you can use. In order to set up automatic monitoring for an experiment, you can use esm_viz template


For AWI Users

On; the software is already installed.

For Other Users

There are several external packages that need to be installed in order for everything to work correctly. The easiest way to get everything in one go is:

$ pip install esm_viz

You can then type

$ esm_viz configure

This will ask open up a configuration file for you to edit.

Usage Demonstration

Interactively setting up a new monitoring job:

$ esm_viz

Setting up a monitoring job from a YAML file:

$ esm_viz </PATH/TO/EXPERIMENT.yaml>

Setting up a monitoring job from a YAML file already stored in ${HOME}/.config/monitoring

$ esm_viz EXPERIMENT


The .yaml extension is appended automatically!

Performing only certain parts of a job:

$ # Only schedule a job to run every 2 hours:
$ esm_viz schedule EXPERIMENT
$ # Schedule a job to run every 6 hours:
$ esm_viz schedule --frequency 6 EXPERIMENT
$ # Deploying monitoring scripts and running them on the supercomputer
$ # Note that the scripts actually run depend on the configuration file
$ esm_viz deploy EXPERIMENT
$ # Combining results into a webpage
$ esm_viz combine EXPERIMENT

In the next section, the command line interface and python modules are explained in more detail. Then, we show an explanation about how to customize what is shown in the plots. - - - -


  • TODO


This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.


Upcoming 0.9.6

  • Py2/Py3 agnostic FileNotFoundError
  • SSH Key generation
  • Installing with pip -v gives you a message about PATH and PYTHONPATH. However, the -v is required for this to show up. See here:

0.9.5 (2019-09-16)

Install seems to work for Chris. Dependencies still need to be more tightly controlled.

0.9.4 (2019-09-14)

Lots of changes since the last update. Missing history, sorry. Version 0.10.0 planned onces Christopher can monitor a job.

0.3.0 (2019-04-12)

Monitoring update to include ECHAM Global Timeseries

0.1.1 (2019-04-08)

Happy birthday to Paul!

  • Most of general analysis works for SLURM; only tested by Paul. PBS Queues are in principle possible, but untested. This should be expanded.

0.1.0 (2019-03-23)

  • Start of project in this repository. It has other history; but that is undocumented. See the proxy records…

Project details

Release history Release notifications

Download files

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

Files for esm-viz, version 0.9.7
Filename, size File type Python version Upload date Hashes
Filename, size esm_viz-0.9.7-py2.py3-none-any.whl (225.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size esm_viz-0.9.7.tar.gz (8.1 MB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page