Remove qiskit-aqua from the metapackage (#1361)

* Remove qiskit-aqua from the metapackage The next qiskit-metapackage release will no longer include qiskit-aqua as the deprecation cycle has finished. This commit removes the qiskit-aqua package from the metapackage, deletes the documentation sections for aqua and adds a prelude section for the release notes documenting the removal and manual upgrade steps users might need to do. * Apply suggestions from code review Co-authored-by: Jake Lishman <[email protected]> * Update docs/release_notes.rst Co-authored-by: Jake Lishman <[email protected]>
Qiskit · Dec 2, 2021 · 22c3c9d · 22c3c9d
1 parent de4d940
commit 22c3c9d
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 118 deletions.
diff --git a/README.md b/README.md
@@ -42,7 +42,6 @@ removed in a future release.
 | Build   | Version | Contribute |
 | ---     | ---     | --- |
 | [**Qiskit Ignis**](https://github.com/Qiskit/qiskit-ignis) | [![](https://img.shields.io/github/release/Qiskit/qiskit-ignis.svg?)](https://github.com/Qiskit/qiskit-ignis/releases) | [![](https://img.shields.io/github/forks/Qiskit/qiskit-ignis.svg?)](https://github.com/Qiskit/qiskit-ignis) |
-| [**Qiskit Aqua**](https://github.com/Qiskit/qiskit-aqua) | [![](https://img.shields.io/github/release/Qiskit/qiskit-aqua.svg?)](https://github.com/Qiskit/qiskit-aqua/releases) | [![](https://img.shields.io/github/forks/Qiskit/qiskit-aqua.svg?)](https://github.com/Qiskit/qiskit-aqua) |
 | [**Qiskit IBM Quantum Provider**](https://github.com/Qiskit/qiskit-ibmq-provider)  |  [![](https://img.shields.io/github/release/Qiskit/qiskit-ibmq-provider.svg?)](https://github.com/Qiskit/qiskit-ibmq-provider/releases) | [![](https://img.shields.io/github/forks/Qiskit/qiskit-ibmq-provider.svg?)](https://github.com/Qiskit/qiskit-ibmq-provider) |
 
 ### Optional components

diff --git a/docs/aqua_migration.rst b/docs/aqua_migration.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -199,7 +199,6 @@
 # Refer to https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html
 extlinks = {
     'pull_terra': ('https://github.com/Qiskit/qiskit-terra/pull/%s', '#'),
-    'pull_aqua': ('https://github.com/Qiskit/qiskit-aqua/pull/%s', '#'),
     'pull_aer': ('https://github.com/Qiskit/qiskit-aer/pull/%s', '#'),
     'pull_ignis': ('https://github.com/Qiskit/qiskit-ignis/pull/%s', '#'),
     'pull_ibmq-provider': ('https://github.com/Qiskit/qiskit-ibmq-provider/pull/%s', '#')
@@ -237,7 +236,7 @@
 
 # Elements with api doc sources
 qiskit_elements = ['qiskit-terra', 'qiskit-aer', 'qiskit-ignis',
-                   'qiskit-aqua', 'qiskit-ibmq-provider']
+                   'qiskit-ibmq-provider']
 apidocs_exists = False
 apidocs_master = None
 
@@ -274,12 +273,6 @@ def _git_copy(package, sha1, api_docs_dir):
             dir_util.copy_tree(
                 os.path.join(temp_dir, 'docs', 'apidocs'),
                 api_docs_dir)
-            # Copy over the qiskit-aqua migration guide too
-            if package == 'qiskit-aqua':
-                dir_util.copy_tree(
-                    os.path.join(temp_dir, 'docs', 'tutorials'),
-                    os.path.join(os.path.dirname(api_docs_dir),
-                                 'aqua_tutorials'))
 
     except FileNotFoundError:
         warnings.warn('Copy from git failed for %s at %s, skipping...' %
@@ -330,9 +323,6 @@ def clean_api_source(app, exc):
         shutil.rmtree(api_docs_dir)
         shutil.move(os.path.join(apidocs_master, 'apidoc'), api_docs_dir)
         return
-    shutil.rmtree(
-        os.path.join(os.path.dirname(api_docs_dir),
-                     'aqua_tutorials'))
     shutil.rmtree(api_docs_dir)
 
 

diff --git a/docs/contributing_to_qiskit.rst b/docs/contributing_to_qiskit.rst
@@ -19,7 +19,6 @@ where you can find the individual projects that make up Qiskit, including
 * `Qiskit Terra <https://github.com/Qiskit/qiskit-terra>`__
 * `Qiskit Aer <https://github.com/Qiskit/qiskit-aer>`__
 * `Qiskit Ignis <https://github.com/Qiskit/qiskit-ignis>`__
-* `Qiskit Aqua <https://github.com/Qiskit/qiskit-aqua>`__
 * `Qiskit IBMQ Provider <https://github.com/Qiskit/qiskit-ibmq-provider>`__
 * `Qiskit Tutorials <https://github.com/Qiskit/qiskit-tutorials>`__
 * `Qiskit API Documentation <https://github.com/Qiskit/qiskit/tree/master/docs>`__
@@ -54,7 +53,6 @@ Element                     Issue Tracker
 qiskit-terra                https://github.com/Qiskit/qiskit-terra/issues
 qiskit-aer                  https://github.com/Qiskit/qiskit-aer/issues
 qiskit-ignis                https://github.com/Qiskit/qiskit-ignis/issues
-qiskit-aqua                 https://github.com/Qiskit/qiskit-aqua/issues
 Docs or Qiskit Meta-package https://github.com/Qiskit/qiskit/issues
 =========================== =============================================
 
@@ -143,7 +141,6 @@ Element                     Pull Requests
 qiskit-terra                https://github.com/Qiskit/qiskit-terra/pulls
 qiskit-aer                  https://github.com/Qiskit/qiskit-aer/pulls
 qiskit-ignis                https://github.com/Qiskit/qiskit-ignis/pulls
-qiskit-aqua                 https://github.com/Qiskit/qiskit-aqua/pulls
 Docs or Qiskit Meta-package https://github.com/Qiskit/qiskit/pulls
 =========================== =============================================
 
@@ -656,7 +653,6 @@ prevent installing versions of elements that may be lower than those desired if
 #. :ref:`qiskit-terra <install-qiskit-terra>`
 #. :ref:`qiskit-aer <install-qiskit-aer>`
 #. :ref:`qiskit-ignis <install-qiskit-ignis>`
-#. :ref:`qiskit-aqua <install-qiskit-aqua>`
 #. :ref:`qiskit-ibmq-provider <install-qiskit-ibmq-provider>`
    (if you want to connect to the IBM Quantum devices or online
    simulator)
@@ -1082,44 +1078,6 @@ Installing Ignis from Source
 If you want to install it in editable mode, meaning that code changes to the
 project don't require a reinstall to be applied:
 
-.. code:: sh
-
-    pip install -e .
-
-.. _install-qiskit-aqua:
-
-Installing Aqua from Source
-===========================
-
-1. Clone the Aqua repository.
-
-   .. code:: sh
-
-      git clone https://github.com/Qiskit/qiskit-aqua.git
-
-2. Cloning the repository creates a local directory called ``qiskit-aqua``.
-
-   .. code:: sh
-
-      cd qiskit-aqua
-
-3. If you want to run tests or linting checks, install the developer requirements.
-   This is not required to install or use the qiskit-aqua package when installing
-   from source.
-
-   .. code:: sh
-
-      pip install -r requirements-dev.txt
-
-4. Install Aqua.
-
-   .. code:: sh
-
-      pip install .
-
-If you want to install it in editable mode, meaning that code changes to the
-project don't require a reinstall to be applied:
-
 .. code:: sh
 
     pip install -e .

diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -131,7 +131,6 @@ Installation
    #. :ref:`qiskit-terra <install-qiskit-terra>`
    #. :ref:`qiskit-aer <install-qiskit-aer>`
    #. :ref:`qiskit-ignis <install-qiskit-ignis>`
-   #. :ref:`qiskit-aqua <install-qiskit-aqua>`
    #. :ref:`qiskit-ibmq-provider <install-qiskit-ibmq-provider>`
       (if you want to connect to the IBM Quantum devices or online
       simulator)
@@ -515,45 +514,6 @@ Installation
    If you want to install it in editable mode, meaning that code changes to the
    project don't require a reinstall to be applied:
 
-   .. code:: sh
-
-      pip install -e .
-
-   .. _install-qiskit-aqua:
-
-   .. raw:: html
-
-      <h2>Installing Aqua from Source</h2>
-
-   1. Clone the Aqua repository.
-
-      .. code:: sh
-
-         git clone https://github.com/Qiskit/qiskit-aqua.git
-
-   2. Cloning the repository creates a local directory called ``qiskit-aqua``.
-
-      .. code:: sh
-
-         cd qiskit-aqua
-
-   3. If you want to run tests or linting checks, install the developer requirements.
-      This is not required to install or use the qiskit-aqua package when installing
-      from source.
-
-      .. code:: sh
-
-         pip install -r requirements-dev.txt
-
-   4. Install Aqua.
-
-      .. code:: sh
-
-         pip install .
-
-   If you want to install it in editable mode, meaning that code changes to the
-   project don't require a reinstall to be applied:
-
    .. code:: sh
 
       pip install -e .

diff --git a/docs/index.rst b/docs/index.rst
@@ -133,16 +133,8 @@ Interested in quantum hardware design?
   Qiskit Terra <apidoc/terra>
   Qiskit Aer <apidoc/aer>
   Qiskit Ignis (deprecated) <apidoc/ignis>
-  Qiskit Aqua (deprecated) <apidoc/aqua>
   Qiskit IBM Quantum Provider <apidoc/ibmq-provider>
 
-.. toctree::
-  :maxdepth: 1
-  :caption: Qiskit Aqua Migration Guide
-  :hidden:
-
-  Qiskit Aqua Migration Guide <aqua_migration>
-
 .. toctree::
   :maxdepth: 1
   :caption: Troubleshooting

diff --git a/docs/release_notes.rst b/docs/release_notes.rst
@@ -21,6 +21,34 @@ This table tracks the meta-package versions and the version of each Qiskit eleme
 Notable Changes
 ###############
 
+*************
+Qiskit 0.33.0
+*************
+
+This release officially marks the end of support for the Qiskit Aqua project
+from Qiskit. It was originally deprecated in the 0.25.0 release and as was documented
+in that release the ``qiskit-aqua`` package has been removed from the Qiskit
+metapackage, which means in that future release ``pip install qiskit`` will no
+longer include ``qiskit-aqua``. However, note because of limitations in python
+packaging we cannot automatically remove a pre-existing install of ``qiskit-aqua``.
+If you are upgrading from a previous version it's recommended that you manually
+uninstall Qiskit Aqua with ``pip uninstall qiskit-aqua`` or install the metapackage
+in a fresh python environment.
+
+The application modules that are provided by ``qiskit-aqua`` have been split into
+several new packages:
+``qiskit-optimization``, ``qiskit-nature``, ``qiskit-machine-learning``, and
+``qiskit-finance``. These packages can be installed by themselves (via the
+standard pip install command, e.g. ``pip install qiskit-nature``) or with the
+rest of the Qiskit metapackage as optional extras (e.g.
+``pip install 'qiskit[finance,optimization]'`` or ``pip install 'qiskit[all]'``).
+The core algorithms and the operator flow now exist as part of Qiskit Terra at
+``qiskit.algorithms`` and ``qiskit.opflow``. Depending on your existing
+usage of Aqua you should either use the application packages or the new modules
+in Qiskit Terra. For more details on how to migrate from Qiskit Aqua you can
+refer to the
+`Aqua Migration Guide <https://github.com/Qiskit/qiskit-aqua/blob/main/docs/tutorials/Qiskit%20Algorithms%20Migration%20Guide.ipynb>`__.
+
 *************
 Qiskit 0.32.1
 *************

diff --git a/setup.py b/setup.py
@@ -30,7 +30,6 @@
     "qiskit-aer==0.9.1",
     "qiskit-ibmq-provider==0.18.1",
     "qiskit-ignis==0.6.0",
-    "qiskit-aqua==0.9.5",
 ]