Skip to content

Instantly share code, notes, and snippets.

View chengzhuzhang's full-sized avatar

Jill Chengzhu Zhang chengzhuzhang

View GitHub Profile
@chengzhuzhang
chengzhuzhang / add_diags_to_e3sm_diags.md
Last active June 14, 2019 21:47 — forked from zshaheen/add_diags_to_e3sm_diags.md
How to Add Diagnostics to E3SM Diagnostics

How to Add Diagnostics to E3SM Diagnostics

Introduction

When planning to expand the current diagnostic sets, efforts have been made to structure the e3sm_diags code base in a more modularized and expandable fashion. The developers will be able to add new diagnostics easily and cleanly. This guide documents essential steps for guiding the users to add custom diagnostics by providing an example. If a user has a streamlined python script for a complete analysis, from read in file, data manipulate, computation, and visualization, it should be straightforward to take below steps to add the analysis to e3sm_diags.

First off, to develop, you must have an e3sm_diags development environment installed.

In this document, we will be explaining by example the process of adding a diagnostics set into e3sm_diags. If you have any questions or issues regarding this, please make a Github issue [on the e3sm_diags r