Skip to content

Commit

Permalink
fill in references
Browse files Browse the repository at this point in the history
  • Loading branch information
gidden committed Dec 19, 2018
1 parent a63b9ce commit a194ba9
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 2 deletions.
1 change: 1 addition & 0 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
'sphinxcontrib.programoutput',
'sphinx.ext.mathbase',
'sphinx_gallery.gen_gallery',
'sphinxcontrib.bibtex',
]

sphinx_gallery_conf = {
Expand Down
3 changes: 1 addition & 2 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,5 +82,4 @@ License

:code:`pyam` is available under the open source `Apache License`_.

.. _Apache LIcense: http://www.apache.org/licenses/LICENSE-2.0.html

.. _Apache License: http://www.apache.org/licenses/LICENSE-2.0.html
12 changes: 12 additions & 0 deletions doc/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ From Source
Depedencies
~~~~~~~~~~~

Like any software project, we stand on the shoulders of giants. Our particular
giants include :code:`numpy` :cite:`numpy`, :code:`matplotlib`
:cite:`matplotlib`, and :code:`pandas` :cite:`pandas`. Explicit requirements are
fully enumerated below.

The required depedencies for :code:`pyam` are:

.. program-output:: python -c 'import sys; sys.path.append("../.."); import requirements; requirements.display()'
Expand All @@ -42,3 +47,10 @@ The depedencies for building this documentation are:
.. include:: ../requirements.txt
:start-line: 0
:literal:

References
**********

.. bibliography:: refs.bib
:style: plain
:all:
33 changes: 33 additions & 0 deletions doc/source/refs.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@

@Misc{numpy,
author = {Travis Oliphant},
title = {{NumPy}: A guide to {NumPy}},
year = {2006--},
howpublished = {USA: Trelgol Publishing},
url = "http://www.numpy.org/"
}

@Article{matplotlib,
Author = {Hunter, J. D.},
Title = {Matplotlib: A 2D graphics environment},
Journal = {Computing In Science \& Engineering},
Volume = {9},
Number = {3},
Pages = {90--95},
abstract = {Matplotlib is a 2D graphics package used for Python
for application development, interactive scripting, and
publication-quality image generation across user
interfaces and operating systems.},
publisher = {IEEE COMPUTER SOC},
doi = {10.1109/MCSE.2007.55},
year = 2007
}

@InProceedings{pandas,
author = {Wes McKinney},
title = {Data Structures for Statistical Computing in Python},
booktitle = {Proceedings of the 9th Python in Science Conference},
pages = {51 - 56},
year = {2010},
editor = {Stefan van der Walt and Jarrod Millman}
}

0 comments on commit a194ba9

Please sign in to comment.