Multi-Vector Simulator (MVS)
latest
Getting Started
Installation
Simulating with the MVS
Examples
Example of PV + Battery + Grid
Adding a timeseries for a parameter
Using multiple in- or output busses
Tips & Tricks
Model Reference
Assumptions
Component models
Constraints
Limitations
Input parameters
Outputs of a simulation
Validation methodology
E-LAND requirements of the MVS
References
Code documentation
Release Notes
License
Contributing to MVS
Publications and Bibliography
Cite MVS
Troubleshooting
Bug report
Multi-Vector Simulator (MVS)
Docs
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
V
|
W
A
add_a_transformer_for_each_peak_demand_pricing_period() (in module multi_vector_simulator.C0_data_processing)
add_asset_to_asset_dict_for_each_flow_direction() (in module multi_vector_simulator.C0_data_processing)
add_asset_to_asset_dict_of_bus() (in module multi_vector_simulator.C0_data_processing)
add_assets_to_asset_dict_of_connected_busses() (in module multi_vector_simulator.C0_data_processing)
add_bus() (multi_vector_simulator.F1_plotting.ESGraphRenderer method)
add_component() (multi_vector_simulator.F1_plotting.ESGraphRenderer method)
add_constraints() (in module multi_vector_simulator.D2_model_constraints)
add_degree_of_autonomy() (in module multi_vector_simulator.E3_indicator_calculation)
add_degree_of_net_zero_energy() (in module multi_vector_simulator.E3_indicator_calculation)
add_degree_of_sector_coupling() (in module multi_vector_simulator.E3_indicator_calculation)
add_economic_parameters() (in module multi_vector_simulator.C0_data_processing)
add_info_flows() (in module multi_vector_simulator.E1_process_results)
add_levelized_cost_of_energy_carriers() (in module multi_vector_simulator.E3_indicator_calculation)
add_onsite_energy_fraction() (in module multi_vector_simulator.E3_indicator_calculation)
add_onsite_energy_matching() (in module multi_vector_simulator.E3_indicator_calculation)
add_renewable_factor() (in module multi_vector_simulator.E3_indicator_calculation)
add_renewable_share_of_local_generation() (in module multi_vector_simulator.E3_indicator_calculation)
add_sink() (multi_vector_simulator.F1_plotting.ESGraphRenderer method)
add_source() (multi_vector_simulator.F1_plotting.ESGraphRenderer method)
add_specific_emissions_per_electricity_equivalent() (in module multi_vector_simulator.E3_indicator_calculation)
add_storage() (multi_vector_simulator.F1_plotting.ESGraphRenderer method)
add_storage_components() (in module multi_vector_simulator.A1_csv_to_json)
add_total_consumption_from_provider_electricity_equivalent() (in module multi_vector_simulator.E3_indicator_calculation)
add_total_emissions() (in module multi_vector_simulator.E3_indicator_calculation)
add_total_feedin_electricity_equivalent() (in module multi_vector_simulator.E3_indicator_calculation)
add_total_renewable_and_non_renewable_energy_origin() (in module multi_vector_simulator.E3_indicator_calculation)
add_transformer() (multi_vector_simulator.F1_plotting.ESGraphRenderer method)
add_version_number_used() (in module multi_vector_simulator.C0_data_processing)
adding_assets_to_energysystem_model() (multi_vector_simulator.D0_modelling_and_optimization.model_building method)
all() (in module multi_vector_simulator.C0_data_processing)
all_list_in_dict() (in module multi_vector_simulator.E2_economics)
all_totals() (in module multi_vector_simulator.E3_indicator_calculation)
all_valid_intervals() (in module multi_vector_simulator.C1_verification)
annuity() (in module multi_vector_simulator.C2_economic_functions)
annuity_factor() (in module multi_vector_simulator.C2_economic_functions)
apply_function_to_single_or_list() (in module multi_vector_simulator.C0_data_processing)
B
bus() (in module multi_vector_simulator.D1_model_components)
C
calculate_costs_replacement() (in module multi_vector_simulator.E2_economics)
calculate_costs_upfront_investment() (in module multi_vector_simulator.E2_economics)
calculate_dispatch_expenditures() (in module multi_vector_simulator.E2_economics)
calculate_electricity_equivalent_for_a_set_of_aggregated_values() (in module multi_vector_simulator.E3_indicator_calculation)
calculate_emissions_from_flow() (in module multi_vector_simulator.E3_indicator_calculation)
calculate_operation_and_management_expenditures() (in module multi_vector_simulator.E2_economics)
calculate_total_asset_costs_over_lifetime() (in module multi_vector_simulator.E2_economics)
calculate_total_capital_costs() (in module multi_vector_simulator.E2_economics)
calculate_total_operational_expenditures() (in module multi_vector_simulator.E2_economics)
capex_from_investment() (in module multi_vector_simulator.C2_economic_functions)
change_sign_of_feedin_tariff() (in module multi_vector_simulator.C0_data_processing)
check_efficiency_of_storage_capacity() (in module multi_vector_simulator.C1_verification)
check_emission_factor_of_providers() (in module multi_vector_simulator.C1_verification)
check_energy_system_can_fulfill_max_demand() (in module multi_vector_simulator.C1_verification)
check_feasibility_of_maximum_emissions_constraint() (in module multi_vector_simulator.C1_verification)
check_feedin_tariff_vs_energy_price() (in module multi_vector_simulator.C1_verification)
check_feedin_tariff_vs_levelized_cost_of_generation_of_production() (in module multi_vector_simulator.C1_verification)
check_for_label_duplicates() (in module multi_vector_simulator.C1_verification)
check_for_sufficient_assets_on_busses() (in module multi_vector_simulator.C1_verification)
check_if_energy_vector_is_defined_in_DEFAULT_WEIGHTS_ENERGY_CARRIERS() (in module multi_vector_simulator.C1_verification)
check_if_energy_vector_of_all_assets_is_valid() (in module multi_vector_simulator.C1_verification)
check_input_folder() (in module multi_vector_simulator.A0_initialization)
check_input_values() (in module multi_vector_simulator.C1_verification)
check_non_dispatchable_source_time_series() (in module multi_vector_simulator.C1_verification)
check_optimize_cap() (in module multi_vector_simulator.D1_model_components)
check_output_folder() (in module multi_vector_simulator.A0_initialization)
check_storage_file_is_csv() (in module multi_vector_simulator.A1_csv_to_json)
check_time_series_values_between_0_and_1() (in module multi_vector_simulator.C1_verification)
chp() (in module multi_vector_simulator.D1_model_components)
chp_fix() (in module multi_vector_simulator.D1_model_components)
chp_optimize() (in module multi_vector_simulator.D1_model_components)
compute_timeseries_properties() (in module multi_vector_simulator.C0_data_processing)
connect() (multi_vector_simulator.F1_plotting.ESGraphRenderer method)
constraint_maximum_emissions() (in module multi_vector_simulator.D2_model_constraints)
constraint_minimal_degree_of_autonomy() (in module multi_vector_simulator.D2_model_constraints)
constraint_minimal_renewable_share() (in module multi_vector_simulator.D2_model_constraints)
constraint_net_zero_energy() (in module multi_vector_simulator.D2_model_constraints)
conversion() (in module multi_vector_simulator.A1_csv_to_json)
convert_components_to_dataframe() (in module multi_vector_simulator.E1_process_results)
convert_cost_matrix_to_dataframe() (in module multi_vector_simulator.E1_process_results)
convert_costs_to_dataframe() (in module multi_vector_simulator.E1_process_results)
convert_demand_to_dataframe() (in module multi_vector_simulator.E1_process_results)
convert_epa_params_to_mvs() (in module multi_vector_simulator.utils.data_parser)
convert_from_json_to_special_types() (in module multi_vector_simulator.B0_data_input_json)
convert_from_special_types_to_json() (in module multi_vector_simulator.B0_data_input_json)
convert_kpi_sector_to_dataframe() (in module multi_vector_simulator.E1_process_results)
convert_mvs_params_to_epa() (in module multi_vector_simulator.utils.data_parser)
convert_plot_data_to_dataframe() (in module multi_vector_simulator.F1_plotting)
convert_scalar_matrix_to_dataframe() (in module multi_vector_simulator.E1_process_results)
convert_scalars_to_dataframe() (in module multi_vector_simulator.E1_process_results)
create_app() (in module multi_vector_simulator.F2_autoreport)
create_demands_section() (in module multi_vector_simulator.F2_autoreport)
create_input_json() (in module multi_vector_simulator.A1_csv_to_json)
create_json_from_csv() (in module multi_vector_simulator.A1_csv_to_json)
create_plotly_barplot_fig() (in module multi_vector_simulator.F1_plotting)
create_plotly_flow_fig() (in module multi_vector_simulator.F1_plotting)
create_plotly_line_fig() (in module multi_vector_simulator.F1_plotting)
create_plotly_piechart_fig() (in module multi_vector_simulator.F1_plotting)
crf() (in module multi_vector_simulator.C2_economic_functions)
CustomBus (class in multi_vector_simulator.D1_model_components)
cut_below_micro() (in module multi_vector_simulator.E1_process_results)
D
define_auxiliary_assets_of_energy_providers() (in module multi_vector_simulator.C0_data_processing)
define_availability_of_peak_demand_pricing_assets() (in module multi_vector_simulator.C0_data_processing)
define_energy_vectors_from_busses() (in module multi_vector_simulator.C0_data_processing)
define_excess_sinks() (in module multi_vector_simulator.C0_data_processing)
define_missing_cost_data() (in module multi_vector_simulator.C0_data_processing)
define_sink() (in module multi_vector_simulator.C0_data_processing)
define_source() (in module multi_vector_simulator.C0_data_processing)
define_transformer_for_peak_demand_pricing() (in module multi_vector_simulator.C0_data_processing)
detect_excessive_excess_generation_in_bus() (in module multi_vector_simulator.E4_verification)
determine_dispatch_price() (in module multi_vector_simulator.C0_data_processing)
determine_lifetime_price_dispatch() (in module multi_vector_simulator.C2_economic_functions)
determine_months_in_a_peak_demand_pricing_period() (in module multi_vector_simulator.C0_data_processing)
E
encode_image_file() (in module multi_vector_simulator.F2_autoreport)
energyConsumption() (in module multi_vector_simulator.C0_data_processing)
energyConversion() (in module multi_vector_simulator.C0_data_processing)
energyProduction() (in module multi_vector_simulator.C0_data_processing)
energyProviders() (in module multi_vector_simulator.C0_data_processing)
energyStorage() (in module multi_vector_simulator.C0_data_processing)
equation_degree_of_autonomy() (in module multi_vector_simulator.E3_indicator_calculation)
equation_degree_of_net_zero_energy() (in module multi_vector_simulator.E3_indicator_calculation)
equation_degree_of_sector_coupling() (in module multi_vector_simulator.E3_indicator_calculation)
equation_levelized_cost_of_energy_carrier() (in module multi_vector_simulator.E3_indicator_calculation)
equation_onsite_energy_fraction() (in module multi_vector_simulator.E3_indicator_calculation)
equation_onsite_energy_matching() (in module multi_vector_simulator.E3_indicator_calculation)
equation_renewable_share() (in module multi_vector_simulator.E3_indicator_calculation)
ESGraphRenderer (class in multi_vector_simulator.F1_plotting)
evaluate_dict() (in module multi_vector_simulator.E0_evaluation)
(in module multi_vector_simulator.F0_output)
evaluate_lifetime_costs() (in module multi_vector_simulator.C0_data_processing)
extract_plot_data_and_title() (in module multi_vector_simulator.F1_plotting)
F
find_value_by_key() (in module multi_vector_simulator.utils.helpers)
fixed_width_text() (in module multi_vector_simulator.F1_plotting)
G
get_color() (in module multi_vector_simulator.F1_plotting)
get_costs() (in module multi_vector_simulator.E2_economics)
get_fig_style_dict() (in module multi_vector_simulator.F1_plotting)
get_flow() (in module multi_vector_simulator.E1_process_results)
get_item_if_list() (in module multi_vector_simulator.utils.helpers)
get_length_if_list() (in module multi_vector_simulator.utils.helpers)
get_lifetime_price_dispatch_list() (in module multi_vector_simulator.C2_economic_functions)
get_lifetime_price_dispatch_one_value() (in module multi_vector_simulator.C2_economic_functions)
get_lifetime_price_dispatch_timeseries() (in module multi_vector_simulator.C2_economic_functions)
get_optimal_cap() (in module multi_vector_simulator.E1_process_results)
get_parameter_to_be_evaluated_from_oemof_results() (in module multi_vector_simulator.E1_process_results)
get_replacement_costs() (in module multi_vector_simulator.C2_economic_functions)
get_results() (in module multi_vector_simulator.E1_process_results)
get_state_of_charge_info() (in module multi_vector_simulator.E1_process_results)
get_storage_results() (in module multi_vector_simulator.E1_process_results)
get_timeseries_multiple_flows() (in module multi_vector_simulator.C0_data_processing)
get_timeseries_per_bus() (in module multi_vector_simulator.E1_process_results)
get_tuple_for_oemof_results() (in module multi_vector_simulator.E1_process_results)
get_units_of_cost_matrix_entries() (in module multi_vector_simulator.E1_process_results)
I
initalize() (multi_vector_simulator.D0_modelling_and_optimization.timer method)
initalize_kpi() (in module multi_vector_simulator.E0_evaluation)
initialize() (multi_vector_simulator.D0_modelling_and_optimization.model_building method)
insert_body_text() (in module multi_vector_simulator.F2_autoreport)
insert_headings() (in module multi_vector_simulator.F2_autoreport)
insert_log_messages() (in module multi_vector_simulator.F2_autoreport)
insert_plotly_figure() (in module multi_vector_simulator.F2_autoreport)
insert_subsection() (in module multi_vector_simulator.F2_autoreport)
L
lcoe_assets() (in module multi_vector_simulator.E2_economics)
load_json() (in module multi_vector_simulator.B0_data_input_json)
lookup_file() (in module multi_vector_simulator.C1_verification)
M
make_dash_data_table() (in module multi_vector_simulator.F2_autoreport)
maximum_emissions_test() (in module multi_vector_simulator.E4_verification)
minimal_constraint_test() (in module multi_vector_simulator.E4_verification)
MissingParametersForEconomicEvaluation
model_building (class in multi_vector_simulator.D0_modelling_and_optimization)
module
multi_vector_simulator.A0_initialization
multi_vector_simulator.A1_csv_to_json
multi_vector_simulator.B0_data_input_json
multi_vector_simulator.C0_data_processing
multi_vector_simulator.C1_verification
multi_vector_simulator.C2_economic_functions
multi_vector_simulator.D0_modelling_and_optimization
multi_vector_simulator.D1_model_components
multi_vector_simulator.D2_model_constraints
multi_vector_simulator.E0_evaluation
multi_vector_simulator.E1_process_results
multi_vector_simulator.E2_economics
multi_vector_simulator.E3_indicator_calculation
multi_vector_simulator.E4_verification
multi_vector_simulator.F0_output
multi_vector_simulator.F1_plotting
multi_vector_simulator.F2_autoreport
multi_vector_simulator.utils.data_parser
multi_vector_simulator.utils.helpers
multi_vector_simulator.A0_initialization
module
multi_vector_simulator.A1_csv_to_json
module
multi_vector_simulator.B0_data_input_json
module
multi_vector_simulator.C0_data_processing
module
multi_vector_simulator.C1_verification
module
multi_vector_simulator.C2_economic_functions
module
multi_vector_simulator.D0_modelling_and_optimization
module
multi_vector_simulator.D1_model_components
module
multi_vector_simulator.D2_model_constraints
module
multi_vector_simulator.E0_evaluation
module
multi_vector_simulator.E1_process_results
module
multi_vector_simulator.E2_economics
module
multi_vector_simulator.E3_indicator_calculation
module
multi_vector_simulator.E4_verification
module
multi_vector_simulator.F0_output
module
multi_vector_simulator.F1_plotting
module
multi_vector_simulator.F2_autoreport
module
multi_vector_simulator.utils.data_parser
module
multi_vector_simulator.utils.helpers
module
mvs_arg_parser() (in module multi_vector_simulator.A0_initialization)
N
net_zero_energy_constraint_test() (in module multi_vector_simulator.E4_verification)
O
open_in_browser() (in module multi_vector_simulator.F2_autoreport)
P
parse_simulation_log() (in module multi_vector_simulator.F0_output)
peak_demand_bus_name() (in module multi_vector_simulator.utils.helpers)
peak_demand_transformer_name() (in module multi_vector_simulator.utils.helpers)
plot_instant_power() (in module multi_vector_simulator.F1_plotting)
plot_networkx_graph() (multi_vector_simulator.D0_modelling_and_optimization.model_building method)
plot_optimized_capacities() (in module multi_vector_simulator.F1_plotting)
plot_piecharts_of_costs() (in module multi_vector_simulator.F1_plotting)
plot_sankey() (in module multi_vector_simulator.F1_plotting)
plot_sankey_diagramm() (multi_vector_simulator.D0_modelling_and_optimization.model_building method)
plot_timeseries() (in module multi_vector_simulator.F1_plotting)
prepare_constraint_minimal_renewable_share() (in module multi_vector_simulator.D2_model_constraints)
prepare_demand_assets() (in module multi_vector_simulator.D2_model_constraints)
prepare_energy_provider_consumption_sources() (in module multi_vector_simulator.D2_model_constraints)
prepare_energy_provider_feedin_sinks() (in module multi_vector_simulator.D2_model_constraints)
present_value_from_annuity() (in module multi_vector_simulator.C2_economic_functions)
print_pdf() (in module multi_vector_simulator.F2_autoreport)
process_all_assets() (in module multi_vector_simulator.C0_data_processing)
process_fixcost() (in module multi_vector_simulator.E0_evaluation)
process_maximum_cap_constraint() (in module multi_vector_simulator.C0_data_processing)
process_normalized_installed_cap() (in module multi_vector_simulator.C0_data_processing)
process_user_arguments() (in module multi_vector_simulator.A0_initialization)
R
ready_capacities_plots() (in module multi_vector_simulator.F2_autoreport)
ready_costs_pie_plots() (in module multi_vector_simulator.F2_autoreport)
ready_flows_plots() (in module multi_vector_simulator.F2_autoreport)
ready_sankey_diagram() (in module multi_vector_simulator.F2_autoreport)
ready_timeseries_plots() (in module multi_vector_simulator.F2_autoreport)
receive_timeseries_from_csv() (in module multi_vector_simulator.C0_data_processing)
render() (multi_vector_simulator.F1_plotting.ESGraphRenderer method)
replace_nans_in_timeseries_with_0() (in module multi_vector_simulator.C0_data_processing)
report_arg_parser() (in module multi_vector_simulator.A0_initialization)
retrieve_date_time_info() (in module multi_vector_simulator.B0_data_input_json)
run_oemof() (in module multi_vector_simulator.D0_modelling_and_optimization)
S
sankey() (multi_vector_simulator.F1_plotting.ESGraphRenderer method)
save_plots_to_disk() (in module multi_vector_simulator.F1_plotting)
simulating() (multi_vector_simulator.D0_modelling_and_optimization.model_building method)
simulation_annuity() (in module multi_vector_simulator.C2_economic_functions)
sink() (in module multi_vector_simulator.D1_model_components)
sink_dispatchable_optimize() (in module multi_vector_simulator.D1_model_components)
sink_non_dispatchable() (in module multi_vector_simulator.D1_model_components)
source() (in module multi_vector_simulator.D1_model_components)
source_dispatchable_fix() (in module multi_vector_simulator.D1_model_components)
source_dispatchable_optimize() (in module multi_vector_simulator.D1_model_components)
source_non_dispatchable_fix() (in module multi_vector_simulator.D1_model_components)
source_non_dispatchable_optimize() (in module multi_vector_simulator.D1_model_components)
stop() (multi_vector_simulator.D0_modelling_and_optimization.timer method)
storage() (in module multi_vector_simulator.D1_model_components)
storage_fix() (in module multi_vector_simulator.D1_model_components)
storage_optimize() (in module multi_vector_simulator.D1_model_components)
store_as_json() (in module multi_vector_simulator.F0_output)
store_lp_file() (multi_vector_simulator.D0_modelling_and_optimization.model_building method)
store_result_matrix() (in module multi_vector_simulator.E0_evaluation)
store_scalars_to_excel() (in module multi_vector_simulator.F0_output)
store_timeseries_all_busses_to_excel() (in module multi_vector_simulator.F0_output)
T
timer (class in multi_vector_simulator.D0_modelling_and_optimization)
total_demand_and_excess_each_sector() (in module multi_vector_simulator.E3_indicator_calculation)
transformer() (in module multi_vector_simulator.D1_model_components)
transformer_constant_efficiency_fix() (in module multi_vector_simulator.D1_model_components)
transformer_constant_efficiency_optimize() (in module multi_vector_simulator.D1_model_components)
translate_optimizeCap_from_boolean_to_yes_no() (in module multi_vector_simulator.E1_process_results)
translates_epa_strings_to_mvs_readable() (in module multi_vector_simulator.utils.helpers)
treat_multiple_flows() (in module multi_vector_simulator.C0_data_processing)
V
verify_state_of_charge() (in module multi_vector_simulator.E4_verification)
view() (multi_vector_simulator.F1_plotting.ESGraphRenderer method)
W
weighting_for_sector_coupled_kpi() (in module multi_vector_simulator.E3_indicator_calculation)
Read the Docs
v: latest
Versions
latest
stable
v1.0.0
v0.5.5
Downloads
pdf
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.