hydrowizard package

Subpackages

• hydrowizard.scripts package
  • Submodules
  • hydrowizard.scripts.run_optimization module
    • create_basin()
    • main()
    • main_entry()
    • optimize_basin()
  • hydrowizard.scripts.run_simulation module
    • create_basin()
    • expand_dates()
    • get_policy_params()
    • main()
    • main_entry()
  • Module contents

Submodules

hydrowizard.basin module

class hydrowizard.basin.Basin(basin_config=None, nodes_config=None, flows_config=None, objectives_config=None, basin_data_dir=None, output_dir=None)

Bases: object

add_flows_to_nodes()

calculate_integration_interval_count()

calculate_integration_interval_start_end_times()

static calculate_power_generation(flow_rate, reservoir_head, turbine_head, efficiency, max_power, rho=1000, g=9.81)

Calculate the power generation based on inflow rate, reservoir head, turbine head, efficiency, and max power.

calculate_simulation_end_time()

check_basin_graph()

compute_annual_hydropower_generation(df_flow_rates, df_node_volumes, node_name, round_decimals=2)

Compute the annual hydropower generation for each hydropower plant.

compute_hypervolume(F)

compute_objectives(df_flow_rates, df_node_volumes, round_decimals=2)

compute_quantile_monthly_demand_deficit(df_flow_rates, flow_name, quantile, round_decimals=2)

create_base_flow_rates_dataframe()

create_base_node_volumes_dataframe()

static create_basin_from_yaml(filepath, simulation_horizon=None, integration_interval_duration=None, output_dir='outputs/')

create_basin_graph()

create_demand_rates_for_cyclostationarity_interval_number_dataframe()

create_evaporation_rates_of_evaporation_flows_for_cyclostationarity_interval_number_dataframe()

create_flow_rates_of_x_flows_for_cyclostationarity_interval_number_dataframe()

create_flows()

create_nodes()

create_rbf_network_for_basin(parameters=None)

export_basin_graph(output_dir=None, filename='basin', format='pdf')

export_basin_graphs_for_intervals(interval_list, df_flow_rates, df_node_volumes, output_dir=None, format='pdf')

export_config(filename, additional_info)

generate_cyclostationarity_interval_numbers()

get_all_flows()

get_all_nodes()

get_best_solution_indices(F, print_results=False)

get_evaporation_flow_rates_for_interval(df_flow_rates, df_node_volumes, interval_index)

get_inflows()

get_l_flows()

get_mean_monthly_deficit_percentage_dataframe(df_flow_rates, round_decimals=2)

get_mean_monthly_deficit_rates_dataframe(df_flow_rates, round_decimals=2)

get_mean_monthly_demand_rates_dataframe()

get_mean_monthly_flow_rates_dataframe(df_flow_rates, round_decimals=2)

get_normalized_policy_inputs_for_interval(df_flow_rates, df_node_volumes, interval_index)

get_outflows()

get_policy_decisions_using_rbf_network(policy_function, policy_inputs)

get_policy_inputs_for_interval(df_flow_rates, df_node_volumes, interval_index)

get_policy_outputs_for_interval(policy_function, df_flow_rates, df_node_volumes, interval_index)

get_power_generation(df_flow_rates, df_node_volumes)

get_r_flows()

get_reservoir_nodes()

get_sorted_node_names()

get_x_flows()

initialize_basin()

normalize_policy_inputs(policy_inputs)

parse_rate_input(rate_input)

plot_demand_deficit_percentages(flow_rates, subset=None, max_plots_per_row=3)

plot_demand_deficit_rates(flow_rates, subset=None, max_plots_per_row=3)

plot_flow_rates(flow_rates, subset=None, max_plots_per_row=3)

plot_node_volumes(node_volumes, subset=None, max_plots_per_row=3)

plot_power_generation(flow_rates, node_volumes, subset=None, max_plots_per_row=3)

print_basin_summary()

static read_bathymetry_data(filepath)

Reads bathymetry data from an Excel file and returns a DataFrame with renamed columns.

Args: filepath (str): Path to the Excel file containing bathymetry data.

Returns: pd.DataFrame: DataFrame containing the bathymetry data with renamed columns.

static read_mean_monthly_values_from_file(filepath, round_decimals=2)

Creates a list of mean values from a given Excel file.

Args: filepath (str): Path to the Excel file containing flow data.

Returns: list: List of mean values for each month.

scale_policy_outputs(policy_outputs)

set_cyclostationarity_interval_count()

set_evaporation_flow_name_for_reservoir_node_name()

set_hydropower_plants_properties()

set_initial_node_volumes()

set_maximum_objective_scores()

set_minimum_objective_scores()

set_months_count_and_start_end_times()

set_objectives_names()

set_policy_inputs_max_values()

set_policy_inputs_min_values()

set_policy_inputs_names()

set_policy_outputs_max_values()

set_policy_outputs_min_values()

set_policy_outputs_names()

set_release_flow_name_for_reservoir_node_name()

set_reservoir_node_name_for_evaporation_flow_name()

set_reservoir_node_parameters()

Sets bathymetry, max_volume, and initial_volumes for reservoir nodes in the basin.

Args: nodes_config (list): List of node configurations. basin_data_dir (str): Directory path where the data files are located.

simulate_basin(policy_function, end_interval=None, print_progress=True, export_results=False, output_dir=None)

to_dict()

Converts the Basin object to a dictionary for easy inspection.

update_system_state_for_interval(policy_function, df_flow_rates, df_node_volumes, interval_index, round_decimals=2)

update_x_flow_rates_for_interval(df_flow_rates, interval_index)

visualize(interval_index=None, df_flow_rates=None, df_node_volumes=None)

hydrowizard.db_logging module

hydrowizard.db_logging.create_db_engine_and_session(config)

hydrowizard.db_logging.get_combined_pareto_front(basin, include_intermediate_results=False)

hydrowizard.db_logging.get_pareto_indices(scores)

hydrowizard.db_logging.get_previous_generations_results(basin)

hydrowizard.db_logging.get_previous_optimization_results(basin)

hydrowizard.db_logging.get_unique_indices(X)

hydrowizard.db_logging.load_config(file_path='config.ini')

hydrowizard.db_logging.log_optimization_generation(run_id, generation_number, start_time, end_time, duration, population_size, hypervolume, best_X, best_F)

hydrowizard.db_logging.log_optimization_run_end(run_id, results)

hydrowizard.db_logging.log_optimization_run_start(id, basin, population_size, num_generations, random_seed, biased_initial_population)

hydrowizard.flow module

class hydrowizard.flow.Flow(name, kind, source_node=None, target_node=None, max_rate=None)

Bases: object

to_dict()

hydrowizard.node module

class hydrowizard.node.Node(name, reservoir_node=False)

Bases: object

convert_volume_to_surface_head(volume, round_decimals_surface=1, round_decimals_head=5)

to_dict()

hydrowizard.optimization module

class hydrowizard.optimization.MultiObjectiveBasinProblem(config_file, simulation_horizon, interval_duration, **kwargs)

Bases: ElementwiseProblem

hydrowizard.rbf_network module

class hydrowizard.rbf_network.RBFNetwork(input_dim, output_dim, centers, betas, weights)

Bases: object

evaluate(x)

rbf(x, center, beta)

Module contents