polaris.build.mpas_ocean.build_mpas_ocean

polaris.build.mpas_ocean.build_mpas_ocean(branch, build_dir, clean, quiet, debug, make_flags, make_target, log_filename=None)[source]

Build MPAS-Ocean on the current machine.

Parameters:

  • branch (str) – The relative or absolute path to the base of the MPAS-Ocean branch to build.

  • build_dir (str) – The directory in which to build MPAS-Ocean.

  • clean (bool) – Whether to clean the build directory before building.

  • quiet (bool) – Whether to build quietly (suppress output).

  • debug (bool) – Whether to build in debug mode.

  • make_flags (str) – Additional flags to pass to the build system.

  • make_target (str) – The make target to build.

  • log_filename (str, optional) – The filename to use for logging build output.