Update Dependency on TSC

YoungFaithful · Aug 29, 2019 · 981fdad · 981fdad
1 parent 061ef67
commit 981fdad
Show file tree

Hide file tree

Showing 12 changed files with 19 additions and 19 deletions.
diff --git a/Project.toml b/Project.toml
@@ -4,11 +4,11 @@ keywords = ["energy", "capacity", "JuMP", "optimization"]
 license = "MIT"
 desc = "Capacity Expansion Problem Formulation for Julia"
 author = ["Elias Kuepper <[email protected]>"]
-version = "0.1.5"
+version = "0.1.6"
 
 [deps]
 CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
-ClustForOpt = "f34a0dec-cdff-52ca-a698-8a683c311173"
+TimeSeriesClustering = "61e8395a-c5b7-11e9-0bf6-872d3bc7175c"
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"
 JLD2 = "033835bb-8acc-5ee8-8aae-3f567f8a3819"
@@ -19,4 +19,4 @@ StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
 [compat]
 julia = "^1.0"
 JuMP = "^0.19"
-ClustForOpt = "^0.4.0"
+TimeSeriesClustering = "^0.5"
diff --git a/README.md b/README.md
@@ -24,7 +24,7 @@
 |Network coverage | transmission, DCOPF load flow |
 
 
-The package uses [ClustForOpt](https://github.com/holgerteichgraeber/ClustForOpt.jl) as a basis for it's time-series aggregation.
+The package uses [TimeSeriesClustering](https://github.com/holgerteichgraeber/TimeSeriesClustering.jl) as a basis for it's time-series aggregation.
 
 This package is developed by Elias Kuepper [@YoungFaithful](https://github.com/youngfaithful) and Holger Teichgraeber [@holgerteichgraeber](https://github.com/holgerteichgraeber).
 
@@ -37,7 +37,7 @@ It depends on:
 - `StatsBase.jl` - for handling of basic 
 - `JLD2` - for saving your result data
 - `FileIO` - for file accessing
-- `ClustForOpt.jl` - for time-series data
+- `TimeSeriesClustering.jl` - for time-series data
 
 ```julia
 using Pkg

diff --git a/docs/src/assets/workflow.svg b/docs/src/assets/workflow.svg
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -2,7 +2,7 @@
 ===
 [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://YoungFaithful.github.io/CapacityExpansion.jl/stable)
 [![](https://img.shields.io/badge/docs-dev-blue.svg)](https://YoungFaithful.github.io/CapacityExpansion.jl/dev)
-[![Build Status](https://travis-ci.com/holgerteichgraeber/ClustForOpt.jl.svg?token=HRFemjSxM1NBCsbHGNDG&branch=master)](https://travis-ci.com/YoungFaithful/CapacityExpansion.jl)
+[![Build Status](https://travis-ci.com/holgerteichgraeber/TimeSeriesClustering.jl.svg?token=HRFemjSxM1NBCsbHGNDG&branch=master)](https://travis-ci.com/YoungFaithful/CapacityExpansion.jl)
 
 [CapacityExpansion](https://github.com/YoungFaithful/CapacityExpansion.jl) is a [julia](https://www.juliaopt.com) implementation of a input-data-scaling capacity expansion modeling framework.
 
@@ -24,7 +24,7 @@
 |Network coverage | transmission, DCOPF load flow |
 
 
-The package uses [ClustForOpt](https://github.com/holgerteichgraeber/ClustForOpt.jl) as a basis for it's time-series aggregation.
+The package uses [TimeSeriesClustering](https://github.com/holgerteichgraeber/TimeSeriesClustering.jl) as a basis for it's time-series aggregation.
 
 This package is developed by Elias Kuepper [@YoungFaithful](https://github.com/youngfaithful) and Holger Teichgraeber [@holgerteichgraeber](https://github.com/holgerteichgraeber).
 
@@ -37,7 +37,7 @@ It depends on:
 - `StatsBase.jl` - for handling of basic 
 - `JLD2` - for saving your result data
 - `FileIO` - for file accessing
-- `ClustForOpt.jl` - for time-series data
+- `TimeSeriesClustering.jl` - for time-series data
 
 ```julia
 using Pkg

diff --git a/docs/src/opt_cep.md b/docs/src/opt_cep.md
@@ -127,7 +127,7 @@ state="GER_1"
 years=[2016]
 ts_input_data = load_timeseries_data_provided(state;T=24, years=years)
 cep_data = load_cep_data_provided(state)
-ts_clust_data = run_clust(ts_input_data;method="kmeans",representation="centroid",n_init=10,n_clust=5).best_results
+ts_clust_data = run_clust(ts_input_data;method="kmeans",representation="centroid",n_init=10,n_clust=5).clust_data
 ```
 ```@example 3
 result = run_opt(ts_clust_data,cep_data,optimizer;descriptor="Model Name")

diff --git a/docs/src/opt_cep_examples.md b/docs/src/opt_cep_examples.md
@@ -7,7 +7,7 @@ optimizer=Clp.Optimizer #select an Optimize
 state="GER_1" #select state
 ts_input_data = load_timeseries_data_provided(state; K=365, T=24)
 cep_data = load_cep_data_provided(state)
-ts_clust_data = run_clust(ts_input_data;method="kmeans",representation="centroid",n_init=5,n_clust=5).best_results
+ts_clust_data = run_clust(ts_input_data;method="kmeans",representation="centroid",n_init=5,n_clust=5).clust_data
 # tweak the CO2 level
 co2_result = run_opt(ts_clust_data,cep_data,optimizer;descriptor="co2",co2_limit=500)
 ```

diff --git a/docs/src/preparing_clust_data.md b/docs/src/preparing_clust_data.md
@@ -7,7 +7,7 @@ The optional input parameters to `load_timeseries_data_provided()` are the numbe
 load_timeseries_data_provided
 ```
 ## Your Own Data
-For details refer to [ClustForOpt](https://github.com/holgerteichgraeber/ClustForOpt.jl)
+For details refer to [TimeSeriesClustering](https://github.com/holgerteichgraeber/TimeSeriesClustering.jl)
 
 !!! note
  The keys of `{your-time-series}.data` have to match `"{time_series (as declared in techs.csv)}-{node}"`
@@ -17,7 +17,7 @@ load_timeseries_data
 ```
 ## Aggregation
 Time series aggregation can be applied to reduce the temporal dimension while (if done problem specific correctly) keeping output precise.
-Aggregation methods are explained in [ClustForOpt](https://github.com/holgerteichgraeber/ClustForOpt.jl)
+Aggregation methods are explained in [TimeSeriesClustering](https://github.com/holgerteichgraeber/TimeSeriesClustering.jl)
 High encouragement to run a second stage validation step if you use aggregation on your model. [Second stage operational validation step](@ref)
 
 ## Examples
@@ -33,7 +33,7 @@ plot(ts_input_data.data["solar-germany"], legend=false, linestyle=:dot, xlabel="
 ![Plot](assets/preparing_clust_data_load.svg)
 ### Aggregating time series data
 ```julia
-ts_clust_data = run_clust(ts_input_data;method="kmeans",representation="centroid",n_init=50,n_clust=5).best_results
+ts_clust_data = run_clust(ts_input_data;method="kmeans",representation="centroid",n_init=50,n_clust=5).clust_data
 plot(ts_clust_data.data["solar-germany"], legend=false, linestyle=:solid, width=3, xlabel="Time [h]", ylabel="Solar availability factor [%]")
 ```
 ![Plot](assets/preparing_clust_data_agg.svg)
diff --git a/examples/workflow_example_cep.jl b/examples/workflow_example_cep.jl
@@ -57,4 +57,4 @@ operation_result = run_opt(ts_input_data,cep_data,design_result.opt_config,desig
 # 0.01 ≤ VAR ≤ 100, real-VAR = scale[:VAR] ⋅ VAR
 # ⇔ 0.01 ≤ real-VAR / scale[:VAR] ≤ 100
 scale=Dict{Symbol,Int}(:COST => 1e9, :CAP => 1e3, :GEN => 1e3, :SLACK => 1e3, :INTRASTOR => 1e3, :INTERSTOR => 1e6, :FLOW => 1e3, :TRANS =>1e3, :LL => 1e6, :LE => 1e9)
-co2_result = run_opt(ts_clust_data.best_results,cep_data,optimizer;scale=scale, co2_limit=50)
+co2_result = run_opt(ts_clust_data.clust_data,cep_data,optimizer;scale=scale, co2_limit=50)
diff --git a/examples/workflow_introduction.jl b/examples/workflow_introduction.jl
@@ -34,7 +34,7 @@ plot_input_solar=plot(ts_input_data.data["solar-germany"], legend=false, linesty
 
 # How to load your own data:
 # put your data into your homedirectory into a folder called tutorial
-# The data should have the following structure: see ClustForOpt/data folder
+# The data should have the following structure: see TimeSeriesClustering/data folder
 #=
 - Loading all `*.csv` files in the folder or the file `data_path`
 The `*.csv` files shall have the following structure and must have the same length:

diff --git a/src/CapacityExpansion.jl b/src/CapacityExpansion.jl
@@ -10,7 +10,7 @@ module CapacityExpansion
  using CSV
  using DataFrames
  @reexport using StatsBase
- @reexport using ClustForOpt
+ @reexport using TimeSeriesClustering
  @reexport using JLD2
  @reexport using FileIO
  using JuMP

diff --git a/src/CapacityExpansion_development.jl b/src/CapacityExpansion_development.jl
@@ -5,8 +5,8 @@
  # Capacity Expansion Probelem formulation
  #
  #####################
-#using ClustForOpt
-include(joinpath("..","..","ClustForOpt","src","ClustForOpt_development.jl"))
+#using TimeSeriesClustering
+include(joinpath("..","..","TimeSeriesClustering","src","TimeSeriesClustering_development.jl"))
 using CSV
 using DataFrames
 using StatsBase

diff --git a/test/cep_exact_data.jld2 b/test/cep_exact_data.jld2