Skip to content

Commit

Permalink
[docs] add citation instructions to website
Browse files Browse the repository at this point in the history
  • Loading branch information
faymanns committed Aug 29, 2024
1 parent e8ef2bf commit 453ce30
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 1 deletion.
24 changes: 24 additions & 0 deletions docs/getting_started/citation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Citing splinebox
================

If you use splinebox in the context of scientific publication, please cite it as follows.
Note, that you will have to fill in the version yourself. If you are unsure what version you are running,
you can find out by running

.. code-block:: python
import splinebox
print(splinbox.__version__)
BibTeX:

.. code-block::
@misc{splinebox,
author = {Aymanns, Florian and Andò, Edward and Uhlmann, Virginie},
title = {{S}pline{B}ox},
url = {https://pypi.org/project/splinebox/},
doi = {10.5281/zenodo.13358354},
note = {{V}ersion V.V.Vb1},
year = 2024,
}
1 change: 1 addition & 0 deletions docs/getting_started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Getting Started
:hidden:

padding.rst
citation.rst

Installation
------------
Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started/padding.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ By padding with two additional points on the circle, this behavior is corrected.
When you directly set control points for a spline, you must handle the padding yourself.
This design choice allows full control over the spline's behavior at the ends.

.. code-block::
.. code-block:: python
spline = splinebox.Spline(M=5, basis_function=splinebox.B3(), closed=False)
spline.control_points = np.random.rand((7, ndim))
Expand Down

0 comments on commit 453ce30

Please sign in to comment.