fre.make.create_compile_script module

Creates a compile script to compile the model and generate a model executable.

fre.make.create_compile_script.compile_create(yamlfile: str, platform: str, target: str, njobs: int = 4, nparallel: int = 1, execute: bool | None = False, verbose: bool | None = None)

Creates the compile script for bare-metal build

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

  • njobs (int) – Used for parallelism with make; number of files to build simultaneously; on a per-build basis (default 4)

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

  • execute (bool) – Run the created compile script to build a model executable

  • verbose (bool) – Increase verbosity output

Raises:

ValueError

  • Error if platform does not exist in platforms yaml configuration

  • Error if the mkmf template defined in platforms yaml does not exist