Skip to content

Commit

Permalink
add how to cite to faq
Browse files Browse the repository at this point in the history
  • Loading branch information
ericfell committed Jun 25, 2024
1 parent face866 commit 5350f66
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion docs/source/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,27 @@ More detailed information on how to get started developing rfbzero.py
can be found in
`CONTRIBUTING.md <https://github.com/ericfell/rfbzero/blob/main/CONTRIBUTING.md>`_.

Feel free to reach out via GitHub issues with any questions!
Feel free to reach out via GitHub issues with any questions!

How do I cite rfbzero.py?
~~~~~~~~~~~~~~~~~~~~~~~~~

.. image:: https://joss.theoj.org/papers/10.21105/joss.06537/status.svg
:target: https://doi.org/10.21105/joss.06537

If you use rfbzero.py in published work, please consider citing https://joss.theoj.org/papers/10.21105/joss.06537 as

.. code:: text
@article{Fell2024,
title = {{RFBzero: A Python package for zero-dimensional simulation of redox flow battery cycling}},
author = {Fell, Eric M. and Fell, Jeremy A. and Aziz, Michael J.},
doi = {10.21105/joss.06537},
journal = {Journal of Open Source Software},
publisher = {The Open Journal},
volume = {9},
number = {98},
pages = {6537},
year = {2024},
url = {https://doi.org/10.21105/joss.06537},
}

0 comments on commit 5350f66

Please sign in to comment.