Skip to content

Commit

Permalink
Add citation file (#46)
Browse files Browse the repository at this point in the history
  • Loading branch information
tcmetzger authored Apr 16, 2024
1 parent ee4f629 commit 0e666ff
Show file tree
Hide file tree
Showing 2 changed files with 84 additions and 1 deletion.
83 changes: 83 additions & 0 deletions CIATATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
cff-version: 1.2.0
title: "pyRTE-RRTMGP"
authors:
- given-names: Pincus
family-names: Robert
orcid: "https://orcid.org/0000-0002-0016-3470"
- name: makepath LLC
website: 'https://makepath.com/'
- given-names: Josué Miguel
family-names: Sehnem
orcid: "https://orcid.org/0009-0004-9403-1509"
type: software
repository-code: "https://github.com/earth-system-radiation/pyRTE-RRTMGP"
url: "https://pyrte-rrtmgp.readthedocs.io/"
license: BSD-3-Clause
date-released: "2024-04-09"
version: 0.0.5
abstract: >-
pyRTE-RRTMGP provides a Python interface to the RTE+RRTMGP
(https://earth-system-radiation.github.io/rte-rrtmgp/)
Fortran software package.
keywords:
- Python
- Scientific Python
- RTE+RRTMGP
- Atmospheric Radiation
- Radiative Transfer
- Climate Model
- Research
message: >-
If you use this software, please cite it using the
metadata from this file.
references:
- type: software
authors:
- family-names: Pincus
given-names: Robert
orcid: "https://orcid.org/0000-0002-0016-3470"
- family-names: Iacono
given-names: Michael J.
orcid: "https://orcid.org/0000-0002-9578-0649"
- family-names: Alexeev
given-names: Dmitry
orcid: "https://orcid.org/0000-0002-6425-2181"
- family-names: Adamidis
given-names: Panos
- family-names: Hillman
given-names: Benjamin R.
orcid: "https://orcid.org/0000-0002-9264-9872"
- family-names: Norman
given-names: Matthew
orcid: "https://orcid.org/0000-0003-4764-3348"
- family-names: Pfister
given-names: Erik
orcid: "https://orcid.org/0009-0002-2688-138X"
- family-names: Polonsky
given-names: Igor N.
- family-names: Romero
given-names: Nicols A.
- family-names: Wehe
given-names: Andre
title: "RTE+RRTMGP"
date-released: 2021-07-26
scope: "The underlying Fortran software"
doi: 10.5281/zenodo.3403172
version: 0.13.4
repository-code: "https://github.com/earth-system-radiation/rte-rrtmgp"
- type: article
authors:
- family-names: Pincus
given-names: Robert
- family-names: Mlawer
given-names: Eli J.
- family-names: Delamere
given-names: Jennifer S.
title: "Balancing Accuracy, Efficiency, and Flexibility in Radiation Calculations for Dynamical Models"
year: 2019
journal: "Journal of Advances in Modeling Earth Systems"
scope: "This paper describes the design, concepts, and version 1.0 of the underlying Fortran software"
volume: 11
number: 10
pages: 3074-3089
doi: 10.1029/2019MS001621
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Pull Requests for new features should include tests and documentation.

For maintainers:

1. To make a new release, update the version number in `pyproject.toml` and `conda.recipe/meta.yaml`.
1. To make a new release, update the version number in `pyproject.toml` and `conda.recipe/meta.yaml`. Also update `CITATION.cff` as necessary.
2. Then, create a new release off the `main` branch on GitHub, using the "Draft a new release" button in [https://github.com/earth-system-radiation/pyRTE-RRTMGP/releases](https://github.com/earth-system-radiation/pyRTE-RRTMGP/releases).
3. Create a new tag with the version number, and use the "Generate release notes" button to create the release notes.
4. Review and update the the release notes as necessary, and publish the release and set it as the latest release.
Expand Down

0 comments on commit 0e666ff

Please sign in to comment.