fre.make.fremake module

Module defining the click interfaces for the following fre make subcommands:

  • fre make checkout-script [ARGS]: writes a script that will clone (checkout) the model code from respective git repositories

  • fre make makefile [ARGS]: writes a Makefile that will compile the model code

  • fre make compile-script [ARGS]: writes a compile script that will configure the compile environment and execute make

  • fre make dockerfile [ARGS]: writes a Dockerfile and createContainer.sh script that will generate a container image (.sif format) that contains the source code, Makefile, model executable and its dependent libraries

  • fre make all [ARGS]: executes the above fre make subcommands in the appropriate order to generate a model executable or container

Please see README.md at fre-cli/fre/make/README.md for a quickstart guide.

class fre.make.fremake.OrderedGroup(name: str | None = None, commands: MutableMapping[str, Command] | Sequence[Command] | None = None, invoke_without_command: bool = False, no_args_is_help: bool | None = None, subcommand_metavar: str | None = None, chain: bool = False, result_callback: Callable[[...], Any] | None = None, **kwargs: Any)

Bases: Group

list_commands(ctx)

Returns a list of subcommand names in the order they should appear.