""" PointStat: CESM and FLUXNET2015 Terrestrial Coupling Index (TCI) ====================================================================== model_applications/land_surface/PointStat_fcstCESM_obsFLUXNET2015_TCI.conf """ ############################################################################## # Scientific Objective # -------------------- # This use case ingests two CESM (CAM and CLM) files and a new FLUX2015 dataset (NETCDF) that Paul Dirmeyer, GMU prepared from FLUXNET2015 ASCII dataset. # The use case will calculate Terrestrial Coupling Index (TCI) from CESM datasets. # Utilizing Python embedding, this use case taps into a new vital observation dataset and compares it to CESM simulations TCI forecast. # Finally, it will generate plots of model TCI and observed TCI. ############################################################################## # Datasets # --------------------- # # | **Forecast:** CESM 1979-1983 Simulations a. Community Land Model (CLM) and b. Community Atmosphere Model (CAM) # # | **Observations:** FLUXNET2015 post processed and converted to NETCDF. This data includes data collected from multiple regional flux towers. # # # | **Location:** All of the input data required for this use case can be found in the met_test sample data tarball. Click here to the METplus releases page and download sample data for the appropriate release: https://github.com/dtcenter/METplus/releases # | This tarball should be unpacked into the directory that you will set the value of INPUT_BASE. See `Running METplus`_ section for more information. # # | **Data Source:** CESM - CGD; FLUXNET2015 - Paul Dirmeyer ############################################################################## # METplus Components # ------------------ # # This use case utilizes the METplus PyEmbedIngest to read the CESM files and calculate TCI using python embedding and a NETCDF file of the TCI is generated. # The METplus PointStat processes the output of PyEmbedIngest and FLUXNET2015 dataset (using python embedding), and outputs the requested line types. # Then METplus PlotPointObs tool reads the output of PyEmbedIngest and FLUXNET2015 dataset and produce plots of TCI from CESM and point observations. # A custom loop runs through all the pre-defined seasons (DJF, MAM, JJA, SON) and runs PyEmbedIngest, PointStat, and PlotPointObs. ############################################################################## # METplus Workflow # ---------------- # # The PyEmbedIngest tool reads 2 CESM files containing Soil Moisture and Sensible Heat Flux, each composed of daily forecasts from # 1979 to 1983 and calculates TCI and generates a NETCDF file of the TCI. One FLUXNET2015 NETCDF file containing station observations # of several variables including Coupling Index of Soil Moisture and Sensible Heat Flux is read by Python Embedding. # # | **Valid Beg:** 1979-01-01 at 00z # | **Valid End:** 1979-01-01 at 00z # # PointStat is used to compare the two new fields (TCI calculated from CESM dataset and FLUXNET2015). # Finally, PlotPointObs is run to plot the CESM TCI overlaying the FLUXNET2015 point observations. ############################################################################## # METplus Configuration # --------------------- # # METplus first loads all of the configuration files found in parm/metplus_config, # then it loads any configuration files passed to METplus via the command line # i.e. -c parm/use_cases/model_applications/land_surface/PointStat_fcstCESM_obsFLUXNET2015_TCI.conf # # .. highlight:: bash # .. literalinclude:: ../../../../parm/use_cases/model_applications/land_surface/PointStat_fcstCESM_obsFLUXNET2015_TCI.conf # ############################################################################## # MET Configuration # ----------------- # # METplus sets environment variables based on the values in the METplus configuration file. These variables are referenced in the MET configuration file. **YOU SHOULD NOT SET ANY OF THESE ENVIRONMENT VARIABLES YOURSELF! THEY WILL BE OVERWRITTEN BY METPLUS WHEN IT CALLS THE MET TOOLS!** If there is a setting in the MET configuration file that is not controlled by an environment variable, you can add additional environment variables to be set only within the METplus environment using the [user_env_vars] section of the METplus configuration files. See the ‘User Defined Config’ section on the ‘System Configuration’ page of the METplus User’s Guide for more information. # # .. highlight:: bash # .. literalinclude:: ../../../../parm/met_config/PointStatConfig_wrapped # ############################################################################## # Python Embedding # ---------------- # # This use case uses a Python embedding script to read input data # # parm/use_cases/model_applications/land_surface/PointStat_fcstCESM_obsFLUXNET2015_TCI/cesm_tci.py # # .. highlight:: python # .. literalinclude:: ../../../../parm/use_cases/model_applications/land_surface/PointStat_fcstCESM_obsFLUXNET2015_TCI/cesm_tci.py # # parm/use_cases/model_applications/land_surface/PointStat_fcstCESM_obsFLUXNET2015_TCI/fluxnet2015_tci.py # # .. highlight:: python # .. literalinclude:: ../../../../parm/use_cases/model_applications/land_surface/PointStat_fcstCESM_obsFLUXNET2015_TCI/fluxnet2015_tci.py # ############################################################################## # Running METplus # --------------- # # Pass the use case configuration file to the run_metplus.py script # along with any user-specific system configuration files if desired:: # # run_metplus.py /path/to/METplus/parm/use_cases/model_applications/land_surface/PointStat_fcstCESM_obsFLUXNET2015_TCI.conf /path/to/user_system.conf # # See :ref:`running-metplus` for more information. ############################################################################## # Expected Output # --------------- # # A successful run will output the following both to the screen and to the logfile:: # # INFO: METplus has successfully finished running. # # Refer to the value set for **OUTPUT_BASE** to find where the output data was generated. # Output for the use case will be found in 3 folders(relative to **OUTPUT_BASE**). # Those folders are: # # * PyEmbedIngest # # The **OUTPUT_BASE** folder contains all of the TCI output calculated using CESM files in NETCDF format: # # * regrid_data_plane_DJF.nc # * regrid_data_plane_JJA.nc # * regrid_data_plane_MAM.nc # * regrid_data_plane_SON.nc # # * PointStat # # The final folder, PointStat, contains all of the following output from the PointStat call: # # * point_stat_DJF_000000L_19790101_000000V_cnt.txt # * point_stat_DJF_000000L_19790101_000000V_ctc.txt # * point_stat_DJF_000000L_19790101_000000V_mpr.txt # * point_stat_DJF_000000L_19790101_000000V.stat # * point_stat_JJA_000000L_19790101_000000V_cnt.txt # * point_stat_JJA_000000L_19790101_000000V_ctc.txt # * point_stat_JJA_000000L_19790101_000000V_mpr.txt # * point_stat_JJA_000000L_19790101_000000V.stat # * point_stat_MAM_000000L_19790101_000000V_cnt.txt # * point_stat_MAM_000000L_19790101_000000V_ctc.txt # * point_stat_MAM_000000L_19790101_000000V_mpr.txt # * point_stat_MAM_000000L_19790101_000000V.stat # * point_stat_SON_000000L_19790101_000000V_cnt.txt # * point_stat_SON_000000L_19790101_000000V_ctc.txt # * point_stat_SON_000000L_19790101_000000V_mpr.txt # * point_stat_SON_000000L_19790101_000000V.stat # # * PlotPointObs # # The final folder plot_point_obs, contains all of the plots from the PlotPointObs call: # # * cesm_fluxnet2015_DJF.ps # * cesm_fluxnet2015_JJA.ps # * cesm_fluxnet2015_MAM.ps # * cesm_fluxnet2015_SON.ps # ############################################################################## # Keywords # -------- # # .. note:: # # * PyEmbedIngestToolUseCase # * PointStatToolUseCase # * PlotPointObsToolUseCase # * PythonEmbeddingFileUseCase # * NETCDFFileUseCase # * LandSurfaceAppUseCase # # Navigate to the :ref:`quick-search` page to discover other similar use cases. # # # # sphinx_gallery_thumbnail_path = '_static/land_surface-PointStat_fcstCESM_obsFLUXNET2015_TCI.png'