Skip to content

Commit

Permalink
Fix simulation args format
Browse files Browse the repository at this point in the history
  • Loading branch information
kdayday committed Sep 23, 2024
1 parent a3f1f3d commit c3e3da0
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions src/simulation/simulation.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@
initial_time::Union{Nothing, Dates.DateTime}
)
Construct the Simulation structure to run the sequence of decision and emulation models specified.
Construct the `Simulation` structure to run the sequence of decision and emulation models specified.
# Arguments
-`sequence::SimulationSequence`: Simulation sequence that specify how the decision and emulation models will be executed.
-`name::String`: Name of the Simulation
-`steps::Int`: Number of steps on which the sequence of models will be executed
-`models::SimulationModels`: List of Decision and Emulation Models
-`simulation_folder::String`: Folder on which results will be stored
-`initial_time::Union{Nothing, Dates.DateTime} = nothing`: Initial time of which the simulation starts. If nothing it will default to the first timestamp
of time series of the system.
- `sequence::SimulationSequence`: Simulation sequence that specify how the decision and emulation models will be executed.
- `name::String`: Name of the Simulation
- `steps::Int`: Number of steps on which the sequence of models will be executed
- `models::SimulationModels`: List of Decision and Emulation Models
- `simulation_folder::String`: Folder on which results will be stored
- `initial_time::Union{Nothing, Dates.DateTime} = nothing`: Initial time of which the
simulation starts. If nothing it will default to the first timestamp of time series of the system.
# Example
Expand Down

0 comments on commit c3e3da0

Please sign in to comment.