topsim.core.config.Config

class topsim.core.config.Config(config)[source]

Process the configuration of the current simulation

Parameters:

config (path) – File path to the JSON config file

instrument

Data for the instrument constructor

Type:

dict

cluster

Data for the cluster constructor

Type:

dict

buffer

Data for buffer constructor

Type:

dict

timestep_unit

String value that specifies what granualirity of time is being used in the simulation

Type:

str

Raises:
  • OSError – This is raised if we cannot read the configuration file/it does not exist

  • json.JSONDecodeError – This is raised if the JSON file is in the wrong format

  • KeyError – Raised if one of the attribute-keys is not found in the provided JSON file.

Methods

__init__(config)

get_max_ingest(instrument_name)

parse_buffer_config()

parse_cluster_config()

parse_instrument_config(instrument_name)