Development notes¶

Set up¶

Install all required packages for uDALES described in the prerequisites section, plus optionally Graphviz for generating graphs in the code viewer. E.g. installing all the required packages using Ubuntu's APT:

sudo apt update && sudo apt install -y gfortran libopenmpi-dev openmpi-bin libnetcdf-dev libnetcdff-dev graphviz

Then, to set up the development environment for testing and generating the docs, download the latest version of Miniconda and install the required dependencies with:

conda env create -f environment.yml

Then activate with conda activate udales.

Installation¶

To install uDALES on Linux, macOS, and WSL, use the following commands from the command prompt:

mkdir -p build/release
pushd build/release
cmake ../..
make

To know more about build options, please see build/default options.

Running¶

A uDALES simulation needs to be executed from a directory containing all required input files. Examples of experiments and required inputs are in the examples directory. To run a uDALES simulation you need to specify the number of cpus <NCPU>, the path to the build file <BUILD> and the simulation configuration file <NAMOPTIONS> and execute the simulation with the following command:

mpiexec -n <NCPU> <BUILD> <NAMOPTIONS>

Testing¶

Please refer to Test docs.

Documentation¶

mkdocs build --site-dir build/html
ford docs/udales-docs-software.md

Examples input plots¶

To create domain plots of the examples, run the following from your command line (requires MATLAB):

 matlab -nosplash -nodesktop -r "cd('tools/examples'); plot_blocks('<CASE_NUMBER>'); quit"

where <CASE_NUMBER> is e.g. 201. Plots are then saved in their respective example folders.

Examples outputs and plots¶

Run the following script to run and generate outputs for all example cases:

./tools/examples/run_examples.sh

Then, to create a sample plot for case 102 run the following from your command line (requires MATLAB):

matlab -nosplash -nodesktop -r "cd('tools/examples'); plot_fielddump_slice('102','u','y',32,1); quit"

Versioning¶

This project uses semantic versioning.