Metadata-Version: 2.1
Name: weylchamber
Version: 0.5.0
Summary: Python package for analyzing two-qubit gates in the Weyl chamber
Home-page: https://github.com/qucontrol/weylchamber
Author: Michael Goerz
Author-email: mail@michaelgoerz.net
License: BSD license
Keywords: weylchamber
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: numpy<2.0
Requires-Dist: scipy
Requires-Dist: matplotlib>=3.3.0
Requires-Dist: qutip<5.0
Provides-Extra: dev
Requires-Dist: better-apidoc==0.3.2; extra == "dev"
Requires-Dist: click; extra == "dev"
Requires-Dist: coverage; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: gitpython; extra == "dev"
Requires-Dist: jupyter; extra == "dev"
Requires-Dist: nbsphinx; extra == "dev"
Requires-Dist: nbval; extra == "dev"
Requires-Dist: pep8; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-xdist; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: sphinx-autobuild; extra == "dev"
Requires-Dist: sphinx-autodoc-typehints; extra == "dev"
Requires-Dist: sphinx_rtd_theme; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: watermark; extra == "dev"
Requires-Dist: wheel; extra == "dev"

=======================
The weylchamber package
=======================

.. image:: https://img.shields.io/badge/github-qucontrol/weylchamber-blue.svg
   :alt: Source code on Github
   :target: https://github.com/qucontrol/weylchamber
.. image:: https://img.shields.io/pypi/v/weylchamber.svg
   :alt: weylchamber on the Python Package Index
   :target: https://pypi.python.org/pypi/weylchamber
.. image:: https://img.shields.io/travis/qucontrol/weylchamber.svg
   :alt: Travis Continuous Integration
   :target: https://travis-ci.org/qucontrol/weylchamber
.. image:: https://ci.appveyor.com/api/projects/status/a407jfh3gl74o1m4?svg=true
   :alt: AppVeyor Continuous Integration
   :target: https://ci.appveyor.com/project/goerz/weylchamber
.. image:: https://img.shields.io/coveralls/github/qucontrol/weylchamber.svg
   :alt: Coveralls
   :target: https://coveralls.io/github/qucontrol/weylchamber?branch=master
.. image:: https://readthedocs.org/projects/weylchamber/badge/?version=latest
   :alt: Documentation Status
   :target: https://weylchamber.readthedocs.io/en/latest/?badge=latest
.. image:: https://img.shields.io/badge/License-BSD-green.svg
   :alt: BSD License
   :target: https://opensource.org/licenses/BSD-3-Clause

Python package for analyzing two-qubit gates in the Weyl chamber

Development of the ``weylchamber`` package happens on `Github`_.
You can read the full documentation at `ReadTheDocs`_.


.. _ReadTheDocs: https://weylchamber.readthedocs.io/en/latest/


Installation
------------

To install the latest released version of the ``weylchamber`` package, run this command in your terminal:

.. code-block:: console

    $ pip install weylchamber

This is the preferred method to install ``weylchamber``, as it will always install the most recent stable release.

If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/


To install the latest development version of ``weylchamber`` from `Github`_.

.. code-block:: console

    $ pip install git+https://github.com/qucontrol/weylchamber.git@master#egg=weylchamber



.. _Github: https://github.com/qucontrol/weylchamber

Usage
-----

To use ``weylchamber`` in a project::

    import weylchamber

See the Tutorial_ for details.

.. _Tutorial: https://weylchamber.readthedocs.io/en/latest/tutorial.html


=======
History
=======

0.5.0 (2024-06-03)
------------------

* Drop: Compatibility with matplotlib < 3.3
* Drop: Compatibility with qutip >= 5.0

0.4.0 (2022-03-18)
------------------

* Drop: Support for Python 3.5-3.7
* Add: Support for Python 3.8-3.9
* Update: Use QuTiP 4.6

This is a maintenance release updating to the latest versions of Python and QuTiP and dropping support of versions that have reached end-of-life


0.3.2 (2019-08-02)
------------------

* Fix: adapt to changes in QuTiP 4.4
* Fix: adapt to changes in Sphinx (better-apidoc 0.3.1)


0.3.1 (2019-02-15)
------------------

* Fix: the routine ``make_PE_krotov_chi_constructor`` now returns a function that is compatible with a stricter interface for ``chi_constructor`` in the `krotov` packages (which now requires that ``chi_constructor`` routines accept keyword arguments).


0.3.0 (2019-01-26)
------------------

* Add: routine ``make_PE_krotov_chi_constructor`` for calculating the boundary conditions for the backward propagation in an optimization towards a perfect entangler using Krotov's method

0.2.1 (2018-12-18)
------------------

* Bugfix: project metadata

0.2.0 (2018-12-18)
------------------

* Add: Conversion between canonical basis and Bell basis: functions ``bell_basis``, ``gate``, and ``mapped_basis``

0.1.0 (2018-11-22)
------------------

* Initial release
