Skip to content

Commit

Permalink
Merge pull request karllark#236 from karllark/update_cite
Browse files Browse the repository at this point in the history
Update citation for published JOSS paper
  • Loading branch information
karllark authored Aug 26, 2024
2 parents 2380933 + c4ea811 commit 8871ed6
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 25 deletions.
34 changes: 25 additions & 9 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,11 +1,27 @@
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
cff-version: "1.2.0"
authors:
- family-names: "Gordon"
given-names: "Karl"
orcid: https://orcid.org/0000-0001-5340-6774
title: "dust_extinction"
version: v1.5
- family-names: Gordon
given-names: Karl D.
orcid: "https://orcid.org/0000-0001-5340-6774"
doi: 10.5281/zenodo.13333814
date-released: 2024-05-21
url: "https://github.com/karllark/dust_extinction"
message: If you use this software, please cite our article in the
Journal of Open Source Software.
preferred-citation:
authors:
- family-names: Gordon
given-names: Karl D.
orcid: "https://orcid.org/0000-0001-5340-6774"
date-published: 2024-08-25
doi: 10.21105/joss.07023
issn: 2475-9066
issue: 100
journal: Journal of Open Source Software
publisher:
name: Open Journals
start: 7023
title: "dust_extinction: Interstellar Dust Extinction Models"
type: article
url: "https://joss.theoj.org/papers/10.21105/joss.07023"
volume: 9
title: "dust_extinction: Interstellar Dust Extinction Models"

19 changes: 9 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,17 @@ To install::
Citation
--------

Please cite the original papers for the models used. The papers for each model
Please cite `Gordon 2024, JOSS, 9(100), 7023 <https://joss.theoj.org/papers/10.21105/joss.07023>`_.

In additon, please cite the original papers for the models used. The papers for each model
are given `here <https://dust-extinction.readthedocs.io/en/latest/dust_extinction/references.html>`_.

In addition, please cite the latest release of the package given below.
(Hopefully soon to be replaced with a JOSS paper.)
Documentation
-------------

See `readthedocs <http://dust-extinction.readthedocs.io>`_ for full documentation.

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.13333814.svg
:target: https://doi.org/10.5281/zenodo.13333814
Package paper:

.. image:: https://joss.theoj.org/papers/42619ff7078a218d14893ff2da4f6ca6/status.svg
:target: https://joss.theoj.org/papers/42619ff7078a218d14893ff2da4f6ca6
Expand Down Expand Up @@ -60,15 +63,11 @@ Packaging
:target: http://www.astropy.org
:alt: Powered by Astropy Badge

Documentation
-------------

Using `readthedocs <http://dust-extinction.readthedocs.io>`_.

In Development!
---------------

This code is currently in active development.
This code is in active development.
Contributions welcome (see below).

Contributors
Expand Down
11 changes: 5 additions & 6 deletions docs/dust_extinction/references.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@
References
##########



How to Cite
===========

Please cite the papers presenting the models. For some models, it is nice to also cite
Please cite `Gordon 2024, JOSS 9(100), 7023 <https://joss.theoj.org/papers/10.21105/joss.07023>`_.

In addition, please cite the papers presenting the models. For some models, it is nice to also cite
the works that provided a substantial input for that specific model.

+--------------+----------------------+
Expand All @@ -20,11 +24,6 @@ the works that provided a substantial input for that specific model.
| G23 | GCC09, F19, G21, D22 |
+--------------+----------------------+

In addition, please cite the dust_extinction package
(BibTex format found on "Cite this repository" button on main github repository page).

Gordon, K. (2024). dust_extinction (Version v1.4.1) [Computer software]. https://doi.org/10.5281/zenodo.11235336

Naming Convention
=================

Expand Down
8 changes: 8 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,14 @@ and uses the
`astropy.modeling <https://docs.astropy.org/en/stable/modeling/>`_
framework.

Citation
========

Please cite `Gordon 2024, JOSS, 9(100), 7023 <https://joss.theoj.org/papers/10.21105/joss.07023>`_.

In additon, please cite the original papers for the models used. The papers for each model
are given `here <https://dust-extinction.readthedocs.io/en/latest/dust_extinction/references.html>`_.

User Documentation
==================

Expand Down

0 comments on commit 8871ed6

Please sign in to comment.