From ade8e4a2fdcaa46a68888b1a9cc5e2ba6dc47730 Mon Sep 17 00:00:00 2001 From: "Jeffrey N. Johnson" Date: Tue, 26 Sep 2023 09:47:41 -0700 Subject: [PATCH] Some very minor updates to documentation. --- README.md | 6 +++--- docs/development.md | 8 +++----- docs/installation.md | 2 +- 3 files changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 44e3274c3..deb841c89 100644 --- a/README.md +++ b/README.md @@ -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 ``` @@ -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. diff --git a/docs/development.md b/docs/development.md index 40a1056d3..e3cae410e 100644 --- a/docs/development.md +++ b/docs/development.md @@ -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 @@ -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 @@ -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 diff --git a/docs/installation.md b/docs/installation.md index 86ce76c0b..dc3872fdf 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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