From 460db166b1bbc0e5966a2f0d4a6a3b75f54867aa Mon Sep 17 00:00:00 2001 From: jdkublnick <47824899+jdkublnick@users.noreply.github.com> Date: Fri, 13 Dec 2024 10:36:28 -0500 Subject: [PATCH 1/5] Added section for enabling output --- .../CustomizingTheUPP/EnablingOutput.rst | 60 +++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 doc/UserGuide/CustomizingTheUPP/EnablingOutput.rst diff --git a/doc/UserGuide/CustomizingTheUPP/EnablingOutput.rst b/doc/UserGuide/CustomizingTheUPP/EnablingOutput.rst new file mode 100644 index 000000000..9c15e64b1 --- /dev/null +++ b/doc/UserGuide/CustomizingTheUPP/EnablingOutput.rst @@ -0,0 +1,60 @@ +.. _enabling-Output: + +User-Defined Sigma Level Output +=================================== + +This documentation describes the steps to generate model output at user-defined sigma levels using the Unified Post Processor (UPP). The instructions address the configuration of XML files and the resolution of potential issues encountered during this process. + +Generating Sigma Level Output +----------------------------- + +UPP can output temperature, U, and V components on sigma surfaces. These correspond to indices 206, 208, and 209 in the GRIB2 table. Follow these steps to configure your workflow for this output: + +### Configuring XML Files + +1. **Locate XML Configuration Files**: + - Use the XML files in the `UPP/parm` directory as references. Specifically, the `post_avblflds.xml` file contains all the fields that UPP can output. + +2. **Modify Control XML**: + - Copy the entries for temperature, U, and V (indices 206, 208, and 209) from `post_avblflds.xml` to the control XML file used in your workflow. + +3. **Validation**: + - Validate the control XML file against the `EMC_POST_CTRL_Schema.xsd` schema. + +4. **Flat Text File Generation**: + - Convert the control XML to a flat text file, ensuring that it is validated as part of the process. + +### Sigma Levels + +By default, only certain sigma levels are outputted. These levels are in the source file `SET_LVLSXML.f` and can be found between lines 342 and 363. Users must: + +- **Verify Default Levels**: + Review these levels in the `SET_LVLSXML.f` source file to confirm their compatibility with your requirements. + +- **Add Tags**: + Include a `` tag in the XML configuration to explicitly define the sigma levels to be output. + +Required Source Code Modifications +---------------------------------- + +If the default sigma levels are insufficient, you must: + +1. **Modify `SET_LVLSXML.f`**: + - Change the entries for `ASIGO1` to include your desired sigma levels. + +2. **Recompile UPP**: + - Recompile the UPP source code after making the changes. + +3. **Update XML Tags**: + - Ensure that the XML tags explicitly reference the modified sigma levels. + +Important Notes +--------------- + +- Adding `` tags manually allows UPP to compile and run successfully, but it will not produce any output unless the levels are also modified in `SET_LVLSXML.f` and properly referenced. + +- Fortran I/O errors may occur if the sigma levels in the control file are not synchronized with the source code configuration. + +- Comprehensive documentation on control files can be found in the :ref:`control-file` UPP control file documentation, which provides details about XML file formatting and flat file generation. + +By following these steps, users can successfully configure UPP to generate model output on user-defined sigma levels while avoiding common pitfalls. From 6bc932a804a3cb67525f5b4a9b8dec0c100d2a2c Mon Sep 17 00:00:00 2001 From: jdkublnick <47824899+jdkublnick@users.noreply.github.com> Date: Fri, 13 Dec 2024 11:02:45 -0500 Subject: [PATCH 2/5] Added index file --- doc/UserGuide/CustomizingTheUPP/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/UserGuide/CustomizingTheUPP/index.rst b/doc/UserGuide/CustomizingTheUPP/index.rst index eb7f24bb0..a06c093ad 100644 --- a/doc/UserGuide/CustomizingTheUPP/index.rst +++ b/doc/UserGuide/CustomizingTheUPP/index.rst @@ -6,4 +6,5 @@ Customizing the UPP AddNewVariable Regridding + EnablingOutput From fdb86b5ca2d9adf9722472d60868853a37b35843 Mon Sep 17 00:00:00 2001 From: jdkublnick <47824899+jdkublnick@users.noreply.github.com> Date: Fri, 13 Dec 2024 11:51:07 -0500 Subject: [PATCH 3/5] RTD format changes --- doc/UserGuide/CustomizingTheUPP/EnablingOutput.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/UserGuide/CustomizingTheUPP/EnablingOutput.rst b/doc/UserGuide/CustomizingTheUPP/EnablingOutput.rst index 9c15e64b1..cfa1c6126 100644 --- a/doc/UserGuide/CustomizingTheUPP/EnablingOutput.rst +++ b/doc/UserGuide/CustomizingTheUPP/EnablingOutput.rst @@ -1,16 +1,17 @@ .. _enabling-Output: +******************************** User-Defined Sigma Level Output -=================================== +******************************** This documentation describes the steps to generate model output at user-defined sigma levels using the Unified Post Processor (UPP). The instructions address the configuration of XML files and the resolution of potential issues encountered during this process. Generating Sigma Level Output ----------------------------- -UPP can output temperature, U, and V components on sigma surfaces. These correspond to indices 206, 208, and 209 in the GRIB2 table. Follow these steps to configure your workflow for this output: +UPP can output temperature, U, and V components on sigma surfaces. These correspond to indices 206, 208, and 209 in the :term:`GRIB2`` table. Follow these steps to configure your workflow for this output: -### Configuring XML Files +**Configuring XML Files** 1. **Locate XML Configuration Files**: - Use the XML files in the `UPP/parm` directory as references. Specifically, the `post_avblflds.xml` file contains all the fields that UPP can output. @@ -24,7 +25,7 @@ UPP can output temperature, U, and V components on sigma surfaces. These corresp 4. **Flat Text File Generation**: - Convert the control XML to a flat text file, ensuring that it is validated as part of the process. -### Sigma Levels +**Sigma Levels** By default, only certain sigma levels are outputted. These levels are in the source file `SET_LVLSXML.f` and can be found between lines 342 and 363. Users must: @@ -55,6 +56,6 @@ Important Notes - Fortran I/O errors may occur if the sigma levels in the control file are not synchronized with the source code configuration. -- Comprehensive documentation on control files can be found in the :ref:`control-file` UPP control file documentation, which provides details about XML file formatting and flat file generation. +- Comprehensive documentation on control files can be found in the :ref:`control-file` documentation, which provides details about XML file formatting and flat file generation. By following these steps, users can successfully configure UPP to generate model output on user-defined sigma levels while avoiding common pitfalls. From 51d1556798afa5a1c726c4e4339f21b776cc6530 Mon Sep 17 00:00:00 2001 From: jdkublnick <47824899+jdkublnick@users.noreply.github.com> Date: Fri, 13 Dec 2024 13:00:24 -0500 Subject: [PATCH 4/5] added reference to text file chapter --- doc/UserGuide/CustomizingTheUPP/EnablingOutput.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/UserGuide/CustomizingTheUPP/EnablingOutput.rst b/doc/UserGuide/CustomizingTheUPP/EnablingOutput.rst index cfa1c6126..4de18cca8 100644 --- a/doc/UserGuide/CustomizingTheUPP/EnablingOutput.rst +++ b/doc/UserGuide/CustomizingTheUPP/EnablingOutput.rst @@ -23,7 +23,7 @@ UPP can output temperature, U, and V components on sigma surfaces. These corresp - Validate the control XML file against the `EMC_POST_CTRL_Schema.xsd` schema. 4. **Flat Text File Generation**: - - Convert the control XML to a flat text file, ensuring that it is validated as part of the process. + - Convert the control XML to a flat text file, ensuring that it is validated as part of the process. More information can be found in the :ref:`_create_txt_file` documentation. **Sigma Levels** From 7c7daa7871a2e9e63b7cf0457eb5ae98225df797 Mon Sep 17 00:00:00 2001 From: jdkublnick <47824899+jdkublnick@users.noreply.github.com> Date: Fri, 13 Dec 2024 13:21:18 -0500 Subject: [PATCH 5/5] Format fix --- doc/UserGuide/CustomizingTheUPP/EnablingOutput.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/UserGuide/CustomizingTheUPP/EnablingOutput.rst b/doc/UserGuide/CustomizingTheUPP/EnablingOutput.rst index 4de18cca8..fcec75541 100644 --- a/doc/UserGuide/CustomizingTheUPP/EnablingOutput.rst +++ b/doc/UserGuide/CustomizingTheUPP/EnablingOutput.rst @@ -23,7 +23,7 @@ UPP can output temperature, U, and V components on sigma surfaces. These corresp - Validate the control XML file against the `EMC_POST_CTRL_Schema.xsd` schema. 4. **Flat Text File Generation**: - - Convert the control XML to a flat text file, ensuring that it is validated as part of the process. More information can be found in the :ref:`_create_txt_file` documentation. + - Convert the control XML to a flat text file, ensuring that it is validated as part of the process. More information can be found in the :ref:`create_txt_file` documentation. **Sigma Levels**