Merge pull request #109 from softwareengineerprogrammer/geophires-v3-user-manual

GEOPHIRES v3 User Manual

Author: softwareengineerprogrammer

CHANGELOG.rst

@@ -7,7 +7,7 @@ GEOPHIRES v3 (2023-2025)
 
 3.9
 ^^^
-3.9.65: `GEOPHIRES Project Tenets, example_SAM-Single-Owner-PPA PI/II pumping power <https://github.com/NREL/GEOPHIRES-X/pull/432>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.65>`__
+3.9.65: `GEOPHIRES v3 User Manual, GEOPHIRES Project Tenets, example_SAM-Single-Owner-PPA PI/II pumping power <https://github.com/NREL/GEOPHIRES-X/pull/432>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.65>`__
 
 3.9.64: `Update tooltip texts from theoretical basis <https://github.com/NREL/GEOPHIRES-X/pull/430>`__ | `release <https://github.com/NREL/GEOPHIRES-X/releases/tag/v3.9.64>`__
 

README.rst

@@ -91,6 +91,16 @@ To run GEOPHIRES locally or to modify the source code, see the `Getting Started
 Documentation
 =============
 
+GEOPHIRES documentation consists of two primary resources:
+
+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.
+**Link:** `GEOPHIRES_v3_UserManual.pdf <https://github.com/softwareengineerprogrammer/GEOPHIRES/blob/9c7d95648140886609776f154d25a0dcbf240851/References/GEOPHIRES_v3_UserManual.pdf>`__
+
+2. **GEOPHIRES Reference Manual:** A living document with the most current, authoritative information on frequently updated topics like the GEOPHIRES Parameters.
+**Link:** `nrel.github.io/GEOPHIRES-X <https://nrel.github.io/GEOPHIRES-X/overview.html>`__
+
+----
+
 GEOPHIRES combines reservoir, wellbore, surface plant, and economic and cost models
 and correlations to estimate the capital and operation and maintenance costs,
 instantaneous and lifetime energy production, and overall levelized cost of energy of a
@@ -135,9 +145,9 @@ The capital and O&M costs for the different geothermal system components (explor
 well drilling, surface plant, etc.) are either provided by the user or calculated with built-in
 correlations.
 
-For more information on the theoretical basis for GEOPHIRES see
+For more information on the theoretical basis for GEOPHIRES see the
 `Theoretical Basis for GEOPHIRES <https://nrel.github.io/GEOPHIRES-X/Theoretical-Basis-for-GEOPHIRES.html>`__
-and `GEOPHIRES reference materials <References/README.md#geophires>`__.
+and `GEOPHIRES Reference Materials <References/README.md#geophires>`__.
 
 Parameters
 ----------

References/README.md

@@ -1,32 +1,27 @@
+# GEOPHIRES Reference Materials
 
-# GEOPHIRES
+## GEOPHIRES
+* **[GEOPHIRES Reference Manual](https://nrel.github.io/GEOPHIRES-X/overview.html)**
+* [GEOPHIRES v3 User Manual](https://github.com/softwareengineerprogrammer/GEOPHIRES/blob/9c7d95648140886609776f154d25a0dcbf240851/References/GEOPHIRES_v3_UserManual.pdf)
 * [GEOPHIRES v2.0 User Manual.pdf](https://github.com/NREL/GEOPHIRES-X/blob/fb5caadfa419c3bd05de656a33700d085fbc0432/References/GEOPHIRES%20v2.0%20User%20Manual.pdf) [![](https://zenodo.org/badge/doi/10.1186/s40517-019-0119-6.svg)](https://doi.org/10.1186/s40517-019-0119-6)
 * [Beckers 2019 GEOPHIRES v2.pdf](https://github.com/NREL/GEOPHIRES-X/blob/fb5caadfa419c3bd05de656a33700d085fbc0432/References/Beckers%202019%20GEOPHIRES%20v2.pdf)
 * [Beckers 2018 Introducing GEOPHIRES v2.pdf](https://github.com/NREL/GEOPHIRES-X/blob/fb5caadfa419c3bd05de656a33700d085fbc0432/References/Beckers%202018%20Introducing%20GEOPHIRES%20v2.pdf)
 * [Beckers 2016 Dissertation.pdf](https://github.com/NREL/GEOPHIRES-X/blob/fb5caadfa419c3bd05de656a33700d085fbc0432/References/Beckers%202016%20Dissertation.pdf) [![](https://zenodo.org/badge/doi/10.7298/X4736NTC.svg)](https://doi.org/10.7298/X4736NTC)
 * [Beckers 2013 GEOPHIRES v1.pdf](https://github.com/NREL/GEOPHIRES-X/blob/fb5caadfa419c3bd05de656a33700d085fbc0432/References/Beckers%202013%20GEOPHIRES%20v1.pdf)
 
-# Reference
+### CLGS
+* [Beckers-et-al_2023_Tabulated-Database-CLGS.pdf](https://github.com/NREL/GEOPHIRES-X/blob/7adc9598944a78487e5071ca23a06bfd17248c16/References/Beckers-et-al_2023_Tabulated-Database-CLGS.pdf)
+* [Wanju-et-al_2021_CLGS-Energy-Recovery.pdf](https://github.com/NREL/GEOPHIRES-X/blob/7adc9598944a78487e5071ca23a06bfd17248c16/References/Wanju-et-al_2021_CLGS-Energy-Recovery.pdf)
+
+### Other
 * [GeoVision report.pdf](https://github.com/NREL/GEOPHIRES-X/blob/ea5c67d43fe77c83a64208d8e2ab92a9abea3742/References/GeoVision%20report.pdf)
 * [US-EIA_2013_LCOE-and-LACE-supplement.pdf](https://github.com/NREL/GEOPHIRES-X/blob/7adc9598944a78487e5071ca23a06bfd17248c16/References/US-EIA_2013_LCOE-and-LACE-supplement.pdf)
 * [LACETable.txt](https://github.com/NREL/GEOPHIRES-X/blob/fb5caadfa419c3bd05de656a33700d085fbc0432/References/LACETable.txt)
 * [Drill cost correlation converting to per foot cost.xlsx](https://github.com/NREL/GEOPHIRES-X/blob/aae93f36ca5e01f4b700ddb5a59d0ec600aed3d4/References/Drill%20cost%20correlation%20converting%20to%20per%20foot%20cost.xlsx)
-
-# Fervo
 * [fervo_energy_white_paper.pdf](https://github.com/NREL/GEOPHIRES-X/blob/703c967b0b1fe9f6d619b1e786686ba07fb0fe59/References/fervo_energy_white_paper.pdf)
 * [fervo_drilling costs.pdf](https://github.com/softwareengineerprogrammer/GEOPHIRES-X/blob/62ecc37385cc89dcac36a3684c258e454bcc0241/References/fervo_drilling%20costs.pdf)
+* [S-DAC-GT](https://github.com/NREL/GEOPHIRES-X/blob/ea5c67d43fe77c83a64208d8e2ab92a9abea3742/References/JPSE2023.pdf)
 
-# JEDI
-* [JEDI.pdf](https://github.com/NREL/GEOPHIRES-X/blob/a7d1ff2e0d47e957c19c3b6dec28fece16905dcb/References/JEDI.pdf)
-* [01d-jedi-geothermal-model-rel-gt12-23-16.xlsm](https://github.com/NREL/GEOPHIRES-X/raw/a7d1ff2e0d47e957c19c3b6dec28fece16905dcb/References/01d-jedi-geothermal-model-rel-gt12-23-16.xlsm)
-
-# HIP-RA
+## HIP-RA
 * [Muffler-Cataldi_1978_ HIP-RA.pdf](https://github.com/NREL/GEOPHIRES-X/blob/7adc9598944a78487e5071ca23a06bfd17248c16/References/Muffler-Cataldi_1978_%20HIP-RA.pdf)
 * [Garg-Combs_2011_HIP-RA-Reexamination.pdf](https://github.com/NREL/GEOPHIRES-X/blob/7adc9598944a78487e5071ca23a06bfd17248c16/References/Garg-Combs_2011_HIP-RA-Reexamination.pdf)
-
-# CLGS
-* [Beckers-et-al_2023_Tabulated-Database-CLGS.pdf](https://github.com/NREL/GEOPHIRES-X/blob/7adc9598944a78487e5071ca23a06bfd17248c16/References/Beckers-et-al_2023_Tabulated-Database-CLGS.pdf)
-* [Wanju-et-al_2021_CLGS-Energy-Recovery.pdf](https://github.com/NREL/GEOPHIRES-X/blob/7adc9598944a78487e5071ca23a06bfd17248c16/References/Wanju-et-al_2021_CLGS-Energy-Recovery.pdf)
-
-# S-DAC-GT
-* [JPSE2023.pdf](https://github.com/NREL/GEOPHIRES-X/blob/ea5c67d43fe77c83a64208d8e2ab92a9abea3742/References/JPSE2023.pdf)

docs/index.rst

@@ -7,12 +7,17 @@ Contents
 
    overview
    Theoretical-Basis-for-GEOPHIRES
-   parameters
-   How-to-extend-GEOPHIRES-X
-   hip_ra_x_parameters
+   GEOPHIRES-Examples
    Monte-Carlo-User-Guide
    SAM-Economic-Models
-   GEOPHIRES-Examples
+   How-to-extend-GEOPHIRES-X
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Parameters Reference
+
+   parameters
+   hip_ra_x_parameters
 ..   reference/index
 
 Indices and tables

docs/overview.rst

@@ -2,5 +2,13 @@
 GEOPHIRES Reference Manual
 ============================
 
-This reference manual is a supplement to the `Documentation section of the README <https://github.com/NREL/GEOPHIRES-X?tab=readme-ov-file#documentation>`__ in the GitHub repository.
-Click a topic in the Table of Contents on the left to view its documentation.
+This is a living document designed to be used with the
+`GEOPHIRES v3 User Manual <https://github.com/softwareengineerprogrammer/GEOPHIRES/blob/9c7d95648140886609776f154d25a0dcbf240851/References/GEOPHIRES_v3_UserManual.pdf>`__
+and the
+`README Documentation <https://github.com/NREL/GEOPHIRES-X?tab=readme-ov-file#documentation>`__
+in the GitHub repository.
+
+
+While the User Manual provides a comprehensive, point-in-time snapshot of the software, this Reference Manual contains the most current and authoritative documentation for components that are frequently updated. For topics such as GEOPHIRES Parameters, for example, this manual should be considered the primary source of truth.
+
+To begin, click a topic in the Table of Contents on the left to view its documentation.