CIME.BuildTools package

Submodules

CIME.BuildTools.configure module

This script writes CIME build information to a directory.

The pieces of information that will be written include:

  1. Machine-specific build settings (i.e. the “Macros” file).

  2. File-specific build settings (i.e. “Depends” files).

  3. Environment variable loads (i.e. the env_mach_specific files).

The .env_mach_specific.sh and .env_mach_specific.csh files are specific to a given compiler, MPI library, and DEBUG setting. By default, these will be the machine’s default compiler, the machine’s default MPI library, and FALSE, respectively. These can be changed by setting the environment variables COMPILER, MPILIB, and DEBUG, respectively.

class CIME.BuildTools.configure.FakeCase(compiler, mpilib, debug, comp_interface, threading=False)[source]

Bases: object

get_build_threaded()[source]
get_case_root()[source]

Returns the root directory for this case.

get_value(attrib)[source]
set_value(attrib, value)[source]

Sets a given variable value for the case

CIME.BuildTools.configure.configure(machobj, output_dir, macros_format, compiler, mpilib, debug, comp_interface, sysos, unit_testing=False, noenv=False, threaded=False, extra_machines_dir=None)[source]

Add Macros, Depends, and env_mach_specific files to a directory.

Arguments: machobj - Machines argument for this machine. output_dir - Directory in which to place output. macros_format - Container containing the string ‘Makefile’ to produce

Makefile Macros output, and/or ‘CMake’ for CMake output.

compiler - String containing the compiler vendor to configure for. mpilib - String containing the MPI implementation to configure for. debug - Boolean specifying whether debugging options are enabled. unit_testing - Boolean specifying whether we’re running unit tests (as

opposed to a system run)

extra_machines_dir - String giving path to an additional directory that will be

searched for cmake_macros.

CIME.BuildTools.configure.copy_depends_files(machine_name, machines_dir, output_dir, compiler)[source]

Copy any system or compiler Depends files if they do not exist in the output directory If there is a match for Depends.machine_name.compiler copy that and ignore the others

CIME.BuildTools.configure.generate_env_mach_specific(output_dir, machobj, compiler, mpilib, debug, comp_interface, sysos, unit_testing, threaded, noenv=False)[source]

env_mach_specific generation.

Module contents