From 034e2db762b50500b0469ea75ad0d5ceb7edd80e Mon Sep 17 00:00:00 2001 From: softwareengineerprogrammer <4056124+softwareengineerprogrammer@users.noreply.github.com> Date: Mon, 23 Sep 2024 10:30:16 -0700 Subject: [PATCH] Examples section cleanup and web interface deeplinks --- README.rst | 89 ++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 59 insertions(+), 30 deletions(-) diff --git a/README.rst b/README.rst index 294d7c7e..b98fbd67 100644 --- a/README.rst +++ b/README.rst @@ -254,97 +254,126 @@ Documentation Examples -------- -A variety of example input ``.txt`` files and corresponding case report ``.out`` files are available in the `tests/examples directory of the repository `__: +GEOPHIRES includes a variety of examples demonstrating its features and case studies for different types of geothermal systems. +Starting with an existing GEOPHIRES example that is similar to your intended use/application can be an easier approach to using GEOPHIRES than constructing your own inputs from scratch. + +Example input ``.txt`` files and corresponding case report ``.out`` files are available in the `tests/examples directory `__ of the repository. +Example-specific web interface deeplinks are listed in the Link column. .. list-table:: - :widths: 50 40 10 + :widths: 50 40 5 5 :header-rows: 1 * - Example - Input file - Case report file + - Link * - Example 1 - `example1.txt `__ - - `example1.out `__ + - `.out `__ + - `link `__ * - Example 1 with Addons - `example1_addons.txt `__ - - `example1_addons.out `__ + - `.out `__ + - `link `__ * - Example 2 - `example2.txt `__ - - `example2.out `__ + - `.out `__ + - `link `__ * - Example 3 - `example3.txt `__ - - `example3.out `__ + - `.out `__ + - `link `__ * - Example 4 - `example4.txt `__ - - `example4.out `__ + - `.out `__ + - `link `__ * - Example 5 - `example5.txt `__ - - `example5.out `__ + - `.out `__ + - `link `__ * - Example 8 - `example8.txt `__ - - `example8.out `__ + - `.out `__ + - `link `__ * - Example 9 - `example9.txt `__ - - `example9.out `__ + - `.out `__ + - `link `__ * - Example 10: Heat Pump - `example10_HP.txt `__ - - `example10_HP.out `__ + - `.out `__ + - `link `__ * - Example 11: Absorption Chiller - `example11_AC.txt `__ - - `example11_AC.out `__ + - `.out `__ + - `link `__ * - Example 12: District Heating - `example12_DH.txt `__ - - `example12_DH.out `__ + - `.out `__ + - `link `__ * - Example 13 - `example13.txt `__ - - `example13.out `__ + - `.out `__ + - `link `__ * - AGS: Coaxial sCO2: Heat (Beckers et. al 2023) - `Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.txt `__ - - `Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.out `__ + - `.out `__ + - `link `__ * - AGS: Coaxial Water: Heat (Beckers et. al 2023) - `Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.txt `__ - - `Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.out `__ + - `.out `__ + - `link `__ * - AGS: Uloop sCO2: Electricity (Beckers et. al 2023) - `Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.txt `__ - - `Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.out `__ + - `.out `__ + - `link `__ * - AGS: Uloop sCO2: Heat (Beckers et. al 2023) - `Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.txt `__ - - `Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.out `__ + - `.out `__ + - `link `__ * - AGS: Uloop Water: Electricity (Beckers et. al 2023) - `Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.txt `__ - - `Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.out `__ + - `.out `__ + - `link `__ * - CLGS: Uloop Water: Heat (Beckers et. al 2023) - `Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.txt `__ - - `Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.out `__ + - `.out `__ + - `link `__ * - SUTRA Example 1 - `SUTRAExample1.txt `__ - - `SUTRAExample1.out `__ + - `.out `__ + - `link `__ * - Multiple Gradients - `example_multiple_gradients.txt `__ - - `example_multiple_gradients.out `__ + - `.out `__ + - `link `__ * - Fervo Project Red (Norbeck J.H. and Latimer T.M. 2023.) - `Fervo_Norbeck_Latimer_2023.txt `__ - - `Fervo_Norbeck_Latimer_2023.out `__ + - `.out `__ + - `link `__ * - Fervo Project Cape - `Fervo_Project_Cape.txt `__ - - `Fervo_Project_Cape.out `__ + - `.out `__ + - `link `__ * - Superhot Rock (SHR) Example 1 - `example_SHR-1.txt `__ - - `example_SHR-1.out `__ + - `.out `__ + - `link `__ * - Superhot Rock (SHR) Example 2 - `example_SHR-2.txt `__ - - `example_SHR-2.out `__ + - `.out `__ + - `link `__ * - SBT High Temperature - `example_SBT_Hi_T.txt `__ - - `example_SBT_Hi_T.out `__ + - `.out `__ + - `link `__ * - SBT Low Temperature - `example_SBT_Lo_T.txt `__ - - `example_SBT_Lo_T.out `__ - + - `.out `__ + - `link `__ -An interactive table of examples is available at `gtp.scientificwebservices.com/geophires `__, under the Examples tab. Parameters ----------