Skip to content

Commit

Permalink
Add JOSS citation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Ig-dolci committed Mar 22, 2024
1 parent e6106b0 commit 037e8de
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 10 deletions.
51 changes: 41 additions & 10 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,21 +1,52 @@
cff-version: 1.1.0
message: "If you use this software, please cite it as below."
cff-version: "1.2.0"
authors:
- family-names: Dolci
given-names: Daiane I.
orcid: https://orcid.org/0000-0002-1435-9538
orcid: "https://orcid.org/0000-0002-1435-9538"
- family-names: Maddison
given-names: James R.
orcid: https://orcid.org/0000-0001-5742-4363
orcid: "https://orcid.org/0000-0001-5742-4363"
- family-names: Ham
given-names: David A.
orcid: https://orcid.org/0000-0001-9545-9110
orcid: "https://orcid.org/0000-0001-9545-9110"
- family-names: Pallez
given-names: Guillaume
orcid: https://orcid.org/0000-0001-8862-3277
orcid: "https://orcid.org/0000-0001-8862-3277"
- family-names: Herrmann
given-names: Julien
orcid: https://orcid.org/0000-0003-4935-2368
title: "checkpoint_schedules: schedules for incremental checkpointing of adjoint simulations"
version: v1.0.3
date-released: 2023-03-14
orcid: "https://orcid.org/0000-0003-4935-2368"
doi: 10.5281/zenodo.10817312
message: If you use this software, please cite our article in the
Journal of Open Source Software.
preferred-citation:
authors:
- family-names: Dolci
given-names: Daiane I.
orcid: "https://orcid.org/0000-0002-1435-9538"
- family-names: Maddison
given-names: James R.
orcid: "https://orcid.org/0000-0001-5742-4363"
- family-names: Ham
given-names: David A.
orcid: "https://orcid.org/0000-0001-9545-9110"
- family-names: Pallez
given-names: Guillaume
orcid: "https://orcid.org/0000-0001-8862-3277"
- family-names: Herrmann
given-names: Julien
orcid: "https://orcid.org/0000-0003-4935-2368"
date-published: 2024-03-22
doi: 10.21105/joss.06148
issn: 2475-9066
issue: 95
journal: Journal of Open Source Software
publisher:
name: Open Journals
start: 6148
title: "checkpoint_schedules: schedules for incremental checkpointing
of adjoint simulations"
type: article
url: "https://joss.theoj.org/papers/10.21105/joss.06148"
volume: 9
title: "checkpoint_schedules: schedules for incremental checkpointing of
adjoint simulations"
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,8 @@ The complete documentation for checkpoint_schedules is available at [Firedrake p

## License
*checkpoint_schedules* is licensed under the GNU LGPL version 3. See the LICENSE file for details.

## Citation
If you use *checkpoint_schedules* in your research, please cite this paper
[![DOI](https://joss.theoj.org/papers/10.21105/joss.06148/status.svg)](https://doi.org/10.21105/joss.06148).

4 changes: 4 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,7 @@ To contribute please consider the following steps:
Bug reports
===========
Please report bugs on the `issue tracker <https://github.com/firedrakeproject/checkpoint_schedules/issues>`_.

Citing
======
If you use *checkpoint_schedules* in your research, please cite `<JOSS paper https://joss.theoj.org/papers/10.21105/joss.06148>`_.

0 comments on commit 037e8de

Please sign in to comment.