From 1803f05b2949b3beec5599c923c13f77b2ea25e3 Mon Sep 17 00:00:00 2001 From: softwareengineerprogrammer <4056124+softwareengineerprogrammer@users.noreply.github.com> Date: Mon, 12 Feb 2024 08:03:34 -0800 Subject: [PATCH] Link to MC from README https://github.com/NREL/GEOPHIRES-X/issues/69 --- README.rst | 5 +++++ docs/Monte-Carlo-User-Guide.md | 8 ++++---- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index dee180ab..8a0e70cf 100644 --- a/README.rst +++ b/README.rst @@ -285,6 +285,11 @@ Extending GEOPHIRES-X - `Extension example: SUTRA `__ +Monte Carlo +----------- + +`Monte Carlo User Guide `__ + Other Documentation: -------------------- The `GEOPHIRES v2.0 (previous version's) user manual `__ describes GEOPHIRES's high-level software architecture. diff --git a/docs/Monte-Carlo-User-Guide.md b/docs/Monte-Carlo-User-Guide.md index fe0607f5..4c198dba 100644 --- a/docs/Monte-Carlo-User-Guide.md +++ b/docs/Monte-Carlo-User-Guide.md @@ -1,9 +1,5 @@ # GEOPHIRES Monte Carlo User Guide -## Documentation - -See [module documentation](reference/geophires_monte_carlo.html) - ## Example Setup Create a project with the following structure, including GEOPHIRES in `requirements.txt` and setting up `venv` with `virtualenv`: @@ -112,3 +108,7 @@ bin edges: [-43.34 -43.2258 -43.1116 -42.9974 -42.8832 -42.769 -42.6548 -42.5 -37.8584 -37.7442 -37.63 ] ``` + +## Documentation + +See [module documentation](reference/geophires_monte_carlo.html)