Skip to content

Latest commit

 

History

History
101 lines (71 loc) · 4.44 KB

README.md

File metadata and controls

101 lines (71 loc) · 4.44 KB
Raw

ADF diagnostics

Framework Unit Tests pre-commit CC BY 4.0

This repository contains the Atmosphere Model Working Group (AMWG) Diagnostics Framework (ADF) diagnostics python package, which includes numerous different averaging, re-gridding, and plotting scripts, most of which are provided by users of CAM itself.

Specifically, this package is currently designed to generate standard climatological comparisons between either two different CAM simulations, or between a CAM simulation and observational and reanalysis datasets. Ideally this will allow for a quick evaluation of a CAM simulation, without requiring the user to generate numerous different figures on their own.

Currently, this package only uses standard CAM monthly time-slice (h0) outputs or single-variable monthly time series files. However, if there is user interest then additional model input options can be added.

Finally, if you are interested in general (but non-supported) tools used by AMP scientists and engineers in their work, then please check out the AMP Toolbox.

Required software environment

These diagnostics currently require Python version 3.6 or higher. They also require the following non-standard python libraries/modules:

  • PyYAML
  • Numpy
  • Xarray
  • Matplotlib
  • Cartopy
  • GeoCAT

If one wants to generate the "AMWG" model variable statistics table as well, then these additional python libraries are also needed:

  • Scipy
  • Pandas

On NCAR's CISL machines (cheyenne and casper), these can be loaded by running the following on the command line:

module load conda
conda activate npl

If you are using conda on a non-CISL machine, then you can create and activate the appropriate python enviroment using the env/conda_environment.yaml file like so:

conda env create -f env/conda_environment.yaml
conda activate adf_v0.11

Also, along with these python requirements, the ncrcat NetCDF Operator (NCO) is also needed. On the CISL machines this can be loaded by simply running:

module load nco

or on the CGD machines by simply running:

module load tool/nco

on the command line.

Finally, if you also want to run the Climate Variability Diagnostics Package (CVDP) as part of the ADF then you'll also need NCL. On the CISL machines this can be done using the command:

module load ncl

or on the CGD machines by using the command:

module load tool/ncl/6.6.2

on the command line.

Running ADF diagnostics

Detailed instructions for users and developers are availabe on this repository's wiki.

To run an example of the ADF diagnostics, simply download this repo, setup your computing environment as described in the Required software environment section above, modify the config_cam_baseline_example.yaml file (or create one of your own) to point to the relevant diretories and run:

./run_adf_diag config_cam_baseline_example.yaml

This should generate a collection of time series files, climatology (climo) files, re-gridded climo files, and example ADF diagnostic figures, all in their respective directories.

ADF Tutorial/Demo

Jupyter Book detailing the ADF including ADF basics, guided examples, quick runs, and references

Troubleshooting

Any problems or issues with this software should be posted on the ADF discussions page located online here.

Please note that registration may be required before a message can be posted. However, feel free to search the forums for similar issues (and possible solutions) without needing to register or sign in.

Good luck, and have a great day!

This work is licensed under a Creative Commons Attribution 4.0 International License.

CC BY 4.0