Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #372

Merged
merged 2 commits into from
Dec 12, 2024
Merged

Update README.md #372

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63d2550
Update README.md
monroews Dec 5, 2024
b97b3fe
Merge branch 'master' into monroews-patch-2
eak24 Dec 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,16 @@ To publish, first ensure all of your changes have been merged into master by fol

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

# Running locally
We use [act](https://github.com/nektos/act) to run the workflow locally. After installing act, run `act --container-architecture linux/amd64` in the root directory to see a list of workflows that can be run locally.

Loading