Skip to content

Commit

Permalink
Add docstring for read_clustering_data_from_csv_folder
Browse files Browse the repository at this point in the history
  • Loading branch information
greg-neustroev committed Nov 28, 2023
1 parent 0359083 commit f3dba08
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions src/io.jl
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
export read_clustering_data_from_csv_folder

"""
read_clustering_data_from_csv_folder(input_folder)
Returns the [`TulipaClustering.ClusteringData`](@ref) reading all data from CSV files
in the `input_folder`.
The following files are expected to exist in the input folder:
- `demand.csv`: Following the [`TulipaEnergyModel.DemandData`](@ref) specification.
- `generation-availability.csv`: Following the [`TulipaEnergyModel.GenerationAvailabilityData`](@ref) specification.
The output contains:
- `demand`: a DataFrame of demand values at different nodes per time step
- `generation_availability`: a DataFrame of availability coefficients for different generation technologies located at different nodes per time step
"""
function read_clustering_data_from_csv_folder(input_folder::AbstractString)
# Read data
fillpath(filename) = joinpath(input_folder, filename)
Expand Down

0 comments on commit f3dba08

Please sign in to comment.