From 63d2550f5860ccb55948352d08c0ac15c295a6f1 Mon Sep 17 00:00:00 2001 From: Monroe Weber-Shirk Date: Thu, 5 Dec 2024 17:39:03 -0500 Subject: [PATCH] Update README.md --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 787d07072..6586ef28b 100644 --- a/README.md +++ b/README.md @@ -14,3 +14,16 @@ To publish, first ensure all of your changes have been merged into master by fol 4. `git push origin ` Pushing a tag will kick off the automated release workflow which builds the PDF and HTML documentation. +# Technical Reports +We are using [sphinx_ext_substitution](https://github.com/NordicHPC/sphinx_ext_substitution) to replace keywords. This enables accessing the last part of the map to find a specific variable. For example, $..lfom.rowN, will find all of the variables where the map ends with lfom.rowN. If more than one option is available sphinx_ext_substitution will throw an error. The solution is to add more detail to the map name and perhaps specify the entrance tank or filter. + +Each plant’s technical report will live in its own repository in the [AguaClara Reach github](https://github.com/AguaClara-Reach). The plant repository main branch will contain all of the data needed to create the technical report. +1. plant.yml +2. index.rst +The gh-pages branch will have the html files and folder structure + + +Create a readme in the plant + + +# Working in Visual Studio Code and in the cmd line