Metadata-Version: 2.1
Name: PennyLane-Lightning
Version: 0.14.0
Summary: PennyLane-Lightning plugin
Home-page: https://github.com/XanaduAI/pennylane-lightning
Maintainer: Xanadu Inc.
Maintainer-email: software@xanadu.ai
License: Apache License 2.0
Description: PennyLane-Lightning Plugin
        ##########################
        
        .. image:: https://img.shields.io/github/workflow/status/PennyLaneAI/pennylane-lightning/Testing/master?logo=github&style=flat-square
            :alt: GitHub Workflow Status (branch)
            :target: https://github.com/PennyLaneAI/pennylane-lightning/actions?query=workflow%3ATesting
        
        .. image:: https://img.shields.io/codecov/c/github/PennyLaneAI/pennylane-lightning/master.svg?logo=codecov&style=flat-square
            :alt: Codecov coverage
            :target: https://codecov.io/gh/PennyLaneAI/pennylane-lightning
        
        .. image:: https://img.shields.io/codefactor/grade/github/PennyLaneAI/pennylane-lightning/master?logo=codefactor&style=flat-square
            :alt: CodeFactor Grade
            :target: https://www.codefactor.io/repository/github/pennylaneai/pennylane-lightning
        
        .. image:: https://img.shields.io/readthedocs/pennylane-lightning.svg?logo=read-the-docs&style=flat-square
            :alt: Read the Docs
            :target: https://pennylane-lightning.readthedocs.io
        
        .. image:: https://img.shields.io/pypi/v/PennyLane-Lightning.svg?style=flat-square
            :alt: PyPI
            :target: https://pypi.org/project/PennyLane-Lightning
        
        .. image:: https://img.shields.io/pypi/pyversions/PennyLane-Lightning.svg?style=flat-square
            :alt: PyPI - Python Version
            :target: https://pypi.org/project/PennyLane-Lightning
        
        .. header-start-inclusion-marker-do-not-remove
        
        The PennyLane-Lightning plugin provides a fast state-vector simulator written in C++ using `Eigen <http://eigen.tuxfamily.org/index.php?title=Main_Page>`_.
        
        `PennyLane <https://pennylane.readthedocs.io>`_ is a cross-platform Python library for quantum machine
        learning, automatic differentiation, and optimization of hybrid quantum-classical computations.
        
        .. header-end-inclusion-marker-do-not-remove
        
        Features
        ========
        
        * Combine PennyLane-Lightning's high performance simulator with PennyLane's
          automatic differentiation and optimization.
        
        .. installation-start-inclusion-marker-do-not-remove
        
        Installation
        ============
        
        PennyLane-Lightning requires Python version 3.6 and above. It can be installed using ``pip``:
        
        .. code-block:: console
        
            $ pip install pennylane-lightning
        
        Alternatively, to build PennyLane-Lightning from source you can run
        
        .. code-block:: console
        
            $ git clone https://github.com/XanaduAI/pennylane-lightning.git
            $ cd pennylane-lightning
            $ pip install -e .
        
        Note that subsequent calls to ``pip install -e .`` will use cached binaries stored in the
        ``build`` folder. Run ``make clean`` if you would like to recompile.
        
        The following dependencies are required to install PennyLane-Lightning:
        
        * A C++ compiler, such as ``g++``, ``clang``, or ``MSVC``.
        * `Eigen3 <http://eigen.tuxfamily.org/index.php?title=Main_Page>`_ - a C++ header library for linear algebra.
        * `pybind11 <https://pybind11.readthedocs.io/en/stable/>`_ a library for binding C++
          functionality to Python.
        
        On Debian-based systems, these can be installed via ``apt`` and ``pip``:
        
        .. code-block:: console
        
            $ sudo apt install g++ libeigen3-dev
            $ pip install pybind11
        
        Testing
        -------
        
        To test that the plugin is working correctly you can test the Python code within the cloned
        repository:
        
        .. code-block:: console
        
            $ make test
        
        while the C++ code can be tested with
        
        .. code-block:: console
        
            $ make test-cpp
        
        Testing the C++ code requires the `GoogleTest <https://github.com/google/googletest>`__ framework.
        
        .. installation-end-inclusion-marker-do-not-remove
        
        Please refer to the `plugin documentation <https://pennylane-lightning.readthedocs.io/>`_ as
        well as to the `PennyLane documentation <https://pennylane.readthedocs.io/>`_ for further reference.
        
        Contributing
        ============
        
        We welcome contributions - simply fork the repository of this plugin, and then make a
        `pull request <https://help.github.com/articles/about-pull-requests/>`_ containing your contribution.
        All contributers to this plugin will be listed as authors on the releases.
        
        We also encourage bug reports, suggestions for new features and enhancements, and even links to cool projects
        or applications built on PennyLane.
        
        Authors
        =======
        
        PennyLane-Lightning is the work of `many contributors <https://github.com/XanaduAI/pennylane-lightning/graphs/contributors>`_.
        
        If you are doing research using PennyLane and PennyLane-Lightning, please cite `our paper <https://arxiv.org/abs/1811.04968>`_:
        
            Ville Bergholm, Josh Izaac, Maria Schuld, Christian Gogolin, M. Sohaib Alam, Shahnawaz Ahmed,
            Juan Miguel Arrazola, Carsten Blank, Alain Delgado, Soran Jahangiri, Keri McKiernan, Johannes Jakob Meyer,
            Zeyue Niu, Antal Száva, and Nathan Killoran.
            *PennyLane: Automatic differentiation of hybrid quantum-classical computations.* 2018. arXiv:1811.04968
        
        .. support-start-inclusion-marker-do-not-remove
        
        Support
        =======
        
        - **Source Code:** https://github.com/PennyLaneAI/pennylane-lightning
        - **Issue Tracker:** https://github.com/PennyLaneAI/pennylane-lightning/issues
        - **PennyLane Forum:** https://discuss.pennylane.ai
        
        If you are having issues, please let us know by posting the issue on our Github issue tracker, or
        by asking a question in the forum.
        
        .. support-end-inclusion-marker-do-not-remove
        .. license-start-inclusion-marker-do-not-remove
        
        License
        =======
        
        The PennyLane lightning plugin is **free** and **open source**, released under
        the `Apache License, Version 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`_.
        
        .. license-end-inclusion-marker-do-not-remove
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering :: Physics
Provides: pennylane_lightning
Description-Content-Type: text/x-rst
