Skip to content

Commit 034e2db

Browse files
Examples section cleanup and web interface deeplinks
1 parent 14a1669 commit 034e2db

File tree

1 file changed

+59
-30
lines changed

1 file changed

+59
-30
lines changed

README.rst

Lines changed: 59 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -254,97 +254,126 @@ Documentation
254254
Examples
255255
--------
256256

257-
A variety of example input ``.txt`` files and corresponding case report ``.out`` files are available in the `tests/examples directory of the repository <tests/examples>`__:
257+
GEOPHIRES includes a variety of examples demonstrating its features and case studies for different types of geothermal systems.
258+
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.
259+
260+
Example input ``.txt`` files and corresponding case report ``.out`` files are available in the `tests/examples directory <tests/examples>`__ of the repository.
261+
Example-specific web interface deeplinks are listed in the Link column.
258262

259263

260264
.. list-table::
261-
:widths: 50 40 10
265+
:widths: 50 40 5 5
262266
:header-rows: 1
263267

264268
* - Example
265269
- Input file
266270
- Case report file
271+
- Link
267272
* - Example 1
268273
- `example1.txt <tests/examples/example1.txt>`__
269-
- `example1.out <tests/examples/example1.out>`__
274+
- `.out <tests/examples/example1.out>`__
275+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example1>`__
270276
* - Example 1 with Addons
271277
- `example1_addons.txt <tests/examples/example1_addons.txt>`__
272-
- `example1_addons.out <tests/examples/example1_addons.out>`__
278+
- `.out <tests/examples/example1_addons.out>`__
279+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example1_addons>`__
273280
* - Example 2
274281
- `example2.txt <tests/examples/example2.txt>`__
275-
- `example2.out <tests/examples/example2.out>`__
282+
- `.out <tests/examples/example2.out>`__
283+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example2>`__
276284
* - Example 3
277285
- `example3.txt <tests/examples/example3.txt>`__
278-
- `example3.out <tests/examples/example3.out>`__
286+
- `.out <tests/examples/example3.out>`__
287+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example3>`__
279288
* - Example 4
280289
- `example4.txt <tests/examples/example4.txt>`__
281-
- `example4.out <tests/examples/example4.out>`__
290+
- `.out <tests/examples/example4.out>`__
291+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example4>`__
282292
* - Example 5
283293
- `example5.txt <tests/examples/example5.txt>`__
284-
- `example5.out <tests/examples/example5.out>`__
294+
- `.out <tests/examples/example5.out>`__
295+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example5>`__
285296
* - Example 8
286297
- `example8.txt <tests/examples/example8.txt>`__
287-
- `example8.out <tests/examples/example8.out>`__
298+
- `.out <tests/examples/example8.out>`__
299+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example8>`__
288300
* - Example 9
289301
- `example9.txt <tests/examples/example9.txt>`__
290-
- `example9.out <tests/examples/example9.out>`__
302+
- `.out <tests/examples/example9.out>`__
303+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example9>`__
291304
* - Example 10: Heat Pump
292305
- `example10_HP.txt <tests/examples/example10_HP.txt>`__
293-
- `example10_HP.out <tests/examples/example10_HP.out>`__
306+
- `.out <tests/examples/example10_HP.out>`__
307+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example10_HP>`__
294308
* - Example 11: Absorption Chiller
295309
- `example11_AC.txt <tests/examples/example11_AC.txt>`__
296-
- `example11_AC.out <tests/examples/example11_AC.out>`__
310+
- `.out <tests/examples/example11_AC.out>`__
311+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example11_AC>`__
297312
* - Example 12: District Heating
298313
- `example12_DH.txt <tests/examples/example12_DH.txt>`__
299-
- `example12_DH.out <tests/examples/example12_DH.out>`__
314+
- `.out <tests/examples/example12_DH.out>`__
315+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example12_DH>`__
300316
* - Example 13
301317
- `example13.txt <tests/examples/example13.txt>`__
302-
- `example13.out <tests/examples/example13.out>`__
318+
- `.out <tests/examples/example13.out>`__
319+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example13>`__
303320
* - AGS: Coaxial sCO2: Heat (Beckers et. al 2023)
304321
- `Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.txt>`__
305-
- `Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.out>`__
322+
- `.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.out>`__
323+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat>`__
306324
* - AGS: Coaxial Water: Heat (Beckers et. al 2023)
307325
- `Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.txt>`__
308-
- `Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.out>`__
326+
- `.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.out>`__
327+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat>`__
309328
* - AGS: Uloop sCO2: Electricity (Beckers et. al 2023)
310329
- `Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.txt>`__
311-
- `Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.out>`__
330+
- `.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.out>`__
331+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec>`__
312332
* - AGS: Uloop sCO2: Heat (Beckers et. al 2023)
313333
- `Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.txt>`__
314-
- `Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.out>`__
334+
- `.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.out>`__
335+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat>`__
315336
* - AGS: Uloop Water: Electricity (Beckers et. al 2023)
316337
- `Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.txt>`__
317-
- `Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.out>`__
338+
- `.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.out>`__
339+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec>`__
318340
* - CLGS: Uloop Water: Heat (Beckers et. al 2023)
319341
- `Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.txt>`__
320-
- `Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.out>`__
342+
- `.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.out>`__
343+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat>`__
321344
* - SUTRA Example 1
322345
- `SUTRAExample1.txt <tests/examples/SUTRAExample1.txt>`__
323-
- `SUTRAExample1.out <tests/examples/SUTRAExample1.out>`__
346+
- `.out <tests/examples/SUTRAExample1.out>`__
347+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=SUTRAExample1>`__
324348
* - Multiple Gradients
325349
- `example_multiple_gradients.txt <tests/examples/example_multiple_gradients.txt>`__
326-
- `example_multiple_gradients.out <tests/examples/example_multiple_gradients.out>`__
350+
- `.out <tests/examples/example_multiple_gradients.out>`__
351+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example_multiple_gradients>`__
327352
* - Fervo Project Red (Norbeck J.H. and Latimer T.M. 2023.)
328353
- `Fervo_Norbeck_Latimer_2023.txt <tests/examples/Fervo_Norbeck_Latimer_2023.txt>`__
329-
- `Fervo_Norbeck_Latimer_2023.out <tests/examples/Fervo_Norbeck_Latimer_2023.out>`__
354+
- `.out <tests/examples/Fervo_Norbeck_Latimer_2023.out>`__
355+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Fervo_Norbeck_Latimer_2023>`__
330356
* - Fervo Project Cape
331357
- `Fervo_Project_Cape.txt <tests/examples/Fervo_Project_Cape.txt>`__
332-
- `Fervo_Project_Cape.out <tests/examples/Fervo_Project_Cape.out>`__
358+
- `.out <tests/examples/Fervo_Project_Cape.out>`__
359+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Fervo_Project_Cape>`__
333360
* - Superhot Rock (SHR) Example 1
334361
- `example_SHR-1.txt <tests/examples/example_SHR-1.txt>`__
335-
- `example_SHR-1.out <tests/examples/example_SHR-1.out>`__
362+
- `.out <tests/examples/example_SHR-1.out>`__
363+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example_SHR-1>`__
336364
* - Superhot Rock (SHR) Example 2
337365
- `example_SHR-2.txt <tests/examples/example_SHR-2.txt>`__
338-
- `example_SHR-2.out <tests/examples/example_SHR-2.out>`__
366+
- `.out <tests/examples/example_SHR-2.out>`__
367+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example_SHR-2>`__
339368
* - SBT High Temperature
340369
- `example_SBT_Hi_T.txt <tests/examples/example_SBT_Hi_T.txt>`__
341-
- `example_SBT_Hi_T.out <tests/examples/example_SBT_Hi_T.out>`__
370+
- `.out <tests/examples/example_SBT_Hi_T.out>`__
371+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example_SBT_Hi_T>`__
342372
* - SBT Low Temperature
343373
- `example_SBT_Lo_T.txt <tests/examples/example_SBT_Lo_T.txt>`__
344-
- `example_SBT_Lo_T.out <tests/examples/example_SBT_Lo_T.out>`__
345-
374+
- `.out <tests/examples/example_SBT_Lo_T.out>`__
375+
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example_SBT_Lo_T>`__
346376

347-
An interactive table of examples is available at `gtp.scientificwebservices.com/geophires <https://gtp.scientificwebservices.com/geophires>`__, under the Examples tab.
348377

349378
Parameters
350379
----------

0 commit comments

Comments
 (0)