Skip to content

Commit 5969b00

Browse files
authored
Update documentation landing page with preprint info (#162)
deals with #161
1 parent 25baa5d commit 5969b00

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

docs/source/_templates/index.html

+22-3
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,14 @@ <h1>Deeptime</h1>
1212
compatibility to its tools via ducktyping.
1313
</p>
1414
<p>
15-
Deeptime can be installed via pip (<code class="code docutils literal notranslate"><span class="pre">pip install deeptime</span></code>)
16-
and is also available via conda on conda-forge
17-
(<code class="code docutils literal notranslate"><span class="pre">conda install -c conda-forge deeptime</span></code>).
15+
Deeptime can be installed via conda (<code class="code docutils literal notranslate"><span class="pre">conda
16+
install -c conda-forge deeptime</span></code>) delivering pre-compiled binaries
17+
and is also available via pip
18+
(<code class="code docutils literal notranslate"><span class="pre">pip install deeptime</span></code>),
19+
causing the binaries to be compiled locally.
20+
</p>
21+
<p>
22+
Please note our preprint <a href="https://arxiv.org/abs/2110.15013">https://arxiv.org/abs/2110.15013</a>.
1823
</p>
1924

2025
<div class="section" id="contents">
@@ -72,5 +77,19 @@ <h3>Tools and data</h3>
7277
</div>
7378
</a>
7479
</div>
80+
<div class="section" id="contents">
81+
<h3>Citation</h3>
7582

83+
When using deeptime in your work, please cite the following preprint
84+
<div class="highlight">
85+
<pre>
86+
<code>@article{hoffmann2021deeptime,
87+
title={Deeptime: a Python library for machine learning dynamical models from time series data},
88+
author={Moritz Hoffmann and Martin Scherer and Tim Hempel and Andreas Mardt and Brian de Silva and Brooke E. Husic and Stefan Klus and Hao Wu and Nathan Kutz and Steven L. Brunton and Frank Noé},
89+
year={2021},
90+
journal={arXiv preprint arXiv:2110.15013}
91+
}</code>
92+
</pre>
93+
</div>
94+
</div>
7695
{% endblock %}

0 commit comments

Comments
 (0)