fre.make.create_docker_script module

Creates a Dockerfile and container build script

If the build script is executed, a singularity image file (.sif) is generated.

fre.make.create_docker_script.dockerfile_create(yamlfile: str, platform: str, target: str, execute: bool | None = False, no_format_transfer: bool | None = False)

Creates the dockerfile and container build script for a container build

Parameters:

  • yamlfile (str) – Model compile YAML file

  • platform (str) – FRE container platform; container platforms are defined in the platforms yaml. Container platforms can build non-shareable (includes intel compilers) and shareable (does not include intel compilers) singularity image files. An example of a non-shareable container platform is “hpcme.2023”

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

  • execute (bool) – Run the created dockerfile to build a container

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

Raises:

ValueError – Error if platform does not exist in platforms yaml configuration

Note

To build an image on GFDL’s RDHPCS GAEA, please submit a GFDL helpdesk ticket for podman access.