Merge pull request #695 from glatterf42/add_citation_file

Add citation file

CITATION.cff

@@ -0,0 +1,180 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: MESSAGEix
+message: >-
+  Thank you for using the MESSAGEix framework! Please cite
+  the GitHub repository and the MESSAGEix framework manuscript 
+  (https://doi.org/10.1016/j.envsoft.2018.11.012).
+type: software
+authors:
+  - given-names: Paul Natsuo
+    family-names: Kishimoto
+    affiliation: IIASA
+    orcid: 'https://orcid.org/0000-0002-8578-753X'
+  - given-names: Laura
+    family-names: Wienpahl
+  - given-names: Behnam
+    family-names: Zakeri
+    affiliation: IIASA
+    orcid: 'https://orcid.org/0000-0001-9647-2878'
+  - given-names: Francesco
+    family-names: Iovat
+  - given-names: Oliver
+    family-names: Fricko
+    affiliation: IIASA
+    orcid: 'https://orcid.org/0000-0002-6835-9883'
+  - given-names: Matthew J.
+    family-names: Gidden
+    affiliation: IIASA
+    orcid: 'https://orcid.org/0000-0003-0687-414X'
+  - given-names: Daniel
+    family-names: Huppmann
+    affiliation: IIASA
+    orcid: 'https://orcid.org/0000-0002-7729-7389'
+  - given-names: Volker
+    family-names: Krey
+    affiliation: IIASA
+    orcid: 'https://orcid.org/0000-0003-0307-3515'
+  - given-names: Adriano
+    family-names: Vinca
+    affiliation: IIASA
+    orcid: 'https://orcid.org/0000-0002-3051-178X'
+  - given-names: Gamze
+    family-names: Ünlü
+    affiliation: IIASA
+    orcid: 'https://orcid.org/0000-0003-0080-7122'
+  - given-names: Miguel Poblete
+    family-names: Cazenave
+    affiliation: IIASA
+  - given-names: Jarmo S.
+    family-names: Kikstra
+    affiliation: IIASA
+    orcid: 'https://orcid.org/0000-0001-9405-1228'
+  - given-names: Fridolin
+    family-names: Glatter
+    affiliation: IIASA
+    orcid: 'https://orcid.org/0009-0007-9452-2473'
+  - given-names: Jihoon
+    family-names: Min
+    affiliation: IIASA
+    orcid: 'https://orcid.org/0000-0002-0020-1174'
+  - given-names: Jan
+    family-names: Steinhauser
+    affiliation: IIASA
+    orcid: 'https://orcid.org/0000-0002-5989-6855'
+  - given-names: Clara
+    family-names: Orthofer
+    orcid: 'https://orcid.org/0000-0002-7049-7791'
+  - given-names: Thomas
+    family-names: Zipperle
+    orcid: 'https://orcid.org/0000-0003-2512-9508'
+  - given-names: Nikolay
+    family-names: Kushin
+  - given-names: Alessio
+    family-names: Mastrucci
+    affiliation: IIASA
+    orcid: 'https://orcid.org/0000-0002-5611-7780'
+  - given-names: Michael
+    family-names: Pimmer
+  - given-names: Peter
+    family-names: Kolp
+    affiliation: IIASA
+    orcid: 'https://orcid.org/0000-0003-0122-2839'
+identifiers:
+  - type: url
+    value: 'https://github.com/iiasa/message_ix'
+    description: Main repository of the MESSAGEix framework on Github
+  - type: doi
+    value: 10.5281/zenodo.4005684
+    description: Zenodo entry
+repository-code: 'https://github.com/iiasa/message_ix'
+url: 'https://docs.messageix.org/en/stable/index.html'
+abstract: >-
+  MESSAGEix is a versatile, dynamic, model framework for
+  energy-engineering-economy-environment (E4) systems
+  research.
+
+
+  MESSAGE (without “…ix”) is a specific formulation of a
+  generic linear programming (LP) optimization model for
+  strategic energy planning and integrated assessment of E4
+  systems, developed by the IIASA Energy, Climate, and
+  Environment (ECE) Program since the 1980s. To incorporate
+  feedback between prices and demand levels for energy and
+  commodities, the LP model can optionally be linked to the
+  economic general equilibrium (GE) MACRO model.
+
+
+  The message_ix Python package—also fully usable from
+  R—includes:
+
+      Implementations of MESSAGE, MACRO, and their linkage, in GAMS,
+      Application programming interfaces (APIs) and tools for model building and scientific programming,
+      Extensive documentation and a complete test suite.
+
+  The framework is built on IIASA's ix modeling platform
+  (ixmp), which provides data warehouse features for
+  high-powered numerical scenario analysis.
+keywords:
+  - integrated assessment
+  - energy systems
+  - macro-energy
+  - modelling
+  - scenario analysis
+  - data visualisation
+  - Python package
+license: Apache-2.0
+references:
+  - title: "The MESSAGEix Integrated Assessment Model and the ix modeling platform (ixmp): An open framework for integrated and cross-cutting analysis of energy, climate, the environment, and sustainable development"
+    journal: "Environmental Modelling & Software"
+    year: 2019
+    authors:
+    - given-names: Daniel
+      family-names: Huppmann
+      affiliation: IIASA
+      orcid: 'https://orcid.org/0000-0002-7729-7389'
+    - given-names: Matthew J.
+      family-names: Gidden
+      affiliation: IIASA
+      orcid: 'https://orcid.org/0000-0003-0687-414X'
+    - given-names: Oliver
+      family-names: Fricko
+      affiliation: IIASA
+      orcid: 'https://orcid.org/0000-0002-6835-9883'
+    - given-names: Peter
+      family-names: Kolp
+      affiliation: IIASA
+      orcid: 'https://orcid.org/0000-0003-0122-2839'
+    - given-names: Clara
+      family-names: Orthofer
+      orcid: 'https://orcid.org/0000-0002-7049-7791'
+    - given-names: Michael
+      family-names: Pimmer
+    - given-names: Nikolay
+      family-names: Kushin
+    - given-names: Adriano
+      family-names: Vinca
+      affiliation: IIASA
+      orcid: 'https://orcid.org/0000-0002-3051-178X'
+    - given-names: Alessio
+      family-names: Mastrucci
+      affiliation: IIASA
+      orcid: 'https://orcid.org/0000-0002-5611-7780'
+    - given-names: Keywan
+      family-names: Riahi
+      affiliation: IIASA
+      orcid: 'https://orcid.org/0000-0001-7193-3498'
+    - given-names: Volker
+      family-names: Krey
+      affiliation: IIASA
+      orcid: 'https://orcid.org/0000-0003-0307-3515'
+    doi: "10.1016/j.envsoft.2018.11.012"
+    url: "pure.iiasa.ac.at/15157/"
+    volume: 112
+    month: 2
+    start: 143
+    end: 156
+    type: article
+

NOTICE.rst

@@ -13,6 +13,8 @@ The aim of this request is to ensure good scientific practice and collaborative
 
 Use the most recent version of |MESSAGEix| from the Github repository.
 Specify clearly which version (e.g. release tag, such as ``v1.1.0``, or commit hash, such as ``26cc08f``) you have used, and whether you have made any modifications to the code.
+To retrieve this information from the command line, use ``git describe --tags``, which will show you the version, number of commits since then, and the hash of your current commit.
+Note that the commit hash does not include the preceeding ``-g``.
 
 Read and understand the file ``LICENSE``; in particular, clause 7 (“Disclaimer of Warranty”), which states:
 
@@ -31,6 +33,9 @@ Cite, at minimum, the following manuscript:
   | doi: `10.1016/j.envsoft.2018.11.012`_
   | electronic pre-print available at `pure.iiasa.ac.at/15157/`_.
 
+You should also cite the software project itself. The data for citing both the manuscript and the software can be found in the citation file :file:`CITATION.cff`.
+You can use `the official cff tools <https://github.com/citation-file-format/citation-file-format#tools-to-work-with-citationcff-files-wrench>`__ to export the data to BibTeX and other formats.
+
 In addition, you may:
 
 - **Cite the code via Zenodo**.

RELEASE_NOTES.rst

@@ -48,7 +48,8 @@ All changes
 - Ensure `levelized_cost` are also calculated for technologies with only variable costs (:pull:`653`).
 - Correct calculation of `COST_NODAL_NET` for standalone MESSAGE (:pull:`648`)
 - Account for difference in period-length in equations `NEW_CAPACITY_CONSTRAINT_LO` and `NEW_CAPACITY_CONSTRAINT_UP` (:pull:`654`)
-- Extend functionality of storage solutions to include "mode" and temporal level (:pull:`633`).
+- Extend functionality of storage solutions to include "mode" and temporal level (:pull:`633`)
+- Introduce a citation file :file:`CITATION.cff` with citation information (:pull:`695`).
 
 .. _v3.6.0: