Skip to content

Commit a8c45e7

Browse files
authored
Add JOSS paper link to README
1 parent 221c7df commit a8c45e7

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

README.rst

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
PySensors
22
=========
3-
|Build| |RTD| |PyPI| |Codecov| |Binder| |Zenodo|
3+
|Build| |RTD| |PyPI| |Codecov| |Binder| |JOSS| |Zenodo|
44

55
**PySensors** is a Scikit-learn style Python package for the sparse placement of sensors, either for reconstruction or classification tasks.
66

@@ -192,6 +192,34 @@ Reporting issues or bugs
192192
^^^^^^^^^^^^^^^^^^^^^^^^
193193
If you find a bug in the code or want to request a new feature, please open an issue.
194194

195+
Citing PySensors
196+
----------------
197+
We have published a short paper in the Journal of Open Source Software (JOSS). You can find the paper [here](https://joss.theoj.org/papers/10.21105/joss.02828).
198+
199+
If you use PySensors in your work, please consider citing it using:
200+
201+
.. code-block:: text
202+
203+
de Silva et al., (2021). PySensors: A Python package for sparse sensor placement. Journal of Open Source Software, 6(58), 2828, https://doi.org/10.21105/joss.02828``
204+
205+
Bibtex:
206+
207+
.. code-block:: text
208+
209+
@article{de Silva2021,
210+
doi = {10.21105/joss.02828},
211+
url = {https://doi.org/10.21105/joss.02828},
212+
year = {2021},
213+
publisher = {The Open Journal},
214+
volume = {6},
215+
number = {58},
216+
pages = {2828},
217+
author = {Brian M. de Silva and Krithika Manohar and Emily Clark and Bingni W. Brunton and J. Nathan Kutz and Steven L. Brunton},
218+
title = {PySensors: A Python package for sparse sensor placement},
219+
journal = {Journal of Open Source Software}
220+
}
221+
222+
195223
References
196224
------------
197225
- Manohar, Krithika, Bingni W. Brunton, J. Nathan Kutz, and Steven L. Brunton.
@@ -225,6 +253,9 @@ References
225253

226254
.. |Binder| image:: https://mybinder.org/badge_logo.svg
227255
:target: https://mybinder.org/v2/gh/dynamicslab/pysensors/master
256+
257+
.. |JOSS| image:: https://joss.theoj.org/papers/10.21105/joss.02828/status.svg
258+
:target: https://doi.org/10.21105/joss.02828
228259

229260
.. |Zenodo| image:: https://zenodo.org/badge/260577702.svg
230261
:target: https://zenodo.org/badge/latestdoi/260577702

0 commit comments

Comments
 (0)