@@ -254,28 +254,33 @@ Documentation
254
254
Examples
255
255
--------
256
256
257
- A variety of example input ``.txt `` files are available in the `tests/examples directory of the repository <tests/examples >`__:
258
-
259
- - `example1.txt <tests/examples/example1.txt >`__
260
- - `example1_addons.txt <tests/examples/example1_addons.txt >`__
261
- - `example2.txt <tests/examples/example2.txt >`__
262
- - `example3.txt <tests/examples/example3.txt >`__
263
- - `example4.txt <tests/examples/example4.txt >`__
264
- - `example5.txt <tests/examples/example5.txt >`__
265
- - `example8.txt <tests/examples/example8.txt >`__
266
- - `example9.txt <tests/examples/example9.txt >`__
267
- - `example10_HP.txt <tests/examples/example10_HP.txt >`__
268
- - `example11_AC.txt <tests/examples/example11_AC.txt >`__
269
- - `example12_DH.txt <tests/examples/example12_DH.txt >`__
270
- - `example13.txt <tests/examples/example13.txt >`__
271
- - `Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.txt >`__
272
- - `Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.txt >`__
273
- - `Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.txt >`__
274
- - `Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.txt >`__
275
- - `Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.txt >`__
276
- - `Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.txt >`__
277
- - `SUTRAExample1.txt <tests/examples/SUTRAExample1.txt >`__
278
- - `example_multiple_gradients.txt <tests/examples/example_multiple_gradients.txt >`__
257
+ A variety of example input ``.txt `` and corresponding ```.out` `` files are available in the `tests/examples directory of the repository <tests/examples >`__:
258
+
259
+ - `example1.txt <tests/examples/example1.txt >`__ / `example1.out <tests/examples/example1.out >`__
260
+ - `example1_addons.txt <tests/examples/example1_addons.txt >`__ / `example1_addons.out <tests/examples/example1_addons.out >`__
261
+ - `example2.txt <tests/examples/example2.txt >`__ / `example2.out <tests/examples/example2.out >`__
262
+ - `example3.txt <tests/examples/example3.txt >`__ / `example3.out <tests/examples/example3.out >`__
263
+ - `example4.txt <tests/examples/example4.txt >`__ / `example4.out <tests/examples/example4.out >`__
264
+ - `example5.txt <tests/examples/example5.txt >`__ / `example5.out <tests/examples/example5.out >`__
265
+ - `example8.txt <tests/examples/example8.txt >`__ / `example8.out <tests/examples/example8.out >`__
266
+ - `example9.txt <tests/examples/example9.txt >`__ / `example9.out <tests/examples/example9.out >`__
267
+ - `example10_HP.txt <tests/examples/example10_HP.txt >`__ / `example10_HP.out <tests/examples/example10_HP.out >`__
268
+ - `example11_AC.txt <tests/examples/example11_AC.txt >`__ / `example11_AC.out <tests/examples/example11_AC.out >`__
269
+ - `example12_DH.txt <tests/examples/example12_DH.txt >`__ / `example12_DH.out <tests/examples/example12_DH.out >`__
270
+ - `example13.txt <tests/examples/example13.txt >`__ / `example13.out <tests/examples/example13.out >`__
271
+ - `Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.txt >`__ / `Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.out >`__
272
+ - `Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.txt >`__ / `Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.out >`__
273
+ - `Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.txt >`__ / `Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.out >`__
274
+ - `Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.txt >`__ / `Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.out >`__
275
+ - `Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.txt >`__ / `Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.out >`__
276
+ - `Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.txt >`__ / `Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.out >`__
277
+ - `SUTRAExample1.txt <tests/examples/SUTRAExample1.txt >`__ / `SUTRAExample1.out <tests/examples/SUTRAExample1.out >`__
278
+ - `example_multiple_gradients.txt <tests/examples/example_multiple_gradients.txt >`__ / `example_multiple_gradients.out <tests/examples/example_multiple_gradients.out >`__
279
+ - `Fervo_Norbeck_Latimer_2023.txt <tests/examples/Fervo_Norbeck_Latimer_2023.txt >`__ / `Fervo_Norbeck_Latimer_2023.out <tests/examples/Fervo_Norbeck_Latimer_2023.out >`__
280
+ - `example_SHR-1.txt <tests/examples/example_SHR-1.txt >`__ / `example_SHR-1.out <tests/examples/example_SHR-1.out >`__
281
+ - `example_SHR-2.txt <tests/examples/example_SHR-2.txt >`__ / `example_SHR-2.out <tests/examples/example_SHR-2.out >`__
282
+
283
+ An interactive table of examples is available at `gtp.scientificwebservices.com/geophires <https://gtp.scientificwebservices.com/geophires >`__, under the Examples tab.
279
284
280
285
Parameters
281
286
----------
0 commit comments