mache.MachineInfo

class mache.MachineInfo(machine=None, quiet=False)[source]

An object containing information about an E3SM supported machine

Variables:

  • machine (str) – The name of an E3SM supported machine

  • config (configparser.ConfigParser) – Config options for this machine

  • e3sm_supported (bool) – Whether this machine supports running E3SM itself, and therefore has a list of compilers, MPI libraries, and the modules needed to load them

  • compilers (list) – A list of compilers for this machine if e3sm_supported == True

  • mpilibs (list) – A list of MPI libraries for this machine if e3sm_supported == True

  • os (str) – The machine’s operating system if e3sm_supported == True

  • e3sm_unified_mpi ({'nompi', 'system', None}) – Which MPI type is included in the E3SM-Unified environment (if one is loaded)

  • e3sm_unified_base (str) – The base path where E3SM-Unified and its activation scripts are installed if e3sm_unified is not None

  • e3sm_unified_activation (str) – The activation script used to activate E3SM-Unified if e3sm_unified is not None

  • diagnostics_base (str) – The base directory for diagnostics data

  • inputdata_base (str) – The base directory for inputdata

  • web_portal_base (str) – The base directory for the web portal

  • web_portal_url (str) – The base URL for the web portal

  • username (str) – The name of the current user, for use in web-portal directories. This value is also added to the web_portal and username option of the config attribute.

__init__(machine=None, quiet=False)[source]

Create an object with information about the E3SM supported machine

Parameters:

  • machine (str, optional) – The name of an E3SM supported machine. By default, the machine will be inferred from the host name

  • quiet (bool, optional) – Whether to print warnings if the machine name is ambiguous

Methods

__init__([machine, quiet])

Create an object with information about the E3SM supported machine

get_account_defaults()

Get default account, partition and quality of service (QOS) for this machine.

get_partition_specs()

Get partition policy metadata for the machine.

get_qos_specs()

Get quality-of-service (QOS) policy metadata for the machine.

get_queue_specs()

Get queue policy metadata for the machine.

get_scheduler_specs(target_type)

Get scheduler target metadata for queues or partitions.