Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nishsilva committed Jan 24, 2025
1 parent 9c25e79 commit 6578f81
Showing 1 changed file with 27 additions and 15 deletions.
42 changes: 27 additions & 15 deletions diagnostics/MDSL/doc/MDSL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,21 +30,6 @@ Observed/Reference DATA

We use two reference MDSL products from National Center for Space Studies (CNES) and Technical University Denmark (DTU). For the alongcoast MDSL we use tide-gauge data as a reference in addition to the above mentioned reference products. The reference datasets (MDSL and Tide Gaude) are available at ~diagnostics/MDSL/Ref_data

Functionality
-------------
The core functionality of the package can be explined by the functionality of the MDSL.py file. The code routine of the MDSL.py file is segmented into **six parts**

** Part 1:** Read in the model data utilizing the pre determined data_catalog in the runtime configuration file. Several runtime config files are avaialble as examples in {\i ~diagnostics/MDSL/Example_files}



.. figure:: ./MDSL_Schematic.png
:align: center
:width: 75 %

**Figure 1**: A schematic showing the MDSL diagnostic's functionality.


Required Programing Language and libraries
------------------------------------------
The package was coded in python version 3.12.2
Expand All @@ -70,6 +55,33 @@ Model output variable - *zos* : sea_surface_height_above_geoid
Model has to be called using a data catalog. We used the MDTF catalog_builder to build
data catalogs for the models that we tested for the package.

Functionality
-------------
The core functionality of the package can be explained by the functionality of the MDSL.py file. The code routine of the MDSL.py file is segmented into **seven sections**.

** Section 1**: Sets up parameters. Here, you can pre-set the parameters for the model data and the NCH calculation.

** Section 2**: Reads in the "zos" data utilizing the pre-determined data catalog in the runtime configuration file (Several runtime config files are available as examples in ~diagnostics/MDSL/Example_files). Once read in the model data is subset into the reference data time period (1993-2012) and the time mean is computed.

** Section 3**: Reads in the native and re-gridded reference products (DTU and CNES) from the **["OBS_DATA_ROOT"]**.

** Section 4**: This section sets up regions for the regional NCH calculations. The current version of the package sets up six regions that include - California, Leeuwin, Gulf Stream, Kuroshio, East Australia, and Norway.

** Section 5**: First re-grid reference data on regional domains to the model grid. Then calculates the MDSL error for the regional domain (NCH calculation). Also calculates the coastal NCH using tide gauge information. Finally, plots the outputs for each region (see **Figure 2**).

** Section 6**: First re-grids the model to a global 1-degree or 0.5-degree grid (based on the rez parameter in Section 1). Then calculates the MDSL error globally and produces a plot similar to **Figure 3**.

**Section 7**: Closes the catalog files and disposes of the variable reference.

**Section 8**: Prints the successful run of the package and exits from the system.


.. figure:: ./MDSL_Schematic.png
:align: center
:width: 75 %

**Figure 1**: A schematic showing the MDSL diagnostic's functionality.

Diagnostic Outputs
------------------
The diagnostics provides regional and global MDSL outputs.
Expand Down

0 comments on commit 6578f81

Please sign in to comment.