Skip to content

Commit 8cbf801

Browse files
Merge pull request #110 from softwareengineerprogrammer/documentation-resources-readme-organization
Re-organize documentation resources in README
2 parents 241aefc + 23570b5 commit 8cbf801

File tree

3 files changed

+14
-20
lines changed

3 files changed

+14
-20
lines changed

README.rst

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -91,16 +91,6 @@ To run GEOPHIRES locally or to modify the source code, see the `Getting Started
9191
Documentation
9292
=============
9393

94-
GEOPHIRES documentation consists of two primary resources:
95-
96-
1. **GEOPHIRES v3 User Manual:** A comprehensive, point-in-time snapshot of the software in PDF format, covering installation, usage, example problems, and parameter lists in detail.
97-
**Link:** `GEOPHIRES_v3_UserManual.pdf <https://github.com/softwareengineerprogrammer/GEOPHIRES/blob/9c7d95648140886609776f154d25a0dcbf240851/References/GEOPHIRES_v3_UserManual.pdf>`__
98-
99-
2. **GEOPHIRES Reference Manual:** A living document with the most current, authoritative information on frequently updated topics like the GEOPHIRES Parameters.
100-
**Link:** `nrel.github.io/GEOPHIRES-X <https://nrel.github.io/GEOPHIRES-X/overview.html>`__
101-
102-
----
103-
10494
GEOPHIRES combines reservoir, wellbore, surface plant, and economic and cost models
10595
and correlations to estimate the capital and operation and maintenance costs,
10696
instantaneous and lifetime energy production, and overall levelized cost of energy of a
@@ -114,7 +104,7 @@ or user-provided components.
114104

115105
|GEOPHIRES Architecture Diagram|
116106

117-
.. |GEOPHIRES Architecture Diagram| image:: References/geophires-architecture-diagram_2024-11-20.png
107+
.. |GEOPHIRES Architecture Diagram| image:: References/geophires-architecture-diagram_2025-10-17.png
118108
:alt: GEOPHIRES Architecture Diagram
119109

120110
GEOPHIRES has a variety of different reservoir models including
@@ -332,12 +322,6 @@ Example-specific web interface deeplinks are listed in the Link column.
332322
<i>* TOUGH2 is not currently supported in the web interface. Comment on <a href="https://github.com/softwareengineerprogrammer/geothermal-ui/issues/15">this tracking issue</a> to request web interface support for TOUGH2.</i>
333323
</embed>
334324

335-
Videos
336-
------
337-
338-
`NREL GEOPHIRES Workshop: Features Overview & Examples <https://www.youtube.com/watch?v=KsFvpvXjOB4>`__
339-
340-
`NREL GEOPHIRES Workshop: Case Studies <https://youtu.be/uMUDTUL6yWg>`__
341325

342326
HIP-RA: Heat in Place - Resource Assessment
343327
-------------------------------------------
@@ -362,17 +346,27 @@ Extending GEOPHIRES-X
362346

363347
`Extension example: SUTRA <https://github.com/NREL/GEOPHIRES-X/commit/984cb4da1505667adb2c45cb1297cab6550774bd#diff-5b1ea85ce061b9a1137a46c48d2d293126224d677d3ab38d9b2f4dcfc4e1674e>`__
364348

349+
Resources
350+
---------
351+
352+
`GEOPHIRES v3 User Manual <https://github.com/softwareengineerprogrammer/GEOPHIRES/blob/9c7d95648140886609776f154d25a0dcbf240851/References/GEOPHIRES_v3_UserManual.pdf>`__: A comprehensive, point-in-time snapshot of the software in PDF format, covering installation, usage, example problems, and parameter lists in detail.
365353

366-
Additional Documentation
367-
------------------------
354+
`GEOPHIRES Reference Manual <https://nrel.github.io/GEOPHIRES-X/overview.html>`__: A living document with the most current, authoritative information on frequently updated topics like the GEOPHIRES Parameters.
368355

369356
Additional materials can be found in `/References </References/README.md>`__.
370357

358+
Videos
359+
------
360+
361+
`NREL GEOPHIRES Workshop: Features Overview & Examples <https://www.youtube.com/watch?v=KsFvpvXjOB4>`__
362+
363+
`NREL GEOPHIRES Workshop: Case Studies <https://youtu.be/uMUDTUL6yWg>`__
364+
371365

372366
Development
373367
===========
374368

375-
If you are interested in sharing your extensions with others, or even contributing them back to this repository,
369+
If you are interested in sharing your extensions with others, or contributing them back to this repository,
376370
you may want to follow `the Development instructions <CONTRIBUTING.rst#development>`__.
377371
(You can also create a fork after doing an editable install so don't worry about picking this method if you're unsure.)
378372

-85.6 KB
Binary file not shown.
264 KB
Loading

0 commit comments

Comments
 (0)