scripts.plotting.ozone_diagnostics
==================================

.. py:module:: scripts.plotting.ozone_diagnostics


Functions
---------

.. autoapisummary::

   scripts.plotting.ozone_diagnostics.ozone_diagnostics


Module Contents
---------------

.. py:function:: ozone_diagnostics(adfobj)

   Generates an ozone-specific diagnostics based on the previous ncl-based
   diagnostics package.  Current package plots ozone sesasonal cycle, profiles, and
   taylor diagrams.

   Created 19 January, 2024
   Shawn Honomichl
   Associate Scientist III
   NCAR/ACOM
   shawnh@ucar.edu

   Functions
   ---------
   ozone_diagnostics(adfobj)
       use ADF object to make maps

   define_regions(InputRegion)

   define_stations(InputStation)

   open_process_sonde_data_simone(obsdir)

   open_process_sonde_data_simone_v2(obsdir)

   Subplot_O3(ax,X0,Y0,X1,Model0,Model1,SondeMean,SondeLow,SondeHigh,PLevel,plottype,case_base,case_test,ylim,Quadrant,Compare_Obs)

   Plot_Seasonal_Cycle_Profile(X0,X01,Y0,X1,X11,Y1,X2,X22,Y2,X3,X33,Y3,SondeMean0,SondeMean1,SondeMean2,SondeMean3,SondeLow0,SondeLow1,SondeLow2,SondeLow3,SondeHigh0,SondeHigh1,SondeHigh2,SondeHigh3,Model0I,Model01I,Model1I,Model11I,Model2I,Model21I,Model3I,Model31I,ylim0,ylim1,ylim2,ylim3,PLevel0,PLevel1,PLevel2,PLevel3,case_base,case_test,Station,oFile,plottype,Compare_Obs)

   get_model_data(ClimoFile)

   process_model_seasonal_cycle(MinLon,MaxLon,MinLat,MaxLat,Model_Dat,pnew,intyp,kxtrp,Station_Lons,Station_Lats)

   process_model_profiles(Model_Dat,O3_0,PS_0,pnew,intyp,kxtrp,ILAT,ILON,lat_0,lon_0)

   taylor_plot_setup(ax,baseline)

   taylor_stats_single(casedata, refdata)

   plot_taylor_data(wks, df,k, **kwargs)

   taylor_plot_finalize(wks, casenames, casecolors, syear_cases, eyear_cases, SubZones, needs_bias_labels=False,needs_case_labels=False,needs_subzone_labels=False)

       Parameters
       ----------
       adfobj : AdfDiag
           The diagnostics object that contains all the configuration information

       Returns
       -------
       Does not return a value; produces plots and saves files.

       Notes
       -----
       This function imports `pandas` and `plotting_functions`

       It uses the AdfDiag object's methods to get necessary information.
       Specificially:
       adfobj.diag_var_list
           List of variables
       adfobj.get_basic_info
           Regrid data path, checks `compare_obs`, checks `redo_plot`, checks `plot_press_levels`
       adfobj.plot_location
           output plot path
       adfobj.get_cam_info
           Get `cam_case_name` and `case_nickname`
       adfobj.climo_yrs
           start and end climo years of the case(s), `syears` & `eyears`
           start and end climo years of the reference, `syear_baseline` & `eyear_baseline`
       adfobj.var_obs_dict
           reference data (conditional)
       adfobj.get_baseline_info
           get reference case, `cam_case_name`
       adfobj.variable_defaults
           dict of variable-specific plot preferences
       adfobj.read_config_var
           dict of basic info, `diag_basic_info`
           Then use to check `plot_type`
       adfobj.compare_obs
           Used to set data path
       adfobj.debug_log
           Issues debug message
       adfobj.add_website_data
           Communicates information to the website generator