From 7b7903dbc5f5fcebebafe3f55dc36287f598b5a0 Mon Sep 17 00:00:00 2001 From: Daniel Puzzuoli Date: Mon, 16 Sep 2024 15:54:37 -0700 Subject: [PATCH] Update docs build artifact version (#361) * updating docs build artifact version * updating references/links to qiskit community --- .github/workflows/docs_stable.yml | 2 +- .github/workflows/main.yml | 2 +- CONTRIBUTING.md | 2 +- README.md | 16 ++++++++-------- docs/conf.py | 4 ++-- docs/index.rst | 2 +- .../how_to_use_different_array_libraries.rst | 6 +++--- qiskit_dynamics/arraylias/__init__.py | 4 ++-- setup.py | 8 ++++---- 9 files changed, 23 insertions(+), 23 deletions(-) diff --git a/.github/workflows/docs_stable.yml b/.github/workflows/docs_stable.yml index dafe48456..ffbd1af62 100644 --- a/.github/workflows/docs_stable.yml +++ b/.github/workflows/docs_stable.yml @@ -7,7 +7,7 @@ on: jobs: deploy: - if: github.repository_owner == 'Qiskit-Extensions' + if: github.repository_owner == 'Qiskit-Community' runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index bcb50a0b1..19e0268be 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -83,7 +83,7 @@ jobs: sudo apt-get install graphviz pandoc - name: Build Docs run: tox -edocs - - uses: actions/upload-artifact@v2 + - uses: actions/upload-artifact@v4 with: name: html_docs path: docs/_build/html diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 62a4ee5e4..de0935b1b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -152,7 +152,7 @@ as: fixes: - | Fixes a race condition in the function ``foo()``. Refer to - `#12345 ` for more + `#12345 ` for more details. ``` diff --git a/README.md b/README.md index d62a7abe7..02524de6b 100644 --- a/README.md +++ b/README.md @@ -20,11 +20,11 @@ automatic differentiation, and GPU execution, and therefore is well-suited to ta repeated evaluation of functions with different parameters; E.g. simulating a model of a quantum system over a range of parameter values, or optimizing the parameters of control sequence. -Reference documentation may be found [here](https://qiskit-extensions.github.io/qiskit-dynamics/), including -[tutorials](https://qiskit-extensions.github.io/qiskit-dynamics/tutorials/index.html), -[user guide](https://qiskit-extensions.github.io/qiskit-dynamics/userguide/index.html), -[API reference](https://qiskit-extensions.github.io/qiskit-dynamics/apidocs/index.html), and -[Discussions](https://qiskit-extensions.github.io/qiskit-dynamics/discussions/index.html). +Reference documentation may be found [here](https://qiskit-community.github.io/qiskit-dynamics/), including +[tutorials](https://qiskit-community.github.io/qiskit-dynamics/tutorials/index.html), +[user guide](https://qiskit-community.github.io/qiskit-dynamics/userguide/index.html), +[API reference](https://qiskit-community.github.io/qiskit-dynamics/apidocs/index.html), and +[Discussions](https://qiskit-community.github.io/qiskit-dynamics/discussions/index.html). ## Installation @@ -51,7 +51,7 @@ If you'd like to contribute to Qiskit Dynamics, please take a look at our [contribution guidelines](CONTRIBUTING.md). This project adheres to Qiskit's [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. -We use [GitHub issues](https://github.com/Qiskit-Extensions/qiskit-dynamics/issues) for tracking +We use [GitHub issues](https://github.com/Qiskit-Community/qiskit-dynamics/issues) for tracking requests and bugs. Please [join the Qiskit Slack community](https://qisk.it/join-slack) and use our [#qiskit-dynamics](https://qiskit.slack.com/archives/C03E7UVCDEV) channel for discussion and simple questions. For questions that are more suited for a forum we use the Qiskit tag in the @@ -60,10 +60,10 @@ questions. For questions that are more suited for a forum we use the Qiskit tag ## Authors and Citation Qiskit Dynamics is the work of -[many people](https://github.com/Qiskit-Extensions/qiskit-dynamics/graphs/contributors) who +[many people](https://github.com/Qiskit-Community/qiskit-dynamics/graphs/contributors) who 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). +[BibTeX file](https://github.com/Qiskit-Community/qiskit-dynamics/blob/main/CITATION.bib). ## License diff --git a/docs/conf.py b/docs/conf.py index c252a3dfe..439fb1b58 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -67,8 +67,8 @@ autoclass_content = "both" intersphinx_mapping = { "qiskit": ("https://docs.quantum.ibm.com/api/qiskit", None), - "qiskit_experiments": ("https://qiskit-extensions.github.io/qiskit-experiments/", None), - "arraylias": ("https://qiskit-extensions.github.io/arraylias/", None) + "qiskit_experiments": ("https://qiskit-community.github.io/qiskit-experiments/", None), + "arraylias": ("https://qiskit-community.github.io/arraylias/", None) } # nbsphinx options (for tutorials) diff --git a/docs/index.rst b/docs/index.rst index b9cb37812..99c8e1ae0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,7 +20,7 @@ just-in-time compilation, automatic differentiation, and GPU execution of Qiskit This package is still in the early stages of development and it is very likely that there will be breaking API changes in future releases. If you encounter any bugs please open an issue on - `Github `_ + `Github `_ .. toctree:: diff --git a/docs/userguide/how_to_use_different_array_libraries.rst b/docs/userguide/how_to_use_different_array_libraries.rst index 6b8f1c786..e125f032b 100644 --- a/docs/userguide/how_to_use_different_array_libraries.rst +++ b/docs/userguide/how_to_use_different_array_libraries.rst @@ -8,7 +8,7 @@ and types. A user can choose to use either NumPy or JAX to define their models, Qiskit Dynamics will execute as if the array operations had been natively written in either library. Additionally, a user can specify that the operators in a model be stored in sparse types offered by SciPy or JAX (see :ref:`configuring simulations for performance `). -Internally, Qiskit Dynamics utilizes `Arraylias `_ +Internally, Qiskit Dynamics utilizes `Arraylias `_ to dispatch computations on different array types to the appropriate library function. This guide addresses the following topics: @@ -78,7 +78,7 @@ JAX transformations can be applied to ``signal_jax``, e.g. just-in-time compilat ------------------------------------------------------------------- Internally, Qiskit Dynamics uses an extension of the default NumPy and SciPy array libraries offered -by `Arraylias `_. These can be imported as: +by `Arraylias `_. These can be imported as: .. jupyter-execute:: @@ -90,7 +90,7 @@ by `Arraylias `_. These can be i from qiskit_dynamics import DYNAMICS_SCIPY_ALIAS from qiskit_dynamics import DYNAMICS_SCIPY -See the `Arraylias documentation `_ for how the +See the `Arraylias documentation `_ for how the general library aliasing framework works, as well as the Qiskit Dynamics submodule :mod:`.arraylias` for a description of how the default NumPy and SciPy aliases have been extended for use in this package. diff --git a/qiskit_dynamics/arraylias/__init__.py b/qiskit_dynamics/arraylias/__init__.py index 3aedfe27c..fd0925bec 100644 --- a/qiskit_dynamics/arraylias/__init__.py +++ b/qiskit_dynamics/arraylias/__init__.py @@ -20,9 +20,9 @@ .. currentmodule:: qiskit_dynamics.arraylias This module contains Qiskit Dynamics-global extensions of the default NumPy and SciPy aliases -provided by `Arraylias `_. These are used to manage +provided by `Arraylias `_. These are used to manage dispatching of array operations for the different array types supported by Qiskit Dynamics. They -have been configured beyond the `Arraylias `_ +have been configured beyond the `Arraylias `_ defaults to additionally support both `JAX `_ and SciPy sparse types. The following table summarizes the registered libraries and respective types. diff --git a/setup.py b/setup.py index 671765654..c0f325657 100644 --- a/setup.py +++ b/setup.py @@ -48,7 +48,7 @@ description="Qiskit ODE solver", long_description=README, long_description_content_type='text/markdown', - url="https://github.com/Qiskit-Extensions/qiskit-dynamics", + url="https://github.com/Qiskit-Community/qiskit-dynamics", author="Qiskit Development Team", author_email="qiskit@us.ibm.com", license="Apache 2.0", @@ -69,9 +69,9 @@ ], keywords="qiskit sdk quantum", project_urls={ - "Bug Tracker": "https://github.com/Qiskit-Extensions/qiskit-dynamics/issues", - "Source Code": "https://github.com/Qiskit-Extensions/qiskit-dynamics", - "Documentation": "https://qiskit-extensions.github.io/qiskit-dynamics/", + "Bug Tracker": "https://github.com/Qiskit-Community/qiskit-dynamics/issues", + "Source Code": "https://github.com/Qiskit-Community/qiskit-dynamics", + "Documentation": "https://qiskit-community.github.io/qiskit-dynamics/", }, install_requires=requirements, include_package_data=True,