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

Some very minor updates to documentation. #253

Merged
merged 1 commit into from
Sep 26, 2023
Merged

Some very minor updates to documentation. #253

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ install HAERO yourself, you can follow the instructions in the
[HAERO repository](https://github.com/eagles-project/haero). Make sure you run
all the steps, including `make install`.

If you're on a machine that requires modules to get access to compilers, etc,
use
If you're on a machine that requires modules to get access to compilers, etc,
use
```
source build-haero.sh <path>
```
Expand Down Expand Up @@ -138,7 +138,7 @@ targets.
You can get a code coverage report if you've enabled mam4xx to build with
code coverage instrumentation. This option is configurable in your `config.sh`
script if you uncomment the `COVERAGE=ON` line, or if you run CMake directly
with the `--DMAM4XX_ENABLE_COVERAGE=ON` flag. You must have the
with the `-DENABLE_COVERAGE=ON` flag. You must have the
[LCOV](https://lcov.readthedocs.io/en/latest/index.html) tool
installed to generate reports.

Expand Down
8 changes: 3 additions & 5 deletions docs/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,9 +193,6 @@ HAERO contains several other data structures in addition those mentioned above.
More details on these data structures can be found in the
[HAERO documentation](https://eagles-project.github.io/haero/).

_NOTE: This site will be published when we finish the open source paperwork
for HAERO._

## C++ Guidelines

C++ is a large, multi-paradigm programming language. The way C++ is used has
Expand Down Expand Up @@ -230,7 +227,7 @@ with a few notable _exceptions_:
* We allow the use of C++ exceptions, since simulation codes have rather
simplistic error handling requirements.
* Names of functions, methods, and variables use `snake_case`, not
`camelCase` or `UpperCamelCase`.
`camelCase` or `PascalCase`.
* We typically use braces to enclose logic for all `if`/`else`/loop statements
even if they are only a single line, for consistency and readability.
* We use `EKAT_ASSERT` instead of `assert` to ensure that all MPI processes
Expand All @@ -248,7 +245,8 @@ you can run from your build directory:
These targets are only available if you have `clang-format` on your system, and
they only perform their work if you have the version we support. If you have an
unsupported version of `clang-format`, the targets will tell you the right
version to install. [Here](clang-format.md) is a guide to getting the supported version of `clang-format` that is a bit more geared toward Mac users than others.
version to install. [Here](clang-format.md) is a guide to getting the supported
version of `clang-format` that is a bit more geared toward Mac users than others.

### Best practices

Expand Down
2 changes: 1 addition & 1 deletion docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
MAM4xx builds and runs on the following platforms:

* Mac and Linux laptops and workstations
* NERSC Cori
* NERSC Perlmutter
* Compy and Constance at PNNL

## Required Software
Expand Down
Loading