From 6985cc6be843c784185c890ea906a66099041981 Mon Sep 17 00:00:00 2001 From: Tim Neumann Date: Sun, 29 Jan 2023 13:14:49 +0100 Subject: [PATCH 1/2] Add documentation about development infrastructure Resolves #1105 --- docs/source/developer/index.rst | 1 + docs/source/developer/infra.rst | 42 +++++++++++++++++++++++++++++++ docs/source/developer/testing.rst | 2 ++ 3 files changed, 45 insertions(+) create mode 100644 docs/source/developer/infra.rst diff --git a/docs/source/developer/index.rst b/docs/source/developer/index.rst index b6daada96..9d19c5019 100644 --- a/docs/source/developer/index.rst +++ b/docs/source/developer/index.rst @@ -11,3 +11,4 @@ Developer Manual Developer Workflow Best Practices Code Style Guide Contributing + Project Development Infrastructure diff --git a/docs/source/developer/infra.rst b/docs/source/developer/infra.rst new file mode 100644 index 000000000..1717763bd --- /dev/null +++ b/docs/source/developer/infra.rst @@ -0,0 +1,42 @@ +Development Infrastructure +========================== + +This document describes the development infrastructure used by the nalu-wind project. + +Docker Container +---------------- + +The docker container `ecpe4s/exawind-snapshot `_ +is build by an external collaborator in the E4S project. +Its definition is at https://gitlab.e4s.io/uo-public/exawind-snapshot. + +It is based on an Ubuntu with GCC on which spack-manager is used to install exawind+hypre+openfast. + +It is build and pushed to Dockerhub daily. + +Continuous Integration +---------------------- + +There are currently two different systems the continuously check the code of this project. + +GitHub Actions +^^^^^^^^^^^^^^ + +The `github actions workflow `_ +runs on every pull request towards master as well as all commits on master. + +It does the following things: + +* Style Check of the CPP code using clang-format with clang version 13 +* Run the unit tests + + * Uses the docker container to allow to reuse the third party libraries + * Rebuilds nalu-wind with the source from the commit on which the ci is run + * Run all test with `unit` in the label using ctest + +Daily Regression Tests +^^^^^^^^^^^^^^^^^^^^^^ + +Additionally, the project is tested more extensively on some machines at NREL. +The results are collected at `CDash `_. +For more info see :ref:`ref-testing-cdash`. diff --git a/docs/source/developer/testing.rst b/docs/source/developer/testing.rst index 53c9968a4..7b585425e 100644 --- a/docs/source/developer/testing.rst +++ b/docs/source/developer/testing.rst @@ -115,6 +115,8 @@ created. Also, if you are using a mesh file that doesn't exist in the mesh repo, update the submodule in the Nalu-Wind main repo to use the latest commit of the mesh submodule repo. +.. _ref-testing-cdash: + Adding Testing Machines to CDash -------------------------------- From 119b860fc9dd793e6b43b5c3cd24a1c222f5f2f2 Mon Sep 17 00:00:00 2001 From: Tim Neumann Date: Sun, 29 Jan 2023 13:45:52 +0100 Subject: [PATCH 2/2] Fix indentation of bullet points --- docs/source/developer/infra.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/developer/infra.rst b/docs/source/developer/infra.rst index 1717763bd..5a522de3f 100644 --- a/docs/source/developer/infra.rst +++ b/docs/source/developer/infra.rst @@ -30,9 +30,9 @@ It does the following things: * Style Check of the CPP code using clang-format with clang version 13 * Run the unit tests - * Uses the docker container to allow to reuse the third party libraries - * Rebuilds nalu-wind with the source from the commit on which the ci is run - * Run all test with `unit` in the label using ctest + * Uses the docker container to allow to reuse the third party libraries + * Rebuilds nalu-wind with the source from the commit on which the ci is run + * Run all test with `unit` in the label using ctest Daily Regression Tests ^^^^^^^^^^^^^^^^^^^^^^