wolfhece.hydrology.Internal_variables

Module Contents

wolfhece.hydrology.Internal_variables.ALL_VAR = 0

wolfhece.hydrology.Internal_variables.IV_VAR = 1

wolfhece.hydrology.Internal_variables.FRAC_VAR = 2

wolfhece.hydrology.Internal_variables.FINAL_OUT_VAR = 3

wolfhece.hydrology.Internal_variables.OUT_VAR = 4

wolfhece.hydrology.Internal_variables.DEFAULT_VAR = 5

class wolfhece.hydrology.Internal_variables.Internal_Variable

Class for managing internal variables in hydrological models.

name: str

file: str

type_of_var: int

linked_param: int

id: int

get_time_serie(directory, prefix_file: str = '', interval: tuple[datetime.datetime, datetime.datetime] | None = None) → tuple[numpy.ndarray, numpy.ndarray]

Get the time series of the internal variable.

Parameters:

interval – Optional interval for the time series.

Returns:

Time series of the internal variable.

get_filename(directory: str, prefix: str = '') → tuple[str, str]

Get the filename of the internal variable.

Parameters:

• directory – Directory where the file is located.

• prefix – Prefix for the filename.

Returns:

Tuple containing the name of the file only and the full path of the internal variable.

class wolfhece.hydrology.Internal_variables.Param_to_Activate(key: str = '', group: str = '', file: str = '', all_variables: list[Internal_Variable] = [])

Class for managing parameters to activate in hydrological models.

key: str

group: str

file: str

all_variables: list[Internal_Variable]

add_param_info(key: str, group: str, file: str)

Add parameter information to the class.

check_param_file(directory: str)

Define the working directory for the parameters.

add_variable(variable: Internal_Variable | list[Internal_Variable])

Add one or a list of internal variable(s) to the list of variables.

get_variables_names() → list[str]

Get the names of the internal variables.

get_variables_files() → list[str]

Get the files of the internal variables.

activate(directory: str, prefix_file: str = '', type_of_var: int = ALL_VAR)

Activate the parameters for the internal variables.

deactivate(directory: str, prefix_file: str = '')

Deactivate the parameters for the internal variables.

get_iv_timeseries(directory: str, prefix_file: str = '', interval: tuple[datetime.datetime, datetime.datetime] | None = None, type_of_var: int = ALL_VAR) → dict[str, numpy.ndarray]

Get the time series of the internal variables.

Parameters:

• directory – Directory where the file is located.

• prefix_file – Prefix for the filename.

• interval – Optional interval for the time series.

Returns:

List of tuples containing the time and internal variable data.

get_linked_params() → dict[str, int]

Get the linked parameters of the internal variables.

Returns:

Dictionary of linked parameters.

_build_prefix(prefix_file: str) → str

Build the prefix for the filename.

Parameters:

prefix_file – Prefix for the filename.

Returns:

Prefix for the filename.

class wolfhece.hydrology.Internal_variables.Group_to_Activate(name: str = '', all_params: list[Param_to_Activate] = [])

Class for managing groups of parameters to activate in hydrological models.

name: str

all_params: list[Param_to_Activate]

get_keys() → list[str]

Get the keys of the parameters.

get_files_per_keys() → list[str]

Get the files of the parameters.

activate_all(directory: str, prefix_file: str = '', type_of_var: int = ALL_VAR)

Activate all parameters in the group.

deactivate_all(directory: str, prefix_file: str = '')

Deactivate all parameters in the group.

get_all_iv_timeseries(directory: str, prefix_file: str = '', interval: tuple[datetime.datetime, datetime.datetime] | None = None, type_of_var: int = ALL_VAR) → dict[str, numpy.ndarray]

Get the time series of all internal variables in the group.

Parameters:

• directory – Directory where the file is located.

• prefix_file – Prefix for the filename.

• interval – Optional interval for the time series.

Returns:

List of tuples containing the time and internal variable data.

get_all_linked_params() → dict[str, int]

Get the linked parameters of the internal variables.

Returns:

Dictionary of linked parameters.

get_all_variables_names_from_ids(ids: list[int], type_of_var: int = ALL_VAR) → tuple[list[str], list[int]]

Get the names of the internal variables from their IDs.

Parameters:

ids – List of IDs of the internal variables.

Returns:

List of names of the internal variables.

get_dict_from_matrix_and_ids(matrix: numpy.ndarray, ids: list[int], type_of_var: int = ALL_VAR) → dict[str, numpy.ndarray]

Get a dictionary from a matrix and a list of IDs.

Parameters:

• matrix – Matrix containing the data.

• ids – List of IDs corresponding to the data.

Returns:

Dictionary with IDs as keys and data as values.