Framework for interactive monitoring and diagnostic analyses of the ACCESS model suite.
The ACCESS-NRI Model Live Diagnostics framework is designed to provide useful and practical Jupyter-based tools for interactive monitoring and diagnostic analyses of currently running (aka 'live') ACCESS climate models on the Australian NCI supercomputer Gadi.
The primary purpose of the ACCESS-NRI Model Live Diagnostics package is to provide a simple, easy to use and accessible framework for the ACCESS modelling community to check, monitor, visualise and evaluate model behaviour and progress on currently running or ‘live’ ACCESS models on Gadi. In addition to monitoring a live model, the package provides the functionality to load, visualise and compare legacy ACCESS model data with the selected live user model.
This package is actively developed within the Model Evaluation Team at Australia's climate simulator (ACCESS-NRI). It supports ACCESS-CM2, ACCESS-CM3, ACCESS-OM2, ACCESS-OM3, ACCESS-ESM1.5, ACCESS-ESM1.6, ACCESS-AM3 and MOM6 output.
A session opens an interactive interface in your notebook with four collapsible sections:
- Load and plot user data. Builds an intake catalogue from your live model output, so you can load any of its datasets and plot a variable as a line plot, heatmap, or an interactive heatmap. Sliders let you slice through extra dimensions such as ocean depth.
- Load and plot reference models. Loads any model of the same type from the ACCESS-NRI Intake Catalogue and plots its data with the same controls.
- Overlay user and reference models. Overlays line plots or shows heatmaps side by side for your run and as many reference models as you like, and can plot the difference between them to highlight discrepancies.
- Run analysis recipes. Runs ready-made analyses on your data, such as the Niño 3.4 index, area-weighted regional mean timeseries, or optionally load your own custom analyses.
You can also choose how many years of output to load, write your own analysis recipes and have them appear in the interface, and work with the loaded data directly in Python.
We value your feedback, especially in the form of reporting issues/bugs or suggesting ways to improve the framework. To do so, please open an issue.
The med-diagnostics package is pre-installed in the Gadi ACCESS-NRI analysis3 conda environment. To use this environment for your ARE JupyterLab session simply set the following parameters in the ARE JupyterLab 'Advanced options':
| Module directories | /g/data/xp65/public/modules |
| Modules | conda/analysis3 |
Alternatively, the med-diagnostics package can be installed directly into your chosen conda environment on Gadi either from the access-nri conda channel or PyPI.
| conda | conda install -c accessnri med-diagnostics |
| PyPI | pip install med-diagnostics |
To use the med-diagnostics package use: import med_diagnostics
The full documentation, including tutorials on getting started, the built-in analysis recipes, adding custom analyses and advanced usage, is available from readthedocs. The tutorial sources are in the documentation/docs/notebooks directory.
| Documentation | |
| Package |   |
| License |  |