ADF Basics

Now that the ADF and environment have been set up, let’s take just a quick look at what the ADF actually does and the flow of it. To run the ADF, there are just a couple of steps and then it’s good to go!

---

ADF Setup

A simple look at the steps for using the ADF

0. Run CAM/other simulation to get ADF input files
   history files (ie: h0, h1, etc.)
   time series files (ie: C/AMIP)

1. Configure copies of yaml file(s) for the input files
   config_cam_baseline_example.yaml - required
   lib/adf_variable_defaults.yaml - optional

2. Run the ADF
   simple command line call: ./run_adf_diag <your config file>.yaml

3. View Diagnostics
   Locally
   Jupyter/JupyterHub
   Publish to website

ADF Flow

A simple look at the flow of the ADF
 ↳ Create time series files from monthly history files (if they don’t exist or are being overwritten)
  ↳ Create climatology files from either ADF generated or pre-existing time series files (ie CMIP)
   ↳ Regrid Test case from Baseline case and vice-versa from climatology files
    ↳ Run Analysis scripts
     ↳ Run Plotting scripts
      ↳ Generate Website pages

** Most parts of the ADF are optional and can be turned off for your desired need:

Potential Examples:

• If you only want regridded data, turn off plotting, analysis, website parts

• If you want plotting and only need a few plot images, you can turn off the website part

• If you only want time series files, you can turn off all other parts

• If you don’t care about the statistics (AMWG) tables, turn off analysis part

• etc.

---

ADF Layout

A simple look at the structure of the ADF directories

.
|-- config_amwg_default_plots.yaml
|-- config_cam_baseline_example.yaml
|-- env
|   `-- conda_environment.yaml
|-- jupyter_sample.ipynb
|-- lib
|   |-- adf_base.py
|   |-- adf_config.py
|   |-- adf_diag.py
|   |-- adf_info.py
|   |-- adf_obs.py
|   |-- adf_variable_defaults.yaml
|   |-- adf_web.py
|   |-- plotting_functions.py
|   |-- test
|   |   |-- pylintrc
|   |   `-- unit_tests
|   |       |-- pytest.ini
|   |       |-- test_adf_base.py
|   |       |-- test_adf_config.py
|   |       `-- test_files
|   |           |-- config_cam_double_nested.yaml
|   |           |-- config_cam_keywords.yaml
|   |           `-- config_cam_unset_var.yaml
|   `-- website_templates
|       |-- adf_diag.css
|       |-- NCAR.gif
|       |-- template.html
|       |-- template_index.html
|       |-- template_mean_diag.html
|       |-- template_mean_tables.html
|       |-- template_multi_case_index.html
|       |-- template_table.html
|       `-- template_var.html
|-- LICENSE
|-- README.md
|-- run_adf_diag
`-- scripts
    |-- analysis
    |   `-- amwg_table.py
    |-- averaging
    |   `-- create_climo_files.py
    |-- plotting
    |   |-- cam_taylor_diagram.py
    |   |-- global_latlon_map.py
    |   |-- global_latlon_vect_map.py
    |   |-- meridional_mean.py
    |   |-- polar_map.py
    |   |-- qbo.py
    |   |-- regional_map_multicase.py
    |   `-- zonal_mean.py
    `-- regridding
        `-- regrid_and_vert_interp.py