API
Model
EnergySystemModeling.EnergySystemModel
— TypeDefine energy system model type as JuMP.Model.
EnergySystemModeling.Specs
— TypeSpecifation for which constraints to include to the model. Constraints that are not specified are included by default.
Arguments
renewable_target::Bool
: Whether to include renewables target constraint.storage::Bool
: Whether to include storage constraints.ramping::Bool
: Whether to include ramping constraints.voltage_angles::Bool
: Whether to include voltage angle constraints.
EnergySystemModeling.Params
— TypeInput indices and parameters for the model.
Missing docstring for Variables
. Check Documenter's build log for details.
Missing docstring for Objectives
. Check Documenter's build log for details.
Missing docstring for Variables(::EnergySystemModel)
. Check Documenter's build log for details.
Missing docstring for Objectives(::EnergySystemModel)
. Check Documenter's build log for details.
EnergySystemModeling.EnergySystemModel
— MethodCreates the energy system model.
Arguments
parameters::Params
specs::Specs
IO
JSON stores multi-dimensional arrays as nested arrays. If we load an array a
whose elements are accessed a[i, j, k]
, the elements of the nested array are accessed in reverse order a[k][j][i]
. However, the function load_json
converts the nested arrays back to multi-dimensional arrays.
We use simple plain text formats CSV and JSON for input and output of numerical values.
EnergySystemModeling.equivalent_annual_cost
— FunctionEquivalent annual cost (EAC)
Arguments
cost::Real
: Net present value of a project.n::Integer
: Number of payments.r::Real
: Interest rate.
Missing docstring for Params(::AbstractString)
. Check Documenter's build log for details.
EnergySystemModeling.save_json
— FunctionSave object into JSON file.
Arguments
object
output_path::AbstractString
: Full filepath, e.g.,path.json
.
EnergySystemModeling.load_json
— FunctionLoad values to type from JSON file.
Arguments
type
filepath::AbstractString
Plotting
EnergySystemModeling.plot_objective_values
— FunctionPlot objective value and individual objective values.
EnergySystemModeling.plot_generation_dispatch
— FunctionPlot generation dispatch.
EnergySystemModeling.plot_generation_capacities
— FunctionPlot generation capacities.
EnergySystemModeling.plot_transmission_flow
— FunctionPlot transmission flow.
EnergySystemModeling.plot_transmission_capacities
— FunctionPlot transmission capacities.
EnergySystemModeling.plot_storage_level
— FunctionPlot storage level.
EnergySystemModeling.plot_storage_capacities
— FunctionPlot storage capacities.
EnergySystemModeling.plot_loss_of_load
— FunctionPlot loss of load.