Skip to content

Commit 40bb730

Browse files
committed
Merge pull request #389 from munslowa/citation
Iris citation added into user guide
2 parents 4b62230 + b6e8a1a commit 40bb730

File tree

2 files changed

+56
-0
lines changed

2 files changed

+56
-0
lines changed
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
.. _Citing_Iris:
2+
3+
===========
4+
Citing Iris
5+
===========
6+
7+
If Iris played an important part in your research then please add us to your reference list by using one of the recommendations below.
8+
9+
************
10+
BibTeX entry
11+
************
12+
13+
For example::
14+
15+
@manual{Iris,
16+
author = {{Met Office}},
17+
title = {Iris: A Python library for analysing and visualising meteorological and oceanographic data sets},
18+
edition = {v1.2},
19+
year = {2010 - 2013},
20+
address = {Exeter, Devon },
21+
url = {http://scitools.org.uk/}
22+
}
23+
24+
25+
*******************
26+
Downloaded Software
27+
*******************
28+
29+
Suggested format::
30+
31+
ProductName. Version. ReleaseDate. Publisher. Location. DOIorURL. DownloadDate.
32+
33+
For example::
34+
35+
Iris. v1.2. 28-Feb-2013. Met Office. UK. https://github.com/SciTools/iris/archive/v1.2.0.tar.gz 01-03-2013
36+
37+
38+
********************
39+
Checked out Software
40+
********************
41+
42+
Suggested format::
43+
44+
ProductName. Publisher. URL. CheckoutDate. RepositorySpecificCheckoutInformation.
45+
46+
For example::
47+
48+
Iris. Met Office. git@github.com:SciTools/iris.git 06-03-2013
49+
50+
.. _How to cite and describe software: http://software.ac.uk/so-exactly-what-software-did-you-use
51+
52+
53+
Reference: [Jackson]_.
54+
55+
.. [Jackson] Jackson, M. 2012. `How to cite and describe software`_. Accessed 06-03-2013.

docs/iris/src/userguide/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,5 @@ User guide table of contents
3232
plotting_a_cube.rst
3333
cube_statistics.rst
3434
cube_maths.rst
35+
citation.rst
3536
end_of_userguide.rst

0 commit comments

Comments
 (0)