Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
monroews authored Dec 5, 2024
1 parent 57807b2 commit 63d2550
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,16 @@ To publish, first ensure all of your changes have been merged into master by fol
4. `git push origin <tagname>`

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

0 comments on commit 63d2550

Please sign in to comment.