Metadata-Version: 2.1
Name: iqm-qaoa
Version: 1.13.0
Summary: Set up and run QAOA experiments
Author-email: IQM Finland Oy <developers@meetiqm.com>
License: Copyright (c) 2024-2025 IQM Quantum Computers
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
        * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
        * Neither the name of IQM Quantum Computers nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
        
        NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Project-URL: Documentation, https://docs.meetiqm.com/iqm-qaoa/
Project-URL: Homepage, https://pypi.org/project/iqm-qaoa/
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Intended Audience :: Science/Research
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
License-File: AUTHORS.rst
Requires-Dist: iqm-client[qiskit]<30,>=29
Requires-Dist: iqm-client<30,>=29
Requires-Dist: iqm-station-control-client<10,>=9
Requires-Dist: iqm-exa-common<27,>=26
Requires-Dist: cvxpy>=1.5.3
Requires-Dist: dimod>=0.12.17
Requires-Dist: matplotlib>=3.9.0
Requires-Dist: networkx>=3.3
Requires-Dist: types-networkx
Requires-Dist: numpy>=1.24.0
Requires-Dist: qiskit>=1.2.4
Requires-Dist: qiskit_aer>=0.14.2
Requires-Dist: quimb>=1.8.4
Requires-Dist: requests>=2.32.3
Requires-Dist: scipy>=1.11.4
Requires-Dist: scipy-stubs
Requires-Dist: llvmlite>=0.44.0
Requires-Dist: numba>=0.61.0
Provides-Extra: notebook
Requires-Dist: iqm-client[qiskit]<30,>=29; extra == "notebook"
Requires-Dist: iqm-client<30,>=29; extra == "notebook"
Requires-Dist: iqm-station-control-client<10,>=9; extra == "notebook"
Requires-Dist: iqm-exa-common<27,>=26; extra == "notebook"
Requires-Dist: nbclient~=0.5.10; extra == "notebook"
Requires-Dist: notebook>=6.5.2; extra == "notebook"

IQM QAOA
########

Installation
============

Usually it makes sense to use a new Python environment, to isolate your setup from the global Python installation. That way, you can play around without messing the rest of your system.

- Using uv in terminal:

  .. code-block:: bash

    uv venv --python 3.11
    source .venv/bin/activate

- Using Conda in terminal:

  .. code-block:: bash

    conda create -n qaoa-library python=3.11
    conda activate qaoa-library

- In Visual Studio Code:

  #. Open the list of commands ``Ctrl`` + ``Shift`` + ``p``.

  #. Select `Python: Create Environment`.

  #. Select `Venv`.

  #. Select the correct Python version.


Then run


.. code-block:: bash

    pip install iqm-qaoa


If you have already installed the ``QAOA`` library and want to get the latest release you can add the ``--upgrade`` flag


.. code-block:: bash

    pip install iqm-qaoa --upgrade

Documentation
=============

Documentation for the latest version is `available online <https://docs.meetiqm.com/iqm-qaoa/>`_.
