Skip to content

Commit

Permalink
Added DOI to README.md and minor docs fix (#10)
Browse files Browse the repository at this point in the history
* Added DOI to README.md 
* Minor docs fix
JulStraus authored Dec 16, 2024
1 parent 785bd3d commit 40a2126
Showing 3 changed files with 10 additions and 13 deletions.
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -15,10 +15,6 @@ These technologies are
`RefNetworkNodeRetrofit` and `CCSRetroFit` have to be coupled to each other for proper functioning as they require a proxy resource for CO2.
Further information can be found in the _[corresponding documentation](https://energymodelsx.github.io/EnergyModelsCO2.jl/stable/)_.

> **Note**:
> The stable docs are in the current version not working due to a mistake in the deploy.
> It will be updated in the next release.
## Usage

The usage of the package is best illustrated through the commented [`examples`](examples).
@@ -30,13 +26,14 @@ If you find `EnergyModelsBase` useful in your work, we kindly request that you c

```bibtex
@article{hellemo2024energymodelsx,
title={EnergyModelsX: Flexible Energy Systems Modelling with Multiple Dispatch},
author={Hellemo, Lars and B{\o}dal, Espen Flo and Holm, Sigmund Eggen and Pinel, Dimitri and Straus, Julian},
journal={Journal of Open Source Software},
volume={9},
number={97},
pages={6619},
year={2024}
title = {EnergyModelsX: Flexible Energy Systems Modelling with Multiple Dispatch},
author = {Hellemo, Lars and B{\o}dal, Espen Flo and Holm, Sigmund Eggen and Pinel, Dimitri and Straus, Julian},
journal = {Journal of Open Source Software},
volume = {9},
number = {97},
pages = {6619},
year = {2024},
doi = {https://doi.org/10.21105/joss.06619},
}
```

2 changes: 1 addition & 1 deletion docs/src/nodes/storage.md
Original file line number Diff line number Diff line change
@@ -105,7 +105,7 @@ Hence, a single additional variable is declared through dispatching on the metho
### [Constraints](@id nodes-co2_storage-math-con)

The following sections omit the direct inclusion of the vector of CO₂ storage nodes.
Instead, it is implicitly assumed that the constraints are valid ``\forall n ∈ N^{\text{CO}_2\_storage}`` for all [`CO2Source`](@ref) types if not stated differently.
Instead, it is implicitly assumed that the constraints are valid ``\forall n ∈ N^{\text{CO}_2\_storage}`` for all [`CO2Storage`](@ref) types if not stated differently.
In addition, all constraints are valid ``\forall t \in T`` (that is in all operational periods) or ``\forall t_{inv} \in T^{Inv}`` (that is in all strategic periods).

#### [Standard constraints](@id nodes-co2_storage-math-con-stand)
2 changes: 1 addition & 1 deletion src/datastructures.jl
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@
"""
AccumulatingStrategic <: EMB.Accumulating
`StorageBehavior` which accumulates all inflow witin a strategic period and transfers the
`StorageBehavior` which accumulates all inflow within a strategic period and transfers the
level to the next strategic period. This approach is used for [`CO2Storage`](@ref) nodes.
"""
struct AccumulatingStrategic <: EMB.Accumulating end

0 comments on commit 40a2126

Please sign in to comment.