From eeb01bcaab61961b137ba5dc70a2f4ab9b6f97bf Mon Sep 17 00:00:00 2001
From: Brent Huisman <brenthuisman@users.noreply.github.com>
Date: Mon, 12 Apr 2021 12:21:29 +0200
Subject: [PATCH] Update citation section (#1481)
* Add Zenodo citation snippet.
* Correct Nora's last name, which is Abi Akar.
* Small css fix for change in docutils, see: https://github.com/readthedocs/sphinx_rtd_theme/issues/1115
Fixes #1297.
---
doc/index.rst | 79 +++++++++++++-----
.../divio_docs_theme/static/css/divio.css | 2 +-
.../divio_docs_theme/static/favicon.ico | Bin 7406 -> 0 bytes
.../divio_docs_theme/static/favicon.png | Bin 1039 -> 0 bytes
4 files changed, 57 insertions(+), 24 deletions(-)
delete mode 100644 doc/scripts/divio_docs_theme/static/favicon.ico
delete mode 100644 doc/scripts/divio_docs_theme/static/favicon.png
diff --git a/doc/index.rst b/doc/index.rst
index a181dd52..37d5b085 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -33,17 +33,64 @@ Documentation organisation
Citing Arbor
------------
-The Arbor software can be cited via Zenodo: |zlatest|
+The Arbor software can be cited by version via Zenodo or via Arbors introductory paper.
+
+Latest version
+ |zlatest|
+
+Version 0.5
+ |z05|
+
+ .. code-block:: latex
+
+ @software{nora_abi_akar_2021_4428108,
+ author = {Nora {Abi Akar} and
+ John Biddiscombe and
+ Benjamin Cumming and
+ Felix Huber and
+ Marko Kabic and
+ Vasileios Karakasis and
+ Wouter Klijn and
+ Anne Küsters and
+ Alexander Peyser and
+ Stuart Yates and
+ Thorsten Hater and
+ Brent Huisman and
+ Sebastian Schmitt},
+ title = {arbor-sim/arbor: Arbor Library v0.5},
+ month = jan,
+ year = 2021,
+ publisher = {Zenodo},
+ version = {v0.5},
+ doi = {10.5281/zenodo.4428108},
+ url = {https://doi.org/10.5281/zenodo.4428108}
+ }
+
+Version 0.2
+ |z02|
+
+Version 0.1
+ |z01|
+
+Introductory paper
+ .. code-block:: latex
+
+ @INPROCEEDINGS{
+ paper:arbor2019,
+ author={N. {Abi 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>`_.
+
.. |zlatest| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1459678.svg
:target: https://doi.org/10.5281/zenodo.1459678
-Previous versions of Arbor can be cited specifically:
-
-* Version 0.5: |z05|
-* Version 0.2: |z02|
-* Version 0.1: |z01|
-
.. |z05| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4428108.svg
:target: https://doi.org/10.5281/zenodo.4428108
@@ -53,22 +100,6 @@ Previous versions of Arbor can be cited specifically:
.. |z01| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1459679.svg
:target: https://doi.org/10.5281/zenodo.1459679
-The following BibTeX entry can be used to cite the Arbor introductory paper:
-
-.. 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>`_.
-
Acknowledgements
----------------
@@ -78,6 +109,8 @@ No. 785907 (Human Brain Project SGA2), and Specific Grant Agreement No. 945539 (
Arbor is an `eBrains project <https://ebrains.eu/service/arbor/>`_.
+A full list of our software attributions can be found `here <https://github.com/arbor-sim/arbor/blob/master/ATTRIBUTIONS.md>`_.
+
.. toctree::
:caption: Get started:
:maxdepth: 1
diff --git a/doc/scripts/divio_docs_theme/static/css/divio.css b/doc/scripts/divio_docs_theme/static/css/divio.css
index 2548d517..20d9f535 100644
--- a/doc/scripts/divio_docs_theme/static/css/divio.css
+++ b/doc/scripts/divio_docs_theme/static/css/divio.css
@@ -4103,7 +4103,7 @@ div[class^='highlight'] pre {
.wy-menu-vertical {
width: 300px; }
-.wy-menu-vertical header, .wy-menu-vertical p.caption {
+.wy-menu-vertical header, .wy-menu-vertical p.caption, .wy-menu-vertical p {
height: 32px;
display: inline-block;
line-height: 32px;
diff --git a/doc/scripts/divio_docs_theme/static/favicon.ico b/doc/scripts/divio_docs_theme/static/favicon.ico
deleted file mode 100644
index 92682f005a8cba5d994fbf05645c2100c9340f77..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001
literal 7406
zcmeHLS!^3s6upj}c*$lb&K^5<;>1~;#IX~{X_lrG62vBf#1BY_O#&n&1Yi6i5Pu*L
ze1gOeLIQpeKS*8DLPKcFmM(-v5Y&c1QAty(l&1UTTt9m}j_ri<(`}A4nKyIKyYuGG
z%<;J)GLe~_PQu<sPZkozh{)$t$M4&S-od$WIC)$~G=Z%h984k567#T=K^n<1?<^ob
z`~dOg3&h)q`0Ve*-)tqG2@o&7P0WngdEy=5?P(;Qdjy<C;?HV`&!50~6XNHH_lAg%
ze*{hg@u~g9Uj&Kw4-kKiTo+Ce?+X+E@D%ZM6Xq>p9<KG}5b?!-h^Oq}_Jj8~@ybEs
zuSSWNKLzhE;!DW=)3e~62G2(P=ZD}%iFcZbkG%)pZshcUcb0fNavpshYi|SZ1LDv9
z>H9TCMg@!tWL3bs5u9EAB)WQ{UT<`;G8}G8Al%!E<BFioQ);nTN-aKHz#WZNcwDC9
zMxd|3Ue_$gkwSA6FgJD9)u?0S!OXnJwV8Z-Nl`U0&{5FRjrl=aokvjKZmTNuM*FO>
zSSW#5f4$^&r0&t-O<YIL<wuJAfA^xZK5XOIM4uC|s9oZ3N@qo5cRPs>-A}x$7&`SD
zwDd9J?;avvJqn%N488Ix9o_+L+uK9D@FwxMw?o^`C~cm95py0TK5(zn<$V!o<TCN>
zUEp^sonCk&t<$2>d>Pu?2aQDTKi(z&^=0Du7nC-OE{i6M7N0u?oqbMe@sU??jeDT6
z7Nx(Uy+>Zb`kJB9CzbB59KiK1L90iU{)+a_J+8F(AlA3KKzwo<{AFD+jG<A1o3jGJ
z>l5*KJhkw6Usq`s>RZapNk%-@>&}7l=%C7wC+>FpI}-#IAG7K((kcn71BolBcyog<
z4ZCd=aYslO?{H$t8k|ECuhhqrt4*$nyf<4svp#KW>tiWtN~5ZvAMv^xUH!_(A{xdb
zJqWwoYjtrsk%@tDx9<67#!&nbmq|T~pr@#?Vl5hnHx(zt!Jzh7GX`4tnjTzj)f1nB
z7Lgvtruh^*4pK<@6zK!eH}UB?)z69dm_aZ1J-mwadWRpx@BT&Q8>CN^zE1kD`Iq2p
z9K`b5FFr%O!SRn(KRN9s{`q<3dsYsCb055ri}=KL_>8-i$JkY(dcMWCRIewVXv(Vk
z%`?Bin>>RxJVCtl3H%50OW!CSLwtvL5a}If?@)e6`qb6mkbeqstXcX=@jBvt#1o0H
znY~kasF_yPkBTSy@oD(23FV{2i-{*%+NSzc=_%op3>X!-kt;B1;2NlaYH0KSU9-fh
zK+!q~)RokP^fN+@TZY#Ijka$Z(oNWik6b;~E$IpWfj?|<Tp543pj4ZX%J1)L&O#&>
zR=2jrsoismZ#LbM1=DRlkD9PKi|?}LdIH``#c#{vcUZM0>IR{*E98$EeD!|jsi#q&
z<oBDWK7;w*A6I{__c`8_kKZuRorMA0trdzN%zFPR^`AoBzSFMQ!~Wtdeln7K*Ho{4
zL#gjKH&LB+k89~CH|B?Hdv)JxXgsoY9k^Sg)uwcIEXzAlxDH18%0n6S$;n)GPoL9n
R)EHd#3f#!v?s~Yle*q(6n4bUu
diff --git a/doc/scripts/divio_docs_theme/static/favicon.png b/doc/scripts/divio_docs_theme/static/favicon.png
deleted file mode 100644
index d397a5aa0a4a813f0e1604781315c50650b30077..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001
literal 1039
zcmZXRc}$ZB0L4GcF>X*19E_!aI1d)&n8PmU$2Hs8LN!crf`Zg=ZP`Q?9Gwi9;$TKA
zPFZkF21WvG3>I|CQJ|bcfv(D#a#!xNg%*0fLH6ff@{YWJf0^u{<K`xICIms4Gw1=Q
zHk-F)BfZTO{k$WKAhrqE%#c8$8k_Qb2{S(SHX~~k6G}KVLal>Dfs-Pn3_+uVN{4|p
ztZCrdig^__v@oj0x)xd;jB9aa5Mi(JY#!rESl8p41am5Qy#!l?cLZ>5f=vV3S76%!
zgBtuXg9j6ku7ke_lUguExHXEm1xS{_f)Cy}Mih80N3ImXA~-ferbgQ`MwD=BLf9)v
z*1+gO{v?7#7*Zgn4=&B<UB!FNxH*E0J$O8Y)FEVypmYXr)?rnLCsWV?+2de|5ZH-?
z0nocZsm4(u_B7-E1bl_?+x!Rd*BlmAAcdG*hhq~0I^ouaT@83B#c44*W#IIpaS3(;
z%xvJ3ZhSQWxdvS_go>fmqGcJ8J+Q39#5&4m;L(PPS<I@?u>#&0C^aaa##^=cM-F=d
zrZ*7RhkY$D;bU11_cpAkQMU-93cpD4VLMFu@NUO~3YBwM)qvK4gRQWr!$%z$R$yB-
z^lCtBN8!Do=LA79Vg&exTs=SE)n}ecnvoS|DS5+czR>EiCV$G<_1G47g80l|)==wE
znpyN`c6Uzl2f`Cy6fnmUS+=d=Aw@ai>VC%iSpsi<65H1&b(May#;BjWRI423F73U|
zOw7ORk~FG+HR3{q=fKqPvP&6uYBCOPJa}_L*Ebp7)6rP^f>JC$A~@|wVZ<i(w){q(
zs<N}IAjJ>Owp-Kfw2rPkuiUtDQv8jDVYYMOb%X4v*h9R+^m4MrdpA9ZQ%@$XCFkGi
z{dQqCJJTlmFk5<~lI&dII0aWOJoPtE_;NO_s)}{K`8#g%eJc0SyZgSTGC#h#-zA2$
z^orT_#9nrQe3szD9y>;S+7gmqAW8GEkD$668y1XT(7$N){q82Jq5BWMX8)g=`w#J=
z?MwqMd9tawdH3k?R@$@WrKBQ|#r}zT>Fj~0440TdOY5+6-LJ|x@!aS$CGy3Yw9nNI
zl%W!*phv=9_4ddGMMYGa0gVxrCMmjZK;!OYQ=O^hq-{=UerbF<<=O~Gf5-IUd0RU5
zOuZYAysdstP<-|ry*r#UbSJo5U(X|D@b4sRB9clJ`2OCQ&Jycen|9l-9H-qdSP}mk
zc{jDW=88~y<W^j)EJt1(m8Y>$QuAm(7P43lIjjDcOQ5Ck|3mE7zc%xNlW{I|i#H=M
KD4@(QBK==6DOyzk
--
GitLab