Skip to content

Commit 338b0b9

Browse files
authored
Merge pull request #43 from scientificcomputing/finsberg/sofware-citation
Add page about citing software
2 parents 7216fb7 + 40b9fbe commit 338b0b9

File tree

3 files changed

+18
-2
lines changed

3 files changed

+18
-2
lines changed

.cspell_dict.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Cookiecutter
1010
Daversin
1111
docname
1212
docnames
13+
DOLFINx
1314
Dokken
1415
electrodiffusive
1516
finsberg
@@ -18,7 +19,9 @@ Forsch
1819
Fouilloux
1920
Gjerde
2021
glymphatic
22+
Graphnics
2123
Haubner
24+
howpublished
2225
htmlcov
2326
importlib
2427
Ingeborg
@@ -58,5 +61,3 @@ SVMTK
5861
Valnes
5962
venv
6063
Zenodo
61-
DOLFI
62-
Graphnics

docs/_toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ parts:
4040
- caption: Miscellaneous
4141
chapters:
4242
- file: license
43+
- file: software-citation
4344
- file: resources
4445
- file: misc
4546

docs/software-citation.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Citing a repository
2+
3+
Sometimes you need to cite some software that you used to generate results in a paper. If the software contains instructions for how to cite it then you should use those instructions. For example, the repository might contain a [`CITATION.cff` file](gh-citable.md), see e.g https://github.com/finsberg/ldrb or it might contain instructions for how to cite the software in the README, see e.g https://github.com/ComputationalPhysiology/simcardems/blob/main/README.md#citing
4+
5+
If no instructions exists you should use the `@misc` entry, e.g
6+
```
7+
@misc{Finsberg_MPS_motion,
8+
author = {Finsberg, Henrik},
9+
title = {{MPS motion - Library for tracking motion in cardiac mps data}},
10+
howpublished = {\url{https://github.com/ComputationalPhysiology/mps-motion}},
11+
note = {Accessed: 2022-10-06},
12+
year = {2022}
13+
}
14+
```

0 commit comments

Comments
 (0)