Developer Manual#
Clone#
GitHub
$ git clone git@github.com:lanl-aea/waves.git
LANL
$ git clone ssh://git@re-git.lanl.gov:10022/aea/python-projects/waves.git
Dependencies#
The development environment dependencies are found in the project’s environment.yml
file. For convenience, the file
is reproduced here
1channels:
2 - fierromechanics
3 - conda-forge
4
5dependencies:
6 - black
7 - boa
8 - calculix
9 - ccx2paraview >=3.2
10 - fierro-fe-cpu
11 # Remove trilinos-cpu explicit requirement when Fierro package(s) resolve the missing library issue
12 # https://re-git.lanl.gov/aea/python-projects/waves/-/issues/865
13 - trilinos-cpu <=15
14 - flake8
15 - glab >=1.52
16 - h5netcdf
17 - h5py
18 - ipython
19 - lazy_loader >=0.4
20 - matplotlib-base
21 - meshio
22 - mypy
23 - networkx
24 # Required to satisfy undocumented SALib dependencies on numpy version
25 - numpy >=2
26 - pandas
27 - pip
28 - pytest>=6
29 - pytest-cov
30 - pytest-xdist
31 - python-build
32 - python-gmsh
33 - pyyaml
34 # Required to satisfy undocumented SALib dependencies on numpy version
35 - salib >=1.5.1
36 - scipy >=1
37 - scons >=4.6
38 - seaborn
39 - setuptools >=64
40 - setuptools_scm >=8
41 - sphinx >=7.1
42 - sphinx-argparse
43 - sphinx-book-theme
44 - sphinx-copybutton >=0.5.1
45 - sphinx-design
46 - sphinx_rtd_theme >=3
47 - sphinxcontrib-bibtex
48 - twine >=5
49 - xarray
In addition to the Conda environment managed packages, this project also requires a separately managed installation of TeXLive to build the PDF documentation.
The tutorials in this project may also require:
Abaqus
Cubit
Matlab
Activate Environment#
Local development environments#
SCons can be installed in a Conda environment with the Conda package manager. See the Conda installation and Conda environment management documentation for more details about using Conda.
Create the environment if it doesn’t exist
$ pwd path/to/local/git/clone/waves $ conda env create --name waves-env --file environment.yml
Activate the environment
$ conda activate waves-env
AEA CI server environment#
A minimal development environment for the waves project Gitlab-CI pipelines is maintained on AEA servers.
Add the AEA modulefiles directory
$ module use /projects/aea_compute/modulefiles
Load the project specific modulefile
$ module load waves-env
The Conda packages found in environment.yml
are reproduced in the Dependencies section.
HPC CI server environment#
For computing policy reasons, HPC CI pipelines are owned by the launching user and launched with the user’s account. The
HPC CI server environment must be created in the launching user’s scratch space. For merge request pipelines, this means
a project development environment will be created in the submitting developer’s scratch space, e.g.
${system_scratch}/$USER/waves-env
.
Because the CI pipeline runs as the launching user, Conda will create a package and environment cache according to the
user’s HPC Conda configuration. By default, Conda creates ~/.conda/pkgs
for the package cache, which can grow quite
large. If a user’s home directory space is limited, developers are highly encouraged to configure Conda to use their
scratch space for the package cache, e.g. with a ~/.condarc
file using the template below, where the text
${user_scratch}
is replaced by the absolute path to the user’s scratch directory.
envs_dirs:
- ${user_scratch}/conda/envs
pkgs_dirs:
- ${user_scratch}/conda/pkgs
You can read more about managing the Conda package and environment cache configuration here: https://conda.io/projects/conda/en/latest/user-guide/configuration/custom-env-and-pkg-locations.html
Windows CI environment#
The Windows CI server must have a system (or Gitlab-Runner user) installation of the following software separately from the Conda environment.
Git
Git-LFS
Anaconda/Miniconda/Miniforge
The Windows CI server environment is created under the default Gitlab-Runner user and may not be available for
developers. There is an environment-win.yml
file maintained under version control for the Windows CI job. Windows
developers may use this to create a local development environment that closely mirrors the linux CI environment.
MacOS CI environment#
The MacOS CI server must have a system (or Gitlab-Runner user) installation of the following software separately from the Conda environment.
Git
Git-LFS
Anaconda/Miniconda/Miniforge
The MacOS CI server environment is created under the default Gitlab-Runner user and is not be available for developers.
The MacOS CI server uses the full environment.yml
file maintained under version control. MacOS developers may use
this to create a local development environment that closely mirrors the linux CI environment.
Contribution Guidelines#
The WAVES project uses the Gitlab Flow [25] workflow model.
Git Commit Message#
Begin Git commit messages with one of the following headings:
BUG: bug fix
DOC: documentation
FEAT: feature
MAINT: maintenance
TST: tests
REL: release
WIP: work-in-progress
For example:
git commit -m "FEAT: short intent of new feature"
git commit -m "BUG: fixes nasty bug"
git commit -m "DOC: adds documentation for feature"
reStructured Text#
Sphinx reads in docstrings and other special portions of the code as reStructured text. Developers should follow styles in this Sphinx style guide.
Style Guide#
This project does not yet have a full style guide. Generally, wherever a style can’t be inferred from surrounding code this project falls back to PEP-8-like styles. There are two notable exceptions to the notional PEP-8 fall back:
Build#
To build the Conda package activate the development environment and run the conda build command found in the CI configuration file. The current command may be found as
$ sed -n '/output_folder=/,/VERSION/p' .gitlab-ci.yml .pipeline*.yml
...
$ output_folder='conda-bld'
$ mkdir ${output_folder}
$ VERSION=$(python -m setuptools_scm) conda build recipe --channel conda-forge --no-anaconda-upload --croot /scratch/${USER}/conda-build --output-folder ${output_folder}
A second recipe that bundles the LANL internally linked documentation is found in waves/recipe-internal
and can be
built similarly by replacing recipe
with recipe-internal
in the above command.
This project uses the SCons build system. This section will discuss some common build operations. For a full list of
SCons command-line options and target build behavior, see the SCons manpage. The SCons manpage is also
installed with Scons in the environment and can be opened from the command-line as man scons
in the AEA Compute
environment. In local environments, the manpage may not be in the MANPATH
. You can find the manpage file and
make them available with something similar to any of the following, in increasing order of required background
knowledge.
# Activate the environment
$ conda activate waves-env
# Find the scons manpage file
$ find $CONDA_PREFIX -name scons.1
/path/to/waves-env/scons.1
# Open manpage directly
$ man $CONDA_PREFIX/scons.1
# Link SCons manpage to expected path and update MANPATH
$ ln -s $CONDA_PREFIX/scons.1 $CONDA_PREFIX/man/man1/scons.1
$ export MANPATH=$MANPATH:$CONDA_PREFIX/man
$ man scons
This project contains several, separate SCons project configurations, where the SConstruct
file name indicates an
SCons project by convention. The WAVES package and documentation are defined in the waves/SConstruct
file.
The modsim template and regression tests are defined in a separate waves/modsim_template/Sconstruct
file. The
WAVES tutorials each have a tutorial specific configuration file waves/tutorials/*SConstruct
. The following
build commands apply to each, but must be run from their respective project configuration parent directories, waves
,
waves/modsim_template
and waves/tutorials
. The available targets and aliases differ accordingly.
When executing the tutorials or modsim template build commands directly in the repository, the WAVES project root
repository must be put on PYTHONPATH
. In personal (but not shared) virtual environments, the preferred method is
to run conda develop .
once from the project root directory. See the Conda documentation for more information
about “development” mode installs. For shared environments, the preferred solution is to prefix the following commands
with PYTHONPATH=.. ``, where it is assumed that the ``PWD
is the tutorial or modsim template root directory.
View project specific command-line options, default targets, and aliases
$ scons -h ...
Build all default targets
$ scons
Build a specific target
$ scons <target name>
Remove the default targets’ artifacts
$ scons --clean
Remove all targets’ artifacts
$ scons . --clean
Test#
The project regression suite is collected under the regression
alias and can be run as
$ scons regression
By default, the system tests are configured to run with permissive skips for missing third-party software. This allows
developers to run as much of the system test suite as possible on local systems with incomplete third-party software
installations. To force the full execution of the system tests, a pass-through --unconditional-build
flag may be
added. This forces the documentation build, even if sphinx-build
is missing, and passes through pytest to the system
tests and tutorials as an SCons CLI option of the same name. The AEA RHEL CI server contains all necessary third-party
software, so the CI tests on this server require the full build as
$ scons regression --unconditional-build
The continuous integration server also performs a separate style guide check using flake8
and black
with
associated aliases.
$ scons flake8 black-check
If black
reports files that should be formatted, the following alias will format files using the same command line
options as the check alias. black
can also be run directly, but this may miss files without the .py
extension,
such as SConstruct and SConscript files. After formatting, the developer must review the changes and commit them to
their branch.
$ scons black-format
WAVES has dedicated target aliases for the unit and system tests. To run the unit tests, activate a conda environment and run
$ scons pytest
XML and HTML coverage reports are always generated for the pytest
alias. The XML output is used to provide coverage
visualization on merge requests. The HTML output can be opened with a browser to explore coverage interactively and is
uploaded to the internally hosted Gitlab-Pages documentation at:
https://aea.re-pages.lanl.gov/python-projects/waves/coverage/index.html.
$ scons pytest
$ ls build/pytest/coverage.xml build/pytest/coverage/index.html
build/pytest/coverage.xml build/pytest/coverage/index.html
$ find build/pytest -name coverage.xml -o -name index.html
build/pytest/coverage.xml
build/pytest/coverage/index.html
The tutorials and modsim template are run as system tests and require third-party software not available on conda-forge.
To run the system tests, install the third-party software and make them available in your PATH
, activate a conda
environment and run
$ scons systemtest
The full list of continuous integration test commands can be found in the Gitlab-CI file, .gitlab-ci.yml
.
$ pwd
path/to/local/git/clone/waves/
$ sed -n '/fast-test/,/tags/p' .gitlab-ci.yml
The WAVES unit and system tests may also be executed from the installation directory. These tests use pytest
directly and may require non-default pytest options and markers to execute the system tests serially. The full list of
CI commands may be found in the internal recipe file, recipe-internal/meta.yaml
, under the test
keyword. The
following grep command will show the pytest commands and options.
$ grep "pytest " recipe-internal/*
Test Local Package#
When testing CLI changes locally, the waves module must be run as a script. We must also set the PYTHONPATH
in order to include the current waves module when operating on a configuration that imports waves.
Below is an example of a visualization test of an SConstruct file using the local waves module.
$ pwd
path/to/local/git/clone/waves/
$ PYTHONPATH=$PWD python -m waves._main visualize . --sconstruct /path/to/local/SConstruct
Documentation#
The documentation build is automated with SCons as the documentation
target.
Build the WAVES documentation
$ pwd path/to/local/git/clone/waves/ $ scons documentation
Build the MODSIM-TEMPLATE documentation. The WAVES package must be on
PYTHONPATH
. For developers, the least disruptive solution is a per-command modification ofPYTHONPATH
.$ pwd path/to/local/git/clone/waves/modsim_template $ PYTHONPATH=/path/to/local/git/clone/waves:$PYTHONPATH scons documentation
Windows users#
This project uses symbolic links to minimize duplication of files where possible. Some files, such as the tutorial and modsim template package files, can not be shared in common due to their applications and the necessary directory structure for each. However, if the file content is identical, a symbolic link is used to avoid duplicating the entire file.
Symbolic links require special handling on Windows computers. If contributors are developing from a Windows machine, they are encouraged to
Read about
mklink
and “developer mode” for Windows 10/11Use an up-to-date version of git
Use one of the following git configurations
# Global configuration. Run from anywhere. > git config --global core.symlinks true # Local configuration. Run from repository root directory after cloning. > git config core.symlinks true
Use unix line endings with one of the following git configurations
# Global configuration. Run from anywhere. > git config --global core.autocrlf true # Local configuration. Run from repository root directory after cloning. > git config core.autocrlf true
Gitlab-CI#
AEA RHEL#
There are several known AEA RHEL CI fragile false-negative failure mechanisms. If one of these failures is observed, try re-running the CI job without change.
Conda environment creation fails in
conda-build
jobs. The shared conda command sometimes interferes with itself while running simultaneousconda-build
jobs.
HPC#
While the system tests are run with an HPC CI pipeline, the machine and runner uptime and system test runtime are considered too fragile for reliable use. The AEA RHEL system tests pass in less than 8 minutes, but the HPC system test job has been observed to complete in under 15 minutes or time out after an hour. The HPC CI system tests are always run for merge-requests and scheduled pipelines, but the pass/fail status is not used to mark CI tests as failing. Developers are encouraged to check the HPC system test results, but not required to address failing HPC CI pipelines.
The HPC CI jobs usually run in 15-25 minutes when it runs successfully.
There are several known HPC CI fragile false-negative failure mechanisms. If one of these failures is observed, try re-running the CI job without change.
Timeout at 1 hour
Windows#
While the system tests are run with a Windows CI pipeline, the Windows CI server does not have the full suite of third-party software required to run the full system tests. The pipeline is always run for merge-requests and scheduled pipelines, but it is considered experimental and the pass/fail status is not used to mark CI tests as failing. Developers are encouraged to check the Windows test results, but not required to address failing Windows CI pipelines.
The Windows CI jobs usually run in under 6 minutes.
There are several known Windows CI fragile false-negative failure mechanisms. If one of these failures is observed, try re-running the CI job without change.
Incorrect or imcomplete CI environment build:
Script file 'C:\ProgramData\anaconda3\envs\waves-dev\Scripts\sphinx-build-script.py' is not present.
MacOS#
While the system tests are run with a MacOS CI pipeline, the MacOS CI server does not have the full suite of third-party software required to run the full system tests. The pipeline is always run for merge-requests and scheduled pipelines, but it is considered experimental and the pass/fail status is not used to mark CI tests as failing. Developers are encouraged to check the MacOS test results, but not required to address failing MacOS CI pipelines.
The MacOS CI jobs usually run in under 3 minutes.