{"id":13776509,"url":"https://github.com/PennyLaneAI/pennylane-lightning","last_synced_at":"2025-05-11T10:31:07.211Z","repository":{"id":37084916,"uuid":"277556169","full_name":"PennyLaneAI/pennylane-lightning","owner":"PennyLaneAI","description":"The Lightning plugin ecosystem provides fast quantum state-vector and tensor network simulators written in C++ for use with PennyLane.","archived":false,"fork":false,"pushed_at":"2025-05-06T15:39:36.000Z","size":11891,"stargazers_count":110,"open_issues_count":63,"forks_count":44,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-05-06T16:52:07.815Z","etag":null,"topics":["cuda","distributed-computing","gpu","hpc","mpi","openmp","parallel","quantum-computing","quantum-machine-learning","rocm"],"latest_commit_sha":null,"homepage":"https://docs.pennylane.ai/projects/lightning","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PennyLaneAI.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-07-06T13:55:59.000Z","updated_at":"2025-05-02T18:59:50.000Z","dependencies_parsed_at":"2023-09-22T03:23:44.666Z","dependency_job_id":"fbb54ecb-286b-486e-b0df-b0acde94b677","html_url":"https://github.com/PennyLaneAI/pennylane-lightning","commit_stats":{"total_commits":661,"total_committers":41,"mean_commits":"16.121951219512194","dds":0.8532526475037822,"last_synced_commit":"9eb61230724131d3fca036a09d1e84771aafacfa"},"previous_names":[],"tags_count":46,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PennyLaneAI%2Fpennylane-lightning","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PennyLaneAI%2Fpennylane-lightning/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PennyLaneAI%2Fpennylane-lightning/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PennyLaneAI%2Fpennylane-lightning/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PennyLaneAI","download_url":"https://codeload.github.com/PennyLaneAI/pennylane-lightning/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253551566,"owners_count":21926317,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cuda","distributed-computing","gpu","hpc","mpi","openmp","parallel","quantum-computing","quantum-machine-learning","rocm"],"created_at":"2024-08-03T18:00:27.887Z","updated_at":"2025-05-11T10:31:07.198Z","avatar_url":"https://github.com/PennyLaneAI.png","language":"C++","funding_links":[],"categories":["Quantum simulators"],"sub_categories":[],"readme":"Lightning Plugins\n#################\n\n.. image:: https://img.shields.io/github/actions/workflow/status/PennyLaneAI/pennylane-lightning/tests_lqcpu_python.yml?branch=master\u0026label=LQubit\u0026style=flat-square\n    :alt: Linux x86_64 L-Qubit Python tests (branch)\n    :target: https://github.com/PennyLaneAI/pennylane-lightning/actions/workflows/tests_lqcpu_python.yml\n\n.. image:: https://img.shields.io/github/actions/workflow/status/PennyLaneAI/pennylane-lightning/tests_gpu_python.yml?branch=master\u0026label=LGPU\u0026style=flat-square\n    :alt: Linux x86_64 L-GPU Python tests (branch)\n    :target: https://github.com/PennyLaneAI/pennylane-lightning/actions/workflows/tests_gpu_python.yml\n\n.. image:: https://img.shields.io/github/actions/workflow/status/PennyLaneAI/pennylane-lightning/tests_lkcpu_python.yml?branch=master\u0026label=LKokkos\u0026style=flat-square\n    :alt: Linux x86_64 L-Kokkos Python tests (branch)\n    :target: https://github.com/PennyLaneAI/pennylane-lightning/actions/workflows/tests_lkcpu_python.yml\n\n.. image:: https://img.shields.io/github/actions/workflow/status/PennyLaneAI/pennylane-lightning/tests_gpu_python.yml?branch=master\u0026label=LTensor\u0026style=flat-square\n    :alt: Linux x86_64 L-Tensor Python tests (branch)\n    :target: https://github.com/PennyLaneAI/pennylane-lightning/actions/workflows/tests_gpu_python.yml\n\n.. image:: https://img.shields.io/codecov/c/github/PennyLaneAI/pennylane-lightning/master.svg?logo=codecov\u0026style=flat-square\n    :alt: Codecov coverage\n    :target: https://codecov.io/gh/PennyLaneAI/pennylane-lightning\n\n.. image:: https://img.shields.io/codefactor/grade/github/PennyLaneAI/pennylane-lightning/master?logo=codefactor\u0026style=flat-square\n    :alt: CodeFactor Grade\n    :target: https://www.codefactor.io/repository/github/pennylaneai/pennylane-lightning\n\n.. image:: https://readthedocs.com/projects/xanaduai-pennylane-lightning/badge/?version=latest\u0026style=flat-square\n    :alt: Read the Docs\n    :target: https://docs.pennylane.ai/projects/lightning\n\n.. image:: https://img.shields.io/discourse/https/discuss.pennylane.ai/posts.svg?logo=discourse\u0026style=flat-square\n    :alt: PennyLane Forum\n    :target: https://discuss.pennylane.ai\n\n.. image:: https://img.shields.io/pypi/v/PennyLane-Lightning.svg?style=flat-square\n    :alt: PyPI - Version\n    :target: https://pypi.org/project/PennyLane-Lightning\n\n.. image:: https://img.shields.io/pypi/pyversions/PennyLane-Lightning.svg?style=flat-square\n    :alt: PyPI - Python Version\n    :target: https://pypi.org/project/PennyLane-Lightning\n\n.. image:: https://img.shields.io/pypi/l/PennyLane.svg?logo=apache\u0026style=flat-square\n    :alt: License\n    :target: https://www.apache.org/licenses/LICENSE-2.0\n\n.. header-start-inclusion-marker-do-not-remove\n\nThe Lightning plugin ecosystem provides fast state-vector and tensor-network simulators written in C++.\n\n`PennyLane \u003chttps://docs.pennylane.ai\u003e`_ is a cross-platform Python library for quantum machine\nlearning, automatic differentiation, and optimization of hybrid quantum-classical computations.\nPennyLane supports Python 3.10 and above.\n\nBackends\n********\n\nPennyLane-Lightning high performance simulators include the following backends:\n\n* ``lightning.qubit``: a fast state-vector simulator written in C++ with optional `OpenMP \u003chttps://www.openmp.org/\u003e`_ additions and parallelized gate-level SIMD kernels.\n* ``lightning.gpu``: a state-vector simulator based on the `NVIDIA cuQuantum SDK \u003chttps://developer.nvidia.com/cuquantum-sdk\u003e`_. It notably implements a distributed state-vector simulator based on `MPI \u003chttps://www.mpi-forum.org/docs/\u003e`_.\n* ``lightning.kokkos``: a state-vector simulator written with `Kokkos \u003chttps://kokkos.github.io/kokkos-core-wiki/index.html\u003e`_. It can exploit the inherent parallelism of modern processing units supporting the `OpenMP \u003chttps://www.openmp.org/\u003e`_, `CUDA \u003chttps://developer.nvidia.com/cuda-toolkit\u003e`_ or `HIP \u003chttps://rocm.docs.amd.com/projects/HIP/en/latest\u003e`_ programming models.\n* ``lightning.tensor``: a tensor-network simulator based on the `NVIDIA cuQuantum SDK \u003chttps://developer.nvidia.com/cuquantum-sdk\u003e`_. The supported methods are Matrix Product State (MPS) and Exact Tensor Network (TN).\n\nIf you're not sure what simulator to use, check out our `PennyLane performance \u003chttps://pennylane.ai/performance\u003e`_ page.\n\n.. header-end-inclusion-marker-do-not-remove\n\nInstallation\n************\n\nThe following table summarizes the supported platforms and the primary installation mode:\n\n+------------------------+-----------+-----------+-----------+-----------+-----------+\n|                        | Linux x86 | Linux ARM | MacOS x86 | MacOS ARM | Windows   |\n|                        |           |           |           |           |           |\n+========================+===========+===========+===========+===========+===========+\n| Lightning-Qubit        | pip       | pip       | pip       | pip       | pip       |\n+------------------------+-----------+-----------+-----------+-----------+-----------+\n| Lightning-GPU          | pip       | pip       |           |           |           |\n+------------------------+-----------+-----------+-----------+-----------+-----------+\n| Lightning-GPU (MPI)    | source    |           |           |           |           |\n+------------------------+-----------+-----------+-----------+-----------+-----------+\n| Lightning-Kokkos (OMP) | pip       | pip       | pip       | pip       |           |\n+------------------------+-----------+-----------+-----------+-----------+-----------+\n| Lightning-Kokkos (CUDA)| source    | source    |           |           |           |\n+------------------------+-----------+-----------+-----------+-----------+-----------+\n| Lightning-Kokkos (HIP) | source    | source    |           |           |           |\n+------------------------+-----------+-----------+-----------+-----------+-----------+\n| Lightning-Tensor       | pip       | pip       |           |           |           |\n+------------------------+-----------+-----------+-----------+-----------+-----------+\n\nTo install the latest stable version of these plugins, check out the `PennyLane installation guide \u003chttps://pennylane.ai/install#high-performance-computing-and-gpus\u003e`_.\n\nIf you wish to install the latest development version, instructions for `building from source \u003chttps://docs.pennylane.ai/projects/lightning/en/stable/dev/installation.html\u003e`_ are also available for each backend.\n\n.. docker-start-inclusion-marker-do-not-remove\n\nDocker support\n**************\n\nDocker images for the various backends are found on the\n`PennyLane Docker Hub \u003chttps://hub.docker.com/u/pennylaneai\u003e`_ page, where a detailed description about PennyLane Docker support can be found.\nBriefly, one can build the Docker Lightning images using:\n\n.. code-block:: bash\n\n    git clone https://github.com/PennyLaneAI/pennylane-lightning.git\n    cd pennylane-lightning\n    docker build -f docker/Dockerfile --target ${TARGET} .\n\nwhere ``${TARGET}`` is one of the following\n\n* ``wheel-lightning-qubit``\n* ``wheel-lightning-gpu``\n* ``wheel-lightning-kokkos-openmp``\n* ``wheel-lightning-kokkos-cuda``\n* ``wheel-lightning-kokkos-rocm``\n\n.. docker-end-inclusion-marker-do-not-remove\n\nContributing\n************\n\nWe welcome contributions - simply fork the repository of this plugin, and then make a\n`pull request \u003chttps://help.github.com/articles/about-pull-requests/\u003e`_ containing your contribution.\nAll contributors to this plugin will be listed as authors on the releases.\n\nWe also encourage bug reports, suggestions for new features and enhancements, and even links to cool projects\nor applications built on PennyLane.\n\nBlack \u0026 Pylint\n==============\n\nIf you contribute to the Python code, please mind the following.\nThe Python code is formatted with the PEP 8 compliant opinionated formatter `Black \u003chttps://github.com/psf/black\u003e`_ (`black==25.1.0`).\nWe set a line width of a 100 characters.\nThe Python code is statically analyzed with `Pylint \u003chttps://pylint.readthedocs.io/en/stable/\u003e`_.\nWe set up a pre-commit hook (see `Git hooks \u003chttps://git-scm.com/docs/githooks\u003e`_) to run both of these on `git commit`.\nPlease make your best effort to comply with `black` and `pylint` before using disabling pragmas (e.g. `# pylint: disable=missing-function-docstring`).\n\nAuthors\n*******\n\n.. citation-start-inclusion-marker-do-not-remove\n\nLightning is the work of `many contributors \u003chttps://github.com/PennyLaneAI/pennylane-lightning/graphs/contributors\u003e`_.\n\nIf you are using Lightning for research, please cite:\n\n.. code-block:: bibtex\n\n    @misc{\n        asadi2024,\n        title={{Hybrid quantum programming with PennyLane Lightning on HPC platforms}},\n        author={Ali Asadi and Amintor Dusko and Chae-Yeun Park and Vincent Michaud-Rioux and Isidor Schoch and Shuli Shu and Trevor Vincent and Lee James O'Riordan},\n        year={2024},\n        eprint={2403.02512},\n        archivePrefix={arXiv},\n        primaryClass={quant-ph},\n        url={https://arxiv.org/abs/2403.02512},\n    }\n\n.. citation-end-inclusion-marker-do-not-remove\n.. support-start-inclusion-marker-do-not-remove\n\nSupport\n*******\n\n- **Source Code:** https://github.com/PennyLaneAI/pennylane-lightning\n- **Issue Tracker:** https://github.com/PennyLaneAI/pennylane-lightning/issues\n- **PennyLane Forum:** https://discuss.pennylane.ai\n\nIf you are having issues, please let us know by posting the issue on our Github issue tracker, or\nby asking a question in the forum.\n\n.. support-end-inclusion-marker-do-not-remove\n.. license-start-inclusion-marker-do-not-remove\n\nLicense\n*******\n\nThe Lightning plugins are **free** and **open source**, released under\nthe `Apache License, Version 2.0 \u003chttps://www.apache.org/licenses/LICENSE-2.0\u003e`_.\nThe Lightning-GPU and Lightning-Tensor plugins make use of the NVIDIA cuQuantum SDK headers to\nenable the device bindings to PennyLane, which are held to their own respective license.\n\n.. license-end-inclusion-marker-do-not-remove\n.. acknowledgements-start-inclusion-marker-do-not-remove\n\nAcknowledgements\n****************\n\nPennyLane Lightning makes use of the following libraries and tools, which are under their own respective licenses:\n\n- **pybind11:** https://github.com/pybind/pybind11\n- **Kokkos Core:** https://github.com/kokkos/kokkos\n- **NVIDIA cuQuantum:** https://developer.nvidia.com/cuquantum-sdk\n- **scipy-openblas32:** https://pypi.org/project/scipy-openblas32/\n- **Xanadu JET:** https://github.com/XanaduAI/jet\n\n.. acknowledgements-end-inclusion-marker-do-not-remove\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPennyLaneAI%2Fpennylane-lightning","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FPennyLaneAI%2Fpennylane-lightning","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPennyLaneAI%2Fpennylane-lightning/lists"}