Skip to content
Snippets Groups Projects
Commit 555b7d53 authored by Benjamin Cumming's avatar Benjamin Cumming Committed by Sam Yates
Browse files

Add citation information to the readme (#739)

Add citation information to the readme.
parent 6ad689fa
No related branches found
No related tags found
No related merge requests found
......@@ -7,3 +7,25 @@ Arbor is a library for implementing performance portable network simulations of
An installation guide and library documentation are available online at [Read the Docs](http://arbor.readthedocs.io/en/latest/).
[Submit a ticket](https://github.com/arbor-sim/arbor) if you have any questions or want help.
### Citing Arbor
It is possible to cite specific versions of Arbor used to run a simulation via Zenodo:
* Version 0.2: [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2583709.svg)](https://doi.org/10.5281/zenodo.2583709)
* Version 0.1: [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1459679.svg)](https://doi.org/10.5281/zenodo.1459679)
The following BibTeX can be used to cite Arbor:
```
@INPROCEEDINGS{
paper:arbor2019,
author={N. A. {Akar} and B. {Cumming} and V. {Karakasis} and A. {Küsters} and W. {Klijn} and A. {Peyser} and S. {Yates}},
booktitle={2019 27th Euromicro International Conference on Parallel, Distributed and Network-Based Processing (PDP)},
title={{Arbor --- A Morphologically-Detailed Neural Network Simulation Library for Contemporary High-Performance Computing Architectures}},
year={2019}, month={feb}, volume={}, number={},
pages={274--282},
doi={10.1109/EMPDP.2019.8671560},
ISSN={2377-5750}}
```
Alternative citation formats for the paper can be [downloaded here](https://ieeexplore.ieee.org/abstract/document/8671560), and a preprint is available at [arXiv](https://arxiv.org/abs/1901.07454).
......@@ -38,6 +38,36 @@ Some key features include:
* An API for addition of new cell types, e.g. LIF and Poisson spike generators.
* Validation tests against numeric/analytic models and NEURON.
Citing Arbor
------------
.. |DOI-v0.1| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1459679.svg
:target: https://doi.org/10.5281/zenodo.1459679
.. |DOI-v0.2| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.2583709.svg
:target: https://doi.org/10.5281/zenodo.2583709
Specific versions of Arbor can be cited via Zenodo:
* v0.2: |DOI-v0.2|
* v0.1: |DOI-v0.1|
The following BibTeX can be used to cite Arbor:
.. code-block:: latex
@INPROCEEDINGS{
paper:arbor2019,
author={N. A. {Akar} and B. {Cumming} and V. {Karakasis} and A. {Küsters} and W. {Klijn} and A. {Peyser} and S. {Yates}},
booktitle={2019 27th Euromicro International Conference on Parallel, Distributed and Network-Based Processing (PDP)},
title={{Arbor --- A Morphologically-Detailed Neural Network Simulation Library for Contemporary High-Performance Computing Architectures}},
year={2019}, month={feb}, volume={}, number={},
pages={274--282},
doi={10.1109/EMPDP.2019.8671560},
ISSN={2377-5750}}
Alternative citation formats for the paper can be `downloaded here <https://ieeexplore.ieee.org/abstract/document/8671560>`_, and a preprint is available at `arXiv <https://arxiv.org/abs/1901.07454>`_.
.. toctree::
:caption: Getting Stared:
......
Subproject commit 728d5da2e4e8f5fb2c964217d55299d00332e359
Subproject commit a49a812c8821123091166fae1897d702cdc2d627
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment