Skip to content

Commit 200edfc

Browse files
Minor updates testing and README
1 parent c53c37c commit 200edfc

File tree

6 files changed

+13
-11
lines changed

6 files changed

+13
-11
lines changed

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ keywords = ["clustering", "JuMP", "optimization"]
44
license = "MIT"
55
desc = "julia implementation of using different clustering methods for finding representative periods for the optimization of energy systems"
66
author = ["Holger Teichgraeber"]
7-
version = "0.4.1"
7+
version = "0.4.2"
88

99
[deps]
1010
CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://holgerteichgraeber.github.io/ClustForOpt.jl/dev)
55
[![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](LICENSE)
66
[![Build Status](https://travis-ci.com/holgerteichgraeber/ClustForOpt.jl.svg?token=HRFemjSxM1NBCsbHGNDG&branch=master)](https://travis-ci.com/holgerteichgraeber/ClustForOpt.jl)
7+
[![codecov](https://codecov.io/gh/holgerteichgraeber/ClustForOpt.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/holgerteichgraeber/ClustForOpt.jl)
78

89

910
[ClustForOpt](https://github.com/holgerteichgraeber/ClustForOpt.jl) is a [julia](https://www.juliaopt.com) implementation of clustering methods and extreme value selection methods for finding representative periods for energy systems optimization problems.
@@ -53,7 +54,7 @@ If you find ClustForOpt useful in your work, we kindly request that you cite the
5354

5455
## Quick Start Guide
5556

56-
This quick start guide introduces the main concepts of using ClustForOpt. For more detail on the different functionalities that ClustForOpt provides, please refer to the subsequent chapters of the documentation or the examples in the [examples](https://github.com/holgerteichgraeber/ClustForOpt.jl/tree/master/examples) folder.
57+
This quick start guide introduces the main concepts of using ClustForOpt. For more detail on the different functionalities that ClustForOpt provides, please refer to the subsequent chapters of the documentation or the examples in the [examples](https://github.com/holgerteichgraeber/ClustForOpt.jl/tree/master/examples) folder, specifically [workflow_introduction.jl](https://github.com/holgerteichgraeber/ClustForOpt.jl/blob/master/examples/workflow_introduction.jl).
5758

5859
Generally, the workflow consists of three steps:
5960
- load data

docs/src/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://holgerteichgraeber.github.io/ClustForOpt.jl/stable)
44
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://holgerteichgraeber.github.io/ClustForOpt.jl/dev)
55
[![Build Status](https://travis-ci.com/holgerteichgraeber/ClustForOpt.jl.svg?token=HRFemjSxM1NBCsbHGNDG&branch=master)](https://travis-ci.com/holgerteichgraeber/ClustForOpt.jl)
6+
[![codecov](https://codecov.io/gh/holgerteichgraeber/ClustForOpt.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/holgerteichgraeber/ClustForOpt.jl)
67

78
[ClustForOpt](https://github.com/holgerteichgraeber/ClustForOpt.jl) is a [julia](https://www.juliaopt.com) implementation of clustering methods and extreme value selection methods for finding representative periods for energy systems optimization problems.
89

docs/src/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Quick Start Guide
22
=================
33

4-
This quick start guide introduces the main concepts of using ClustForOpt. For more detail on the different functionalities that ClustForOpt provides, please refer to the subsequent chapters of the documentation or the examples in the [examples](https://github.com/holgerteichgraeber/ClustForOpt.jl/tree/master/examples) folder.
4+
This quick start guide introduces the main concepts of using ClustForOpt. For more detail on the different functionalities that ClustForOpt provides, please refer to the subsequent chapters of the documentation or the examples in the [examples](https://github.com/holgerteichgraeber/ClustForOpt.jl/tree/master/examples) folder, specifically [workflow_introduction.jl](https://github.com/holgerteichgraeber/ClustForOpt.jl/blob/master/examples/workflow_introduction.jl).
55

66
Generally, the workflow consists of three steps:
77
- load data

test/reference_generation/run_clust.jl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ using Random
66
reference_results = Dict{String,Any}()
77

88
Random.seed!(1111)
9-
for data in ["CEP_GER1","CEP_GER18"]
10-
ts_input_data = load_timeseries_data(Symbol(data))
9+
for data in [:CEP_GER1,:CEP_GER18]
10+
ts_input_data = load_timeseries_data(data)
1111
#mr: method, representation, n_init
1212
mr = [["kmeans","centroid",1000],
1313
["kmeans","medoid",1000],
@@ -47,8 +47,8 @@ for data in ["CEP_GER1","CEP_GER18"]
4747
end
4848
end
4949

50-
data = "CEP_GER1"
51-
ts_input_data = load_timeseries_data(Symbol(data))
50+
data = :CEP_GER1
51+
ts_input_data = load_timeseries_data(data)
5252
method = "kmedoids_exact"
5353
repr = "medoid"
5454
using Cbc

test/run_clust.jl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ using Random
1111
@load normpath(joinpath(dirname(@__FILE__),"reference_generation","run_clust.jld2")) reference_results
1212

1313
Random.seed!(1111)
14-
@testset "run_clust $data" for data in ["CEP_GER1","CEP_GER18"] begin
15-
ts_input_data = load_timeseries_data(Symbol(data))
14+
@testset "run_clust $data" for data in [:CEP_GER1,:CEP_GER18] begin
15+
ts_input_data = load_timeseries_data(data)
1616
#mr: method, representation, n_init
1717
mr = [["kmeans","centroid",1000],
1818
["kmeans","medoid",1000],
@@ -58,8 +58,8 @@ Random.seed!(1111)
5858
end
5959

6060
# Use the same data for all subsequent tests
61-
data = "CEP_GER1"
62-
ts_input_data = load_timeseries_data(Symbol(data))
61+
data = :CEP_GER1
62+
ts_input_data = load_timeseries_data(data)
6363

6464
using Cbc
6565
optimizer = Cbc.Optimizer

0 commit comments

Comments
 (0)