Suggestions integrated

.codecov.yml

@@ -5,7 +5,6 @@ codecov:
 coverage:
  precision: 2
  round: down
- range: "70...100"
 
  status:
  project: yes

CONTRIBUTING.md

@@ -1,4 +1,4 @@
 ## How to contribute to CapacityExpansion.jl
 Welcome! Thank you for considering to contribute to `CapacityExpansion.jl`. If you have a comment, question, feature request, or bug report, please open a new [issue](https://github.com/YoungFaithful/CapacityExpansion.jl/issues).
 
-If you like to file a bug report, or like to contribute to the documentation or the code (always welcome!), the [JuMP.jl Contributing.md](https://github.com/JuliaOpt/JuMP.jl/blob/master/CONTRIBUTING.md) has some great tips on how to get started.
+If you like to file a bug report, or like to contribute to the documentation or the code (always welcome!), the [JuMP.jl Contributing.md](https://github.com/JuliaOpt/JuMP.jl/blob/master/CONTRIBUTING.md) has some great tips on how to get started. We follow the git workflow using a `dev`-branch for development and a `master`-branch for the stable versions.

README.md

@@ -6,10 +6,10 @@
 
 [CapacityExpansion](https://github.com/YoungFaithful/CapacityExpansion.jl) is a [julia](https://www.juliaopt.com) implementation of a input-data-scaling capacity expansion modeling framework.
 
-The package has three main purposes:
-1) Provide a simple process to integrate (clustered) time-series input data, geographical input data, cost input data, and technology input data.
-2) Provide a model configuration, a modular model setup and model optimization.
-3) Provide an interface between the optimization result and further analysis.
+The main purpose of the package is providing an extensible, simple-to-use generation and transmission capacity extension model that allows to address a diverse set of research questions in the area of energy systems planning. The secondary purposes are:
+1) Providing a simple process to integrate (clustered) time-series input data, geographical input data, cost input data, and technology input data.
+2) Providing a model configuration, a modular model setup and model optimization.
+3) Providing an interface between the optimization result and further analysis.
 
 |Model Information | |
 |---------------------|-----------------------------------------------------------------------------------|
@@ -28,7 +28,7 @@ The package has three main purposes:
 |Time resolution | hourly |
 |Network coverage | transmission, DCOPF load flow |
 
-The package uses [TimeSeriesClustering](https://github.com/holgerteichgraeber/TimeSeriesClustering.jl) as a basis for it's time-series aggregation.
+The package uses [TimeSeriesClustering](https://github.com/holgerteichgraeber/TimeSeriesClustering.jl) as a basis for its time-series aggregation.
 
 This package is developed by Elias Kuepper [@YoungFaithful](https://github.com/youngfaithful) and Holger Teichgraeber [@holgerteichgraeber](https://github.com/holgerteichgraeber).
 

data/CA_1/techs.yml

@@ -1,6 +1,6 @@
 tech_groups:
  all:
- discount_rate: 0.07
+ discount_rate: 0.07 #[-]
  demand:
  structure: node
  unit: power
@@ -30,8 +30,8 @@ tech_groups:
 techs:
  demand:
  name: Electricity demand
- plant_lifetime: 30
- financial_lifetime: 30
+ plant_lifetime: 30 #[a]
+ financial_lifetime: 30 #[a]
  tech_group: demand
  input:
  carrier: electricity
@@ -40,37 +40,37 @@ techs:
  pv:
  name: Photo Voltaic
  tech_group: non_dispatchable_generation
- plant_lifetime: 25
- financial_lifetime: 25
+ plant_lifetime: 25 #[a]
+ financial_lifetime: 25 #[a]
  input:
  timeseries: solar
  output:
  carrier: electricity
  wind:
  name: Onshore Wind
  tech_group: non_dispatchable_generation
- plant_lifetime: 25
- financial_lifetime: 25
+ plant_lifetime: 25 #[a]
+ financial_lifetime: 25 #[a]
  input:
  timeseries: wind
  output:
  carrier: electricity
  coal:
  name: Coal Plant
  tech_group: dispatchable_generation
- plant_lifetime: 40
- financial_lifetime: 40
+ plant_lifetime: 40 #[a]
+ financial_lifetime: 40 #[a]
  input:
  fuel: coal
  output:
  carrier: electricity
  constraints:
- max_gradient: 0.6 #not yet funcional
+ max_gradient: 0.6 #1/h not yet funcional
  oil:
  name: Oil Plant
  tech_group: dispatchable_generation
- plant_lifetime: 30
- financial_lifetime: 30
+ plant_lifetime: 30 #[a]
+ financial_lifetime: 30 #[a]
  input:
  fuel: oil
  output:
@@ -80,91 +80,91 @@ techs:
  gas:
  name: Gas Plant
  tech_group: dispatchable_generation
- plant_lifetime: 30
- financial_lifetime: 30
+ plant_lifetime: 30 #[a]
+ financial_lifetime: 30 #[a]
  input:
  fuel: gas
  output:
  carrier: electricity
  constraints:
- max_gradient: 4.8 #not yet funcional
+ max_gradient: 4.8 #[1/h] not yet funcional
  bat_in:
  name: Battery Charge
  tech_group: conversion
- plant_lifetime: 10
- financial_lifetime: 10
+ plant_lifetime: 10 #[a]
+ financial_lifetime: 10 #[a]
  input:
  carrier: electricity
  output:
  carrier: electricity_bat
  constraints:
- efficiency: 0.93
+ efficiency: 0.93 #[-]
  bat_out:
  name: Battery Discharge
  tech_group: conversion
- plant_lifetime: 10
- financial_lifetime: 10
+ plant_lifetime: 10 #[a]
+ financial_lifetime: 10 #[a]
  input:
  carrier: electricity_bat
  output:
  carrier: electricity
  constraints:
- efficiency: 0.93
+ efficiency: 0.93 #[-]
  cap_eq: bat_in # Discharge capacity is same as charge capacity
  bat_e:
  name: Battery Storage
  tech_group: storage
- plant_lifetime: 10
- financial_lifetime: 10
+ plant_lifetime: 10 #[a]
+ financial_lifetime: 10 #[a]
  input:
  carrier: electricity_bat
  output:
  carrier: electricity_bat
  constraints:
- efficiency: 0.93
+ efficiency: 0.93 #[-]
  h2_in:
  name: Hydrogen Storage Charge
  tech_group: conversion
- plant_lifetime: 15
- financial_lifetime: 20
+ plant_lifetime: 15 #[a]
+ financial_lifetime: 20 #[a]
  input:
  carrier: electricity
  output:
  carrier: hydrogen
  constraints:
- efficiency: 0.83
+ efficiency: 0.83 #[-]
  h2_out:
  name: Hydrogen Storage Discharge
  tech_group: conversion
- plant_lifetime: 40
- financial_lifetime: 20
+ plant_lifetime: 40 #[a]
+ financial_lifetime: 20 #[a]
  input:
  carrier: hydrogen
  output:
  carrier: electricity
  constraints:
- efficiency: 0.53
+ efficiency: 0.53 #[-]
  cap_eq: h2_in # Discharge capacity is same as charge capacity
  h2_e:
  name: Hydrogen Storage
  tech_group: storage
- plant_lifetime: 40
- financial_lifetime: 20
+ plant_lifetime: 40 #[a]
+ financial_lifetime: 20 #[a]
  input:
  carrier: hydrogen
  output:
  carrier: hydrogen
  constraints:
- efficiency: 0.99
+ efficiency: 0.99 #[-]
 
  trans:
  name: Transmission Line
  tech_group: transmission
- plant_lifetime: 40
- financial_lifetime: 40
+ plant_lifetime: 40 #[a]
+ financial_lifetime: 40 #[a]
  input:
  carrier: electricity
  output:
  carrier: electricity
  constraints:
- efficiency: 0.9995 #_per_km
+ efficiency: 0.9995 #[1/km]