Skip to content

Commit 69e51f2

Browse files
README updates: Tweak descriptions in Examples table, list Parameters section first in Documentation section, add NREL GEOPHIRES Workshop session recordings Videos section, add HIP-RA & Monte Carlo web interface links.
1 parent a930d60 commit 69e51f2

File tree

1 file changed

+31
-22
lines changed

1 file changed

+31
-22
lines changed

README.rst

Lines changed: 31 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,13 @@ You may also optionally pass the output file as well::
251251
Documentation
252252
=============
253253

254+
255+
Parameters
256+
----------
257+
258+
Available parameters are documented in the `Parameters Reference <https://nrel.github.io/GEOPHIRES-X/parameters.html>`__.
259+
260+
254261
Examples
255262
--------
256263

@@ -317,27 +324,27 @@ Example-specific web interface deeplinks are listed in the Link column.
317324
- `example13.txt <tests/examples/example13.txt>`__
318325
- `.out <tests/examples/example13.out>`__
319326
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example13>`__
320-
* - AGS: Coaxial sCO2: Heat (Beckers et. al 2023)
327+
* - AGS: Coaxial sCO2: Heat
321328
- `Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.txt>`__
322329
- `.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat.out>`__
323330
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Beckers_et_al_2023_Tabulated_Database_Coaxial_sCO2_heat>`__
324-
* - AGS: Coaxial Water: Heat (Beckers et. al 2023)
331+
* - AGS: Coaxial Water: Heat
325332
- `Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.txt>`__
326333
- `.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat.out>`__
327334
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Beckers_et_al_2023_Tabulated_Database_Coaxial_water_heat>`__
328-
* - AGS: Uloop sCO2: Electricity (Beckers et. al 2023)
335+
* - AGS: Uloop sCO2: Electricity
329336
- `Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.txt>`__
330337
- `.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec.out>`__
331338
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_elec>`__
332-
* - AGS: Uloop sCO2: Heat (Beckers et. al 2023)
339+
* - AGS: Uloop sCO2: Heat
333340
- `Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.txt>`__
334341
- `.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat.out>`__
335342
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Beckers_et_al_2023_Tabulated_Database_Uloop_sCO2_heat>`__
336-
* - AGS: Uloop Water: Electricity (Beckers et. al 2023)
343+
* - AGS: Uloop Water: Electricity
337344
- `Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.txt>`__
338345
- `.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec.out>`__
339346
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Beckers_et_al_2023_Tabulated_Database_Uloop_water_elec>`__
340-
* - CLGS: Uloop Water: Heat (Beckers et. al 2023)
347+
* - CLGS: Uloop Water: Heat
341348
- `Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.txt <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.txt>`__
342349
- `.out <tests/examples/Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat.out>`__
343350
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Beckers_et_al_2023_Tabulated_Database_Uloop_water_heat>`__
@@ -353,15 +360,15 @@ Example-specific web interface deeplinks are listed in the Link column.
353360
- `Fervo_Norbeck_Latimer_2023.txt <tests/examples/Fervo_Norbeck_Latimer_2023.txt>`__
354361
- `.out <tests/examples/Fervo_Norbeck_Latimer_2023.out>`__
355362
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Fervo_Norbeck_Latimer_2023>`__
356-
* - Fervo Project Cape
363+
* - Fervo Cape Station 1
357364
- `Fervo_Project_Cape.txt <tests/examples/Fervo_Project_Cape.txt>`__
358365
- `.out <tests/examples/Fervo_Project_Cape.out>`__
359366
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Fervo_Project_Cape>`__
360-
* - Fervo Project Cape 2
367+
* - Fervo Cape Station 2: 2024 Results
361368
- `Fervo_Project_Cape-2.txt <tests/examples/Fervo_Project_Cape-2.txt>`__
362369
- `.out <tests/examples/Fervo_Project_Cape-2.out>`__
363370
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Fervo_Project_Cape-2>`__
364-
* - Fervo Project Cape 3
371+
* - Fervo Cape Station 3: 400 MWe Production
365372
- `Fervo_Project_Cape-3.txt <tests/examples/Fervo_Project_Cape-3.txt>`__
366373
- `.out <tests/examples/Fervo_Project_Cape-3.out>`__
367374
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=Fervo_Project_Cape-3>`__
@@ -382,33 +389,35 @@ Example-specific web interface deeplinks are listed in the Link column.
382389
- `.out <tests/examples/example_SBT_Lo_T.out>`__
383390
- `link <https://gtp.scientificwebservices.com/geophires?geophires-example-id=example_SBT_Lo_T>`__
384391

392+
Videos
393+
------
385394

386-
Parameters
387-
----------
388-
389-
Available parameters are documented in the `Parameters Reference <https://nrel.github.io/GEOPHIRES-X/parameters.html>`__.
390-
391-
392-
Extending GEOPHIRES-X
393-
---------------------
394-
* `How to extend GEOPHIRES-X <docs/How-to-extend-GEOPHIRES-X.md#how-to-extend-geophires-x>`__ user guide
395-
396-
- `Extension example: SUTRA <https://github.com/NREL/GEOPHIRES-X/commit/984cb4da1505667adb2c45cb1297cab6550774bd#diff-5b1ea85ce061b9a1137a46c48d2d293126224d677d3ab38d9b2f4dcfc4e1674e>`__
395+
`NREL GEOPHIRES Workshop: Features Overview & Examples <https://www.youtube.com/watch?v=KsFvpvXjOB4>`__
397396

397+
`NREL GEOPHIRES Workshop: Case Studies <https://youtu.be/uMUDTUL6yWg>`__
398398

399399
HIP-RA: Heat in Place - Resource Assessment
400400
-------------------------------------------
401401

402402
* `HIP-RA-X README <src/hip_ra_x/README.md>`__
403-
* `HIP-RA-X Parameters Reference <https://softwareengineerprogrammer.github.io/GEOPHIRES-X/hip_ra_x_parameters.html>`__
403+
* `HIP-RA-X Parameters Reference <https://nrel.github.io/GEOPHIRES-X/hip_ra_x_parameters.html>`__
404+
* A HIP-RA web interface is available at `gtp.scientificwebservices.com/hip-ra <https://gtp.scientificwebservices.com/hip-ra>`__.
404405

405-
.. TODO switch over to https://nrel.github.io/GEOPHIRES-X/hip_ra_x_parameters.html once merged
406406

407407
Monte Carlo
408408
-----------
409409

410410
`Monte Carlo User Guide <https://softwareengineerprogrammer.github.io/GEOPHIRES-X/Monte-Carlo-User-Guide.html>`__
411411

412+
A Monte Carlo web interface is available at `gtp.scientificwebservices.com/monte-carlo <https://gtp.scientificwebservices.com/monte-carlo>`__.
413+
414+
Extending GEOPHIRES-X
415+
---------------------
416+
* `How to extend GEOPHIRES-X <docs/How-to-extend-GEOPHIRES-X.md#how-to-extend-geophires-x>`__ user guide
417+
418+
- `Extension example: SUTRA <https://github.com/NREL/GEOPHIRES-X/commit/984cb4da1505667adb2c45cb1297cab6550774bd#diff-5b1ea85ce061b9a1137a46c48d2d293126224d677d3ab38d9b2f4dcfc4e1674e>`__
419+
420+
412421
Additional Documentation
413422
------------------------
414423
The `GEOPHIRES v2.0 (previous version's) user manual <References/GEOPHIRES%20v2.0%20User%20Manual.pdf>`__ describes GEOPHIRES's high-level software architecture.

0 commit comments

Comments
 (0)