ExaWind Build Scripts User Manual

Version:v0.0.1 Date:Dec 13, 2020

ExaWind Builder is a collection of bash scripts to configure and compile the codes used within the ExaWind project on various high-performance computing (HPC) systems. The builder provides the following

• Platform configuration: Provides the minimal set of modules that must be loaded when compiling with different compilers and MPI libraries on different HPC systems.
• Software configuration: Provides baseline CMake configuration that can be used to configure the various options when building a project, e.g., enable/disable optional modules, automate specification of paths to various libraries, configure release vs. debug builds.
• Build script generation: Generates an executable end-user script for a combination of system, compiler, and project.
• Exawind environment generation: Generates a source-able, platform-specific script that allows the user to recreate the exact environment used to build the codes during runtime.

The build scripts are intended for developers who might want to compile the codes with different configuration options, build different branches during their development cycle, or link to a different development version of a library that is currently not available in the standard installation on the system.

Contents

• Introduction
  • Use cases
  • Exawind directory structure
• Setting up exawind-builder
  • Basic installation for all systems
  • Setting up custom ExaWind python environment
  • Initial Homebrew Setup for Mac OS-X Users
• Using exawind-builder to build software
  • Configuring exawind-builder
  • Compiling Software
    • Available tasks in the build script
  • Customizing the build process
    • Customizing module load
    • Enabling/Disabling TPLs
    • Using custom builds of libraries
    • Overriding default behavior
      • Customizing ExaWind environment
      • Customizing CMake configuration phase
  • Activating ExaWind environment for job submissions
• Adding new system configuration
  • Determine system configuration
  • Create skeleton directory structure
  • Create minimal bootstrap environment
  • Create Spack configuration
    • Spack compiler configuration
    • Spack package configuration
    • Spack config.yaml
  • Create system environment configuration
  • Run bootstrap
• Manual Installation
  • Setting up dependencies
    • Install dependencies via spack (all systems)
  • Generate builder configuration
  • Generating Build Scripts
  • Creating runtime environment script
  • Configuring exawind-builder to use Ninja
  • Compiling Nalu-Wind
• Reference
  • Configuration variables
    • ExaWind Builder configuration
    • Variables controlling project properties
    • Variables controlling build process
      • Common build variables
      • Nalu-Wind
      • OpenFAST
      • Trilinos
      • HYPRE
  • Function reference
    • User customization functions
    • Core functions
    • System specific functions
    • Project specific functions

Indices and tables

• Index
• Module Index
• Search Page