Configuration Files

NEMS configuration file (nems.configure)

class nemspy.configuration.NEMSConfigurationFile(sequence: nemspy.configuration.RunSequence)

nems.configure file, containing NEMS members, coupling connections, and run sequence information

Parameters

sequence – run sequence object containing models and order

property entries: List[nemspy.model.base.AttributeEntry]

list of attributed configuration entries, including the Earth system, models, and run sequence

property version_header: str

comment header indicating filename and NEMSpy version

write(filename: os.PathLike, overwrite: bool = False, include_version: bool = False) → pathlib.Path

write this configuration to file

Parameters

  • filename – path to file

  • overwrite – overwrite an existing file

  • include_version – include NEMSpy version information

Returns

path to written file

Model Configuration File (model_configure / atm_namelist.rc)

class nemspy.configuration.ModelConfigurationFile(start_time: datetime.datetime, duration: datetime.timedelta, sequence: nemspy.configuration.RunSequence, create_atm_namelist_rc: bool = True)

model_configure file, containing information on modeled start and end times, as well as ensemble information also aliased to atm_namelist.rc

Parameters

  • start_time – start time in model time

  • duration – duration in model time

  • sequence – run sequence containing models, connections, and order

  • create_atm_namelist_rc – whether to create a symlink to atm_namelist.rc

property version_header: str

comment header indicating filename and NEMSpy version

write(filename: os.PathLike, overwrite: bool = False, include_version: bool = False) → pathlib.Path

write this configuration to file

Parameters

  • filename – path to file

  • overwrite – overwrite an existing file

  • include_version – include NEMSpy version information

Returns

path to written file

File Forcing Configuration File (config.rc)

class nemspy.configuration.FileForcingsFile(sequence: nemspy.configuration.RunSequence)

config.rc file, containing paths to forcing files

Parameters

sequence – run sequence object containing models and order

property entries: List[nemspy.model.base.FileForcingEntry]

list of file forcing entries

property version_header: str

comment header indicating filename and NEMSpy version

write(filename: os.PathLike, overwrite: bool = False, include_version: bool = False) → pathlib.Path

write this configuration to file

Parameters

  • filename – path to file

  • overwrite – overwrite an existing file

  • include_version – include NEMSpy version information

Returns

path to written file

abstract class

class nemspy.configuration.ConfigurationFile(sequence: nemspy.configuration.RunSequence)

abstraction of a configuration file

Parameters

sequence – run sequence object containing models and order

name

alias of NotImplementedError

property version_header: str

comment header indicating filename and NEMSpy version

write(filename: os.PathLike, overwrite: bool = False, include_version: bool = False) → pathlib.Path

write this configuration to file

Parameters

  • filename – path to file

  • overwrite – overwrite an existing file

  • include_version – include NEMSpy version information

Returns

path to written file