Clean up

.gitignore

@@ -1,14 +1,6 @@
 # exclude compiled binaries and external models
 /bin
 
-# exclude data from source control by default
-/data/temp
-/data/processed
-/data/raw
-
-# exclude compiled binaries and external models
-/bin
-
 # exclude data from source control by default
 /data/temp
 /data/raw
@@ -407,4 +399,4 @@ TSWLatexianTemp*
 # REVTeX puts footnotes in the bibliography by default, unless the nofootinbib
 # option is specified. Footnotes are the stored in a file with suffix Notes.bib.
 # Uncomment the next line to have this generated file ignored.
-#*Notes.bib
+#*Notes.bib

CITATION.cff

@@ -0,0 +1,46 @@
+cff-version: 1.2.0
+message: If you use this software, please cite it as below.
+authors:  
+  - given-names: 'Laurens P. '
+    family-names: Stoop
+    email: laurensstoop@pm.me
+    affiliation: Utrecht University
+    orcid: 'https://orcid.org/0000-0003-2756-5653'
+title: 'Scripts for The Climatological Renewable Energy Deviation Index' 
+version: 1.0.0
+date-released: 2023-07-18
+preferred-citation:
+  type: generic
+  authors:
+  - given-names: 'Laurens P. '
+    family-names: Stoop
+    email: laurensstoop@pm.me
+    affiliation: Utrecht University
+    orcid: 'https://orcid.org/0000-0003-2756-5653'
+  - given-names: 'Karin'
+    family-names: 'van der Wiel'
+    affiliation: 'KNMI'
+    orcid: 'https://orcid.org/0000-0001-9365-5759'
+  - given-names: 'William'
+    family-names: 'Zappa'
+    affiliation: 'TenneT TSO B.V.'
+    orcid: 'https://orcid.org/0000-0001-6810-7224'
+  - given-names: 'Arno'
+    family-names: 'Haverkamp'
+    affiliation: 'TenneT TSO B.V.'
+    orcid: 'https://orcid.org/0000-0001-6947-7892'
+  - given-names: 'Ad'
+    family-names: 'Feelders'
+    affiliation: 'Utrecht University'
+    orcid: 'https://orcid.org/0000-0003-4525-1949'
+  - given-names: 'Machteld'
+    family-names: 'van den Broek'
+    affiliation: 'University of Groningen'
+    orcid: 'https://orcid.org/0000-0003-1028-1742'
+  title: "The Climatological Renewable Energy Deviation Index"
+  year: 2023
+  journal: arXiv
+  url: 'https://arxiv.org/abs/2307.08909'
+  eprint: 2307.08909
+  archivePrefix: 'arXiv'
+  primaryClass: 'physics.ao-ph'

README.md

@@ -1,8 +1,8 @@
-# Metric: The Climatological Renewable Energy Deviation Index
+# Scripts for the Climatological Renewable Energy Deviation Index
 
-Version 1.0.0
+Version 1.0.1
 
-A metrics to quantify, understand, and explain, the impact of the variability of weather on the energy system across timescales. If you want to add a feature, please feel free to do so. 
+A set of scripts detailing the Climatological Renewable Energy Deviation Index as describe in [this paper](https://arxiv.org/abs/2307.08909). 
 
 
 ## Project organization
@@ -14,20 +14,18 @@ A metrics to quantify, understand, and explain, the impact of the variability of
 ├── LICENSE.md
 ├── README.md
 ├── requirements.txt
-├── bin                <- Compiled and external code, ignored by git (PG)
-│   └── external       <- Any external source code, ignored by git (RO)
-├── config             <- Configuration files (HW)
-├── data               <- All project data, ignored by git
-│   ├── processed      <- The final, canonical data sets for modeling. (PG)
-│   ├── raw            <- The original, immutable data dump. (RO)
-│   └── temp           <- Intermediate data that has been transformed. (PG)
-├── docs               <- Documentation notebook for users (HW)
-│   ├── manuscript     <- Manuscript source, e.g., LaTeX, Markdown, etc. (HW)
-│   └── reports        <- Other project reports and notebooks (e.g. Jupyter, .Rmd) (HW)
+├── data                     <- All project data, ignored by git
+│   ├── processed            <- The final, canonical data sets for modeling.
+│   ├── raw                  <- The original, immutable data dump, ignored by git.
+│   └── temp                 <- Intermediate data that has been transformed, ignored by git.
+├── docs                     <- Documentation notebook for users
+│   └── arXiv                <- Preprint arXiv files, e.g. LaTeX files
 ├── results
-│   ├── figures        <- Figures for the manuscript or reports (PG)
-│   └── output         <- Other output for the manuscript or reports (PG)
-└── src                <- Source code for this project (HW)
+│   ├── publication          <- Figures for the publication
+│   ├── supplementary        <- Supplementary figures for the investigation and publication
+│   ├── additional_regions   <- Base figures generated for other regions
+│   └── figures_development  <- Figures generated in the development phase of the project
+└── src                      <- Scripts and source code for this project 
 
 ```
 
@@ -38,4 +36,32 @@ This project is licensed under the terms of the [MIT License](/LICENSE.md)
 
 ## Citation
 
-Please [cite this project as described here](/CITATION.md).
+If you use CREDI in a scientific publication, we would appreciate citations to the following paper:
+
+[The Climatological Renewable Energy Deviation Index](https://arxiv.org/abs/2307.08909), Stoop, L. P., van der Wiel, K., Zappa, W., Haverkamp, A., Feelders, A., & van den Broek, M. (2023).
+
+Bibtex entry:
+```bibtex
+@misc{stoop2023climatological,
+      title={The Climatological Renewable Energy Deviation Index}, 
+      author={Laurens P. Stoop and Karin van der Wiel and William Zappa and Arno Haverkamp and Ad J. Feelders and Machteld van den Broek},
+      year={2023},
+      eprint={2307.08909},
+      archivePrefix={arXiv},
+      primaryClass={physics.ao-ph}
+}
+```
+
+If you want to cite scripts as provided here, please use:
+
+Scripts for The Climatological Renewable Energy Deviation Index, Stoop, L. P. (2023) https://github.com/laurensstoop/CREDI
+
+Bibtex entry:
+```bibtex
+@misc{stoop2023CREDIscripts,
+      title={Scripts for The Climatological Renewable Energy Deviation Index}, 
+      author={Laurens P. Stoop},
+      year={2023},
+      url={ https://github.com/laurensstoop/CREDI}
+}
+```