Skip to content

Commit

Permalink
add citation to readme and docs (#17)
Browse files Browse the repository at this point in the history
docs: add citation to readme and docs
  • Loading branch information
12rambau authored Feb 7, 2023
2 parents d15d488 + f0a7367 commit 141036c
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ qutree
:alt: Black badge

.. image:: https://img.shields.io/pypi/v/qutree?color=orange&logo=python&logoColor=white
:target: https://pypi.org/project/qutree
:target: https://pypi.org/project/qutree
:alt: PyPI

.. image:: https://img.shields.io/github/actions/workflow/status/alice4space/qutree/unit.yml?logo=github&logoColor=white
Expand Down Expand Up @@ -67,12 +67,23 @@ install with pip:
pip install qutree
And you will be able to produce this type of Bloch sphere's tree:
And you will be able to produce this type of Bloch sphere's tree:

.. image:: https://raw.githubusercontent.com/alice4space/qutree/main/docs/source/_static/example.png
:alt: example tree

More information can be found in our `documentation <https://pyqutree.readthedocs.io/en/latest/>`__.
More information can be found in our `documentation <https://pyqutree.readthedocs.io/en/latest/>`__.

Citing
------

If you find qutree useful in your research, please consider citing the following papers to support our work. Thank you for your support.

- Barthe, A., Grossi, M., Tura, J., and Dunjko, V.. (2023). Bloch Sphere Binary Trees: A method for the visualization of sets of multi-qubit systems pure states.
https://doi.org/10.48550/arXiv.2302.02957

Contribute
----------

If you want to contribute you can fork the project in your own repository and then use it. If you consider working with us, please follow the `contributing guidelines <https://pyqutree.readthedocs.io/en/latest/contribute.html>`__.

Expand Down

0 comments on commit 141036c

Please sign in to comment.