diff --git a/CITATION.bib b/CITATION.bib index 934523e67..37f5e3fe4 100644 --- a/CITATION.bib +++ b/CITATION.bib @@ -1,8 +1,12 @@ -@misc{qiskit_dynamics_2021, - author = {Egger, Daniel J. and Hincks, Ian and Landa, Haggai and Malekakhlagh, Moein and Parr, Avery and Puzzuoli, Daniel and Rosand, Benjamin and Rupesh, R. K. and Treinish, Matthew and Ueda, Kento and Wood, Christopher J.}, - title = {Qiskit Dynamics}, - year = {2021}, - publisher = {GitHub}, - journal = {GitHub repository}, - url = {https://github.com/Qiskit-Extensions/qiskit-dynamics} -} +@article{qiskit_dynamics_2023, + title = {Qiskit {Dynamics}: {A} {Python} package for simulating the time dynamics of quantum systems}, + volume = {8}, + issn = {2475-9066}, + url = {https://joss.theoj.org/papers/10.21105/joss.05853}, + doi = {10.21105/joss.05853}, + number = {90}, + journal = {Journal of Open Source Software}, + author = {Puzzuoli, Daniel and Wood, Christopher J. and Egger, Daniel J. and Rosand, Benjamin and Ueda, Kento}, + year = {2023}, + pages = {5853} +} \ No newline at end of file diff --git a/README.md b/README.md index e0f424a29..ad92a3daf 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # Qiskit Dynamics [![License](https://img.shields.io/github/license/Qiskit/qiskit-dynamics.svg?style=popout-square)](https://opensource.org/licenses/Apache-2.0) +[![DOI](https://joss.theoj.org/papers/10.21105/joss.05853/status.svg)](https://doi.org/10.21105/joss.05853) **This repo is still in the early stages of development, there will be breaking API changes** @@ -60,7 +61,8 @@ questions. For questions that are more suited for a forum we use the Qiskit tag Qiskit Dynamics is the work of [many people](https://github.com/Qiskit-Extensions/qiskit-dynamics/graphs/contributors) who -contribute to the project at different levels. If you use Qiskit, please cite as per the included +contribute to the project at different levels. If you use Qiskit Dynamics, please cite our +[paper](https://joss.theoj.org/papers/10.21105/joss.05853) as per the included [BibTeX file](https://github.com/Qiskit-Extensions/qiskit-dynamics/blob/main/CITATION.bib). ## License diff --git a/docs/conf.py b/docs/conf.py index 5a9f23f3d..a96bf7418 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -54,15 +54,9 @@ bibtex_footbibliography_header = bibtex_bibliography_header # html theme options -html_theme = 'qiskit_sphinx_theme' +html_theme = 'qiskit-ecosystem' html_last_updated_fmt = '%Y/%m/%d' -html_theme_options = { - 'logo_only': True, - 'display_version': True, - 'prev_next_buttons_location': 'bottom', - 'style_external_links': True, -} -html_css_files = ['gallery.css'] + html_context = {"analytics_enabled": True} # autodoc/autosummary options diff --git a/requirements-dev.txt b/requirements-dev.txt index cdfea3f16..d70531cb4 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -2,7 +2,7 @@ stestr>=3.0.0 astroid==2.9.3 pylint==2.12.2 black~=22.0 -qiskit-sphinx-theme~=1.12.0 +qiskit-sphinx-theme~=1.16.0 sphinx-autodoc-typehints jupyter-sphinx # The following line is needed until diff --git a/tox.ini b/tox.ini index d1f480f9f..b81ffb106 100644 --- a/tox.ini +++ b/tox.ini @@ -43,7 +43,7 @@ deps = jaxlib diffrax commands = - sphinx-build -j auto -b html -W {posargs} docs/ docs/_build/html + sphinx-build -j auto -W -T --keep-going {posargs} docs/ docs/_build/html [testenv:docs-clean] skip_install = true