Skip to content

Commit

Permalink
Add citation to JOSS paper (#32)
Browse files Browse the repository at this point in the history
  • Loading branch information
hellemo authored May 24, 2024
1 parent 3704c80 commit cd0506a
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 2 deletions.
56 changes: 56 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
cff-version: "1.2.0"
authors:
- family-names: Hellemo
given-names: Lars
orcid: "https://orcid.org/0000-0001-5958-9794"
- family-names: Bødal
given-names: Espen Flo
orcid: "https://orcid.org/0000-0001-6970-9315"
- family-names: Holm
given-names: Sigmund Eggen
orcid: "https://orcid.org/0009-0007-1782-6326"
- family-names: Pinel
given-names: Dimitri
orcid: "https://orcid.org/0000-0001-9393-0036"
- family-names: Straus
given-names: Julian
orcid: "https://orcid.org/0000-0001-8622-1936"
contact:
- family-names: Hellemo
given-names: Lars
orcid: "https://orcid.org/0000-0001-5958-9794"
doi: 10.5281/zenodo.11164518
message: If you use this software, please cite our article in the
Journal of Open Source Software.
preferred-citation:
authors:
- family-names: Hellemo
given-names: Lars
orcid: "https://orcid.org/0000-0001-5958-9794"
- family-names: Bødal
given-names: Espen Flo
orcid: "https://orcid.org/0000-0001-6970-9315"
- family-names: Holm
given-names: Sigmund Eggen
orcid: "https://orcid.org/0009-0007-1782-6326"
- family-names: Pinel
given-names: Dimitri
orcid: "https://orcid.org/0000-0001-9393-0036"
- family-names: Straus
given-names: Julian
orcid: "https://orcid.org/0000-0001-8622-1936"
date-published: 2024-05-17
doi: 10.21105/joss.06619
issn: 2475-9066
issue: 97
journal: Journal of Open Source Software
publisher:
name: Open Journals
start: 6619
title: "EnergyModelsX: Flexible Energy Systems Modelling with Multiple
Dispatch"
type: article
url: "https://joss.theoj.org/papers/10.21105/joss.06619"
volume: 9
title: "EnergyModelsX: Flexible Energy Systems Modelling with Multiple
Dispatch"
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# EnergyModelsBase

[![DOI](https://joss.theoj.org/papers/10.21105/joss.06619/status.svg)](https://doi.org/10.21105/joss.06619)
[![Build Status](https://github.com/EnergyModelsX/EnergyModelsBase.jl/workflows/CI/badge.svg)](https://github.com/EnergyModelsX/EnergyModelsBase.jl/actions?query=workflow%3ACI)
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://energymodelsx.github.io/EnergyModelsBase.jl/stable/)
[![In Development](https://img.shields.io/badge/docs-dev-blue.svg)](https://energymodelsx.github.io/EnergyModelsBase.jl/dev/)
Expand All @@ -15,7 +16,21 @@ The examples are minimum working examples highlighting how to build simple energ

## Cite

If you find `EnergyModelsBase` useful in your work, we kindly request that you cite the following publication:
If you find `EnergyModelsBase` useful in your work, we kindly request that you cite the following [publication](https://doi.org/10.21105/joss.06619):

```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}
}
```

For earlier work, see our [paper in Applied Energy](https://www.sciencedirect.com/science/article/pii/S0306261923018482):

```bibtex
@article{boedal_2024,
Expand All @@ -33,4 +48,4 @@ If you find `EnergyModelsBase` useful in your work, we kindly request that you c

## Project Funding

The development of `EnergyModelsBase` was funded by the Norwegian Research Council in the project [Clean Export](https://www.sintef.no/en/projects/2020/cleanexport/), project number [308811](https://prosjektbanken.forskningsradet.no/project/FORISS/308811)
The development of `EnergyModelsBase` was funded by the Norwegian Research Council in the project [Clean Export](https://www.sintef.no/en/projects/2020/cleanexport/), project number [308811](https://prosjektbanken.forskningsradet.no/project/FORISS/308811)

2 comments on commit cd0506a

@JulStraus
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/107548

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.7.0 -m "<description of version>" cd0506a7ed6c1752fe2e78ee509a715125f0738a
git push origin v0.7.0

Please sign in to comment.