From a56e62f7ac29dd4bb7324b8f8bb285b62e9790ff Mon Sep 17 00:00:00 2001 From: holgerteichgraeber Date: Wed, 24 Apr 2019 20:37:41 -0700 Subject: [PATCH] Update README to support registered version installation --- Project.toml | 3 +-- README.md | 8 ++++---- docs/src/clust.md | 2 +- 3 files changed, 6 insertions(+), 7 deletions(-) diff --git a/Project.toml b/Project.toml index 09b499c..4aae131 100644 --- a/Project.toml +++ b/Project.toml @@ -4,7 +4,7 @@ keywords = ["clustering", "JuMP", "optimization"] license = "MIT" desc = "julia implementation of using different clustering methods for finding representative periods for the optimization of energy systems" author = ["Holger Teichgraeber"] -version = "0.3.1" +version = "0.3.2" [deps] CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b" @@ -20,4 +20,3 @@ StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91" [compat] julia = "^1.0" - diff --git a/README.md b/README.md index 1f93e28..146f092 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![ClustForOpt](docs/src/assets/clust_for_opt_text.svg) +![ClustForOpt](docs/src/assets/clust_for_opt_text.svg) === [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://holgerteichgraeber.github.io/ClustForOpt.jl/stable) [![](https://img.shields.io/badge/docs-dev-blue.svg)](https://holgerteichgraeber.github.io/ClustForOpt.jl/dev) @@ -7,7 +7,7 @@ ClustForOpt is a [julia](www.juliaopt.com) implementation of clustering methods for finding representative periods for the optimization of energy systems. The package furthermore provides a multi-node capacity expansion model. -The package has three main purposes: 1) Provide a simple process of clustering time-series input data, with clustered data output in a generalized type system 2) provide an interface between clustered data and optimization problem 3) provide a generalizable capacity expansion problem formulation and data to test clustering on this problem. +The package has two main purposes: 1) Provide a simple process of clustering time-series input data, with clustered data output in a generalized type system 2) provide an interface between clustered data and optimization problem. The package follows the clustering framework presented in [Teichgraeber and Brandt, 2019](https://doi.org/10.1016/j.apenergy.2019.02.012). The package is actively developed, and new features are continuously added. For a reproducible version of the methods and data of the original paper by [Teichgraeber and Brandt, 2019](https://doi.org/10.1016/j.apenergy.2019.02.012), please refer to release [v0.1](https://github.com/holgerteichgraeber/ClustForOpt.jl/tree/v0.1). @@ -34,7 +34,7 @@ Install using: ```julia ] -add https://github.com/holgerteichgraeber/ClustForOpt.jl.git +add ClustForOpt ``` where `]` opens the julia package manager. @@ -102,4 +102,4 @@ For use of DTW barycenter averaging (DBA) and k-shape clustering on single-attri ### Optimization The function `run_opt()` runs the optimization problem and gives as an output a struct that contains optimal objective function value, decision variables, and additional info. The `run_opt()` function infers the optimization problem type from the input data. See the examples folder for further details. -More detailed documentation on the Capacity Expansion Problem can be found in the documentation. +A Capacity Expansion Optimization Problem that utilizes `ClustForOpt` can be found in the package [CEP](https://github.com/YoungFaithful/CEP.jl). diff --git a/docs/src/clust.md b/docs/src/clust.md index d4d4d49..e908c6b 100644 --- a/docs/src/clust.md +++ b/docs/src/clust.md @@ -36,7 +36,7 @@ ClustResultSimple ## Example running clustering ```@example using ClustForOpt -# laod ts-input-data +# load ts-input-data ts_input_data = load_timeseries_data(normpath(joinpath(@__DIR__,"..","..","data","TS_GER_1")); T=24, years=[2016]) ts_clust_data = run_clust(ts_input_data).best_results using Plots