PyEHub
new_docs_with_examples
PyEHub Examples
Adding new constraints to the EHubModel
EvaluatorEH
Combining EnergyPlus and EnergyHub Evaluators
Editing the Excel model inside a notebook
Editing the Excel Network model inside a notebook
Energy Balance Analysis
Exploring command line features
Rooftop constraint
Tracking the roof area
Modify an existing constraint
Overriding input data
Overview of Energy Hub modelling on BESOS
Parameter Editor
Periodic Subproblems
Solution
Running the model normally
Removing an existing constraint
Running EHub on BESOS
Storage Analysis
Time-Resolved Carbon Factors
Importing a new time series
Objective:
Yukon
BC
Yukon
Optimal designs
Costs and carbon emissions
Pareto front
Modules
BatchRunExcel
capacity
ci
constraint
converter
ehub_model
epsilon_constraint
excel_to_request_format
expression
input_data
logger
multi_run_period
multiple_hubs
network
network_to_request_format
outputter
param_var
problem
request_format
response_format
run
storage
stream
time_series
tutorial
utils
variable
PyEHub
Docs
»
Index
Edit on GitLab
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
A
add_console_handler() (in module logger)
add_file_handler() (in module logger)
annual_maintenance_cost (data_formats.request_format.storage.Storage attribute)
area (data_formats.request_format.converter.Converter attribute)
B
BatchRunExcel (module)
BinaryVariable (class in pylp.variable)
C
c_matrix (energy_hub.input_data.InputData attribute)
cached_property() (in module energy_hub.utils)
calc_investment_cost() (energy_hub.ehub_model.EHubModel method)
calc_maintenance_cost() (energy_hub.ehub_model.EHubModel method)
calc_network_investment_cost() (multiple_hubs.NetworkModel method)
calc_operating_cost() (energy_hub.ehub_model.EHubModel method)
calc_total_carbon() (energy_hub.ehub_model.EHubModel method)
calc_total_cost() (energy_hub.ehub_model.EHubModel method)
(multiple_hubs.NetworkModel method)
capacities (energy_hub.input_data.InputData attribute)
Capacity (class in data_formats.request_format.capacity)
capacity (data_formats.request_format.converter.Converter attribute)
(data_formats.request_format.storage.Storage attribute)
capacity_bounds() (energy_hub.ehub_model.EHubModel method)
capital_cost (data_formats.request_format.converter.Converter attribute)
carbon_credits (energy_hub.input_data.InputData attribute)
carbon_factors (energy_hub.input_data.InputData attribute)
charge_efficiency (data_formats.request_format.storage.Storage attribute)
CheckError
ci (module)
co2 (data_formats.request_format.stream.Stream attribute)
co2_credit (data_formats.request_format.stream.Stream attribute)
compile() (energy_hub.ehub_model.EHubModel method)
ConstantOrVar (class in energy_hub.param_var)
Constraint (class in pylp.constraint)
constraint() (in module energy_hub.utils)
constraint_list() (in module energy_hub.utils)
constraints (energy_hub.ehub_model.EHubModel attribute)
construct() (pylp.constraint.Constraint method)
(pylp.expression.Expression method)
(pylp.variable.Variable method)
convert() (excel_to_request_format.Converter method)
(in module excel_to_request_format)
Converter (class in data_formats.request_format.converter)
(class in excel_to_request_format)
converter_names (energy_hub.input_data.InputData attribute)
converters (energy_hub.input_data.InputData attribute)
converters_capacity (energy_hub.input_data.InputData attribute)
cost (data_formats.request_format.storage.Storage attribute)
create_logger() (in module logger)
create_response() (in module data_formats.response_format)
D
data (data_formats.request_format.time_series.TimeSeries attribute)
data_formats.request_format.capacity (module)
data_formats.request_format.converter (module)
data_formats.request_format.network (module)
data_formats.request_format.request_format (module)
data_formats.request_format.storage (module)
data_formats.request_format.stream (module)
data_formats.request_format.time_series (module)
data_formats.response_format (module)
decay (data_formats.request_format.storage.Storage attribute)
demand_stream_names (energy_hub.input_data.InputData attribute)
demands (energy_hub.input_data.InputData attribute)
discharge_efficiency (data_formats.request_format.storage.Storage attribute)
domain (data_formats.request_format.capacity.Capacity attribute)
E
efficiency (data_formats.request_format.converter.Converter attribute)
EHubModel (class in energy_hub.ehub_model)
end_id (data_formats.request_format.network.Network_links attribute)
energy_balance() (energy_hub.ehub_model.EHubModel method)
energy_hub.ehub_model (module)
energy_hub.input_data (module)
energy_hub.param_var (module)
energy_hub.utils (module)
evaluate() (pylp.expression.Expression method)
(pylp.variable.Variable method)
excel_to_request_format (module)
export_price (data_formats.request_format.stream.Stream attribute)
export_streams (energy_hub.input_data.InputData attribute)
exportable (data_formats.request_format.stream.Stream attribute)
Expression (class in pylp.expression)
F
feed_in (energy_hub.input_data.InputData attribute)
fixed_capital_cost (data_formats.request_format.converter.Converter attribute)
(data_formats.request_format.storage.Storage attribute)
fixed_capital_costs (energy_hub.input_data.InputData attribute)
FormatUnsupportedError
fuel_price (energy_hub.input_data.InputData attribute)
G
get_command_line_arguments() (in module run)
get_default_formatter() (in module logger)
get_files_to_check() (in module ci)
get_output_fields() (in module BatchRunExcel)
H
has_part_load (data_formats.request_format.converter.Converter attribute)
I
import_streams (energy_hub.input_data.InputData attribute)
importable (data_formats.request_format.stream.Stream attribute)
InfeasibleConstraintError
InputData (class in energy_hub.input_data)
inputs (data_formats.request_format.converter.Converter attribute)
IntegerVariable (class in pylp.variable)
interest_rate (energy_hub.input_data.InputData attribute)
is_chp (data_formats.request_format.converter.Converter attribute)
is_demand (data_formats.request_format.time_series.TimeSeries attribute)
is_dispatch (data_formats.request_format.converter.Converter attribute)
is_grid (data_formats.request_format.converter.Converter attribute)
is_output (data_formats.request_format.stream.Stream attribute)
is_price (data_formats.request_format.time_series.TimeSeries attribute)
is_roof_tech (data_formats.request_format.converter.Converter attribute)
is_same_type() (pylp.expression.Expression method)
is_solar (data_formats.request_format.converter.Converter attribute)
(data_formats.request_format.time_series.TimeSeries attribute)
is_source (data_formats.request_format.time_series.TimeSeries attribute)
L
length (data_formats.request_format.network.Network_links attribute)
lifetime (data_formats.request_format.converter.Converter attribute)
(data_formats.request_format.storage.Storage attribute)
linear_cost (energy_hub.input_data.InputData attribute)
linear_power_flow_constraint() (in module multiple_hubs)
link_capacity (data_formats.request_format.network.Network_links attribute)
(energy_hub.input_data.InputData attribute)
link_capacity_constraint() (in module multiple_hubs)
link_cost (data_formats.request_format.network.Network_links attribute)
link_end (energy_hub.input_data.InputData attribute)
link_id (data_formats.request_format.network.Network_links attribute)
link_is_installed() (multiple_hubs.NetworkModel method)
link_is_installed_2() (multiple_hubs.NetworkModel method)
link_length (energy_hub.input_data.InputData attribute)
link_reactance (data_formats.request_format.network.Network_links attribute)
(energy_hub.input_data.InputData attribute)
link_start (energy_hub.input_data.InputData attribute)
link_thermal_loss (energy_hub.input_data.InputData attribute)
link_type (data_formats.request_format.network.Network_links attribute)
(energy_hub.input_data.InputData attribute)
links_ids (energy_hub.input_data.InputData attribute)
lint() (in module ci)
loads (energy_hub.input_data.InputData attribute)
logger (module)
lower_bound (data_formats.request_format.capacity.Capacity attribute)
M
main() (in module ci)
(in module excel_to_request_format)
(in module pylp.tutorial)
(in module run)
max_capacity (data_formats.request_format.converter.Converter attribute)
max_carbon_level() (energy_hub.ehub_model.EHubModel method)
max_charge (data_formats.request_format.storage.Storage attribute)
max_discharge (data_formats.request_format.storage.Storage attribute)
merge_hubs() (in module multi_run_period)
min_load (data_formats.request_format.converter.Converter attribute)
min_state (data_formats.request_format.storage.Storage attribute)
multi_run_output() (in module multi_run_period)
multi_run_period (module)
multiple_hubs (module)
multiple_hubs() (in module multiple_hubs)
N
name (data_formats.request_format.capacity.Capacity attribute)
(data_formats.request_format.converter.Converter attribute)
(data_formats.request_format.storage.Storage attribute)
(data_formats.request_format.stream.Stream attribute)
(data_formats.request_format.time_series.TimeSeries attribute)
network_constraint() (in module multiple_hubs)
Network_links (class in data_formats.request_format.network)
network_to_request_format (module)
NetworkModel (class in multiple_hubs)
O
objective (energy_hub.ehub_model.EHubModel attribute)
output_excel() (in module outputter)
output_ratios (data_formats.request_format.converter.Converter attribute)
output_stream_names (energy_hub.input_data.InputData attribute)
output_to_excel() (in module BatchRunExcel)
outputs (data_formats.request_format.converter.Converter attribute)
outputter (module)
P
parse_args() (in module excel_to_request_format)
parse_arguments() (in module run)
part_load (energy_hub.input_data.InputData attribute)
part_load_techs (energy_hub.input_data.InputData attribute)
place_in_dict() (in module outputter)
plot_energy_balance() (in module outputter)
plot_storages() (in module outputter)
pretty_print() (in module outputter)
price (data_formats.request_format.stream.Stream attribute)
print_capacities() (in module outputter)
print_section() (in module outputter)
print_warning() (in module outputter)
pulp_name() (pylp.variable.Variable class method)
pylp.constraint (module)
pylp.expression (module)
pylp.problem (module)
pylp.tutorial (module)
pylp.variable (module)
R
RealVariable (class in pylp.variable)
recompile() (energy_hub.ehub_model.EHubModel method)
RequestValidationError
ResponseValidationError
run (module)
run_doctests() (in module ci)
run_linting() (in module ci)
run_split_period() (in module multi_run_period)
run_system_test() (in module ci)
S
same_converter_constraint() (in module multi_run_period)
same_storage_constraint() (in module multi_run_period)
solve() (energy_hub.ehub_model.EHubModel method)
(in module pylp.problem)
sort_dict() (in module outputter)
source (energy_hub.input_data.InputData attribute)
source_stream_names (energy_hub.input_data.InputData attribute)
split_hubs() (in module multi_run_period)
start_id (data_formats.request_format.network.Network_links attribute)
Status (class in pylp.problem)
status (pylp.problem.Status attribute)
Storage (class in data_formats.request_format.storage)
storage_annual_maintenance_cost (energy_hub.input_data.InputData attribute)
storage_balance() (energy_hub.ehub_model.EHubModel method)
storage_capacity (energy_hub.input_data.InputData attribute)
storage_charge (energy_hub.input_data.InputData attribute)
storage_charge_rate() (energy_hub.ehub_model.EHubModel method)
storage_discharge (energy_hub.input_data.InputData attribute)
storage_discharge_rate() (energy_hub.ehub_model.EHubModel method)
storage_ef_ch (energy_hub.input_data.InputData attribute)
storage_ef_disch (energy_hub.input_data.InputData attribute)
storage_fixed_capital_cost (energy_hub.input_data.InputData attribute)
storage_input_positive() (energy_hub.ehub_model.EHubModel method)
storage_is_installed() (energy_hub.ehub_model.EHubModel method)
storage_is_installed_2() (energy_hub.ehub_model.EHubModel method)
storage_level_above_minimum() (energy_hub.ehub_model.EHubModel method)
storage_level_below_capacity() (energy_hub.ehub_model.EHubModel method)
storage_level_positive() (energy_hub.ehub_model.EHubModel method)
storage_lin_cost (energy_hub.input_data.InputData attribute)
storage_looping() (energy_hub.ehub_model.EHubModel method)
storage_loss (energy_hub.input_data.InputData attribute)
storage_min_soc (energy_hub.input_data.InputData attribute)
storage_names (energy_hub.input_data.InputData attribute)
storage_npv (energy_hub.input_data.InputData attribute)
storage_output_positive() (energy_hub.ehub_model.EHubModel method)
storages (energy_hub.input_data.InputData attribute)
Stream (class in data_formats.request_format.stream)
stream (data_formats.request_format.storage.Storage attribute)
(data_formats.request_format.time_series.TimeSeries attribute)
stream_info() (in module outputter)
stream_names (energy_hub.input_data.InputData attribute)
stream_timeseries (energy_hub.input_data.InputData attribute)
streams (energy_hub.input_data.InputData attribute)
T
tech_export_positive() (energy_hub.ehub_model.EHubModel method)
tech_import_positive() (energy_hub.ehub_model.EHubModel method)
tech_input_below_capacity() (energy_hub.ehub_model.EHubModel method)
tech_input_positive() (energy_hub.ehub_model.EHubModel method)
tech_is_installed() (energy_hub.ehub_model.EHubModel method)
tech_is_installed_2() (energy_hub.ehub_model.EHubModel method)
tech_is_on() (energy_hub.ehub_model.EHubModel method)
tech_is_on_2() (energy_hub.ehub_model.EHubModel method)
tech_npv (energy_hub.input_data.InputData attribute)
tech_part_loads() (energy_hub.ehub_model.EHubModel method)
time (energy_hub.input_data.InputData attribute)
(pylp.problem.Status attribute)
time_series_data (energy_hub.input_data.InputData attribute)
time_series_list (energy_hub.input_data.InputData attribute)
TimeSeries (class in data_formats.request_format.time_series)
timeseries (data_formats.request_format.stream.Stream attribute)
to_dataframe() (in module outputter)
to_dataframes() (in module outputter)
total_pressure_loss (data_formats.request_format.network.Network_links attribute)
total_thermal_loss (data_formats.request_format.network.Network_links attribute)
U
upper_bound (data_formats.request_format.capacity.Capacity attribute)
usage_maintenance_cost (data_formats.request_format.converter.Converter attribute)
V
validate() (in module data_formats.request_format.request_format)
(in module data_formats.response_format)
values (energy_hub.param_var.ConstantOrVar attribute)
Variable (class in pylp.variable)
variable_maintenance_cost (energy_hub.input_data.InputData attribute)
Read the Docs
v: new_docs_with_examples
Versions
latest
new_docs_with_examples
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.