Skip to content

Commit d7fe715

Browse files
link/designate user manual and reference manual as 2 primary documentation resources in README.rst
1 parent aefa99f commit d7fe715

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,15 @@ 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+
* **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+
* **GEOPHIRES Reference Manual:** A living document with the most current, authoritative information on frequently updated topics like the GEOPHIRES Parameters.
99+
* **Link:** `nrel.github.io/GEOPHIRES-X <https://nrel.github.io/GEOPHIRES-X/overview.html>`__
100+
101+
----
102+
94103
GEOPHIRES combines reservoir, wellbore, surface plant, and economic and cost models
95104
and correlations to estimate the capital and operation and maintenance costs,
96105
instantaneous and lifetime energy production, and overall levelized cost of energy of a

0 commit comments

Comments
 (0)