spyice.utils package

Submodules

• src.spyice.utils.config_sort
  • ConfigData
  • ConfigSort
  • read_omegaconfig()
• src.spyice.utils.error_norms
  • ErrorNorms
• src.spyice.utils.helpers
  • export_residuals()
  • set_dataclass()
  • t_total()
• src.spyice.utils.spyice_exceptions module
  • ConvergenceError
  • InvalidPhaseError
• src.spyice.utils.spyice_logger
  • SpyiceLogger
• spyice.utils.initial_userinput
• Functions
  • calculate_initial_melt_temperature_onephase
  • calculate_initial_temperature_frezchem
  • calculate_initial_melt_temperature_twophase
  • calculate_initial_melt_temperature
• spyice.utils.create_directory
• Functions
  • create_output_directory

Module contents

class src.spyice.utils.ConfigSort

Bases: object

A class that provides methods for retrieving configuration parameters.

Parameters:

config (DictConfig) – The configuration dictionary.

Variables:

config (DictConfig) – The configuration dictionary.

get_config_params(config

DictConfig): Retrieves configuration parameters using the ‘consts’, ‘dt’, ‘S_IC’, and ‘iter_max’ keys.

get_ownconfig_params(config)

Retrieves configuration parameters using the ‘constants’, ‘dt’, ‘S_IC’, and ‘iter_max’ keys.

getconfig_dataclass(config, config_type='default')

Retrieves configuration parameters based on the specified config_type.

Parameters:

• config (dataclass)

• config_type (str)

Return type:

dataclass

__init__(config)

A class that provides methods for retrieving configuration parameters.

Parameters:

config (DictConfig) – The configuration dictionary.

Variables:

config (DictConfig) – The configuration dictionary.

get_config_params(config

DictConfig): Retrieves configuration parameters using the ‘consts’, ‘dt’, ‘S_IC’, and ‘iter_max’ keys.

get_ownconfig_params(config)

Retrieves configuration parameters using the ‘constants’, ‘dt’, ‘S_IC’, and ‘iter_max’ keys.

getconfig_dataclass(config, config_type='default')

Retrieves configuration parameters based on the specified config_type.

Parameters:

• config (dataclass)

• config_type (str)

Return type:

dataclass

get_config_params(config)

Get the configuration parameters from the given config dictionary.

Parameters:

config (DictConfig) – The configuration dictionary.

Returns:

None

Raises:

None –

get_ownconfig_params(config)

Retrieves the parameters from the given configuration dictionary.

Parameters:

config (dict) – The configuration dictionary.

Returns:

None

classmethod getconfig_dataclass(config, config_type='default')

Retrieves configuration parameters based on the specified config_type.

Parameters:

• config (dataclass) – The configuration dictionary.

• config_type (str) – The type of configuration “default” or “jupyter”. “jupyter” is used for Jupyter notebook configurations.

Returns:

An instance of the ConfigData class.

Return type:

ConfigData

src.spyice.utils.create_output_directory(hyd_dir, initial_salinity, boundary_condition_type, grid_resolution_dz, grid_timestep_dt, max_iterations, output_suffix)

Creates an output directory for storing temperature data.

Parameters:

hyd_dir (str) – The directory path where the output directory will be created.

Returns:

The path of the created output directory.

Return type:

str

Raises:

None –