fre.make.run_fremake_script module

For a bare-metal build: Creates and runs the checkout script to check out source code,

creates the makefile, and creates the compile script to generate a model executable.

For a container build: Creates the checkout script and makefile, and creates and runs a

dockerfile to generate a singularity image file.

fre.make.run_fremake_script.fremake_run(yamlfile: str, platform: str, target: str, nparallel: int = 1, njobs: int = 4, no_parallel_checkout: bool | None = None, no_format_transfer: bool | None = False, execute: bool | None = False, force_checkout: bool | None = False, verbose: bool | None = None)

Runs all of fre make code

Parameters:

• yamlfile (str) – Model compile YAML file

• platform (str) – FRE platform; defined in the platforms yaml If on gaea c5, a FRE platform may look like ncrc5.intel23-classic

• target (str) – Predefined FRE targets; options include [prod/debug/repro]-openmp

• nparallel (int) – Number of concurrent model builds (default 1)

• njobs (int) – Number of jobs to run simultaneously; used for parallelism with make and recursive cloning with checking out source code (default 4)

• no_parallel_checkout (bool) – Use this option if you do not want a parallel checkout

• no_format_transfer (bool) – Skip the container format conversion to a .sif file

• execute (bool) – Run the created compile script or dockerfile to create a model executable or container

• force_checkout (bool) – Re-create the checkout script if changes were made to configurations

• verbose (bool) – Increase verbosity output