surfq

Name	surfq JSON
Version	0.1.2 JSON
	download
home_page	None
Summary	A surface code simulator
upload_time	2025-08-20 16:21:20
maintainer	None
docs_url	None
author	None
requires_python	>=3.13
license	None
keywords	python project surfq
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # SurfQ

**SurfQ** is a Python framework for efficiently simulating surface codes under noise. The aim is to enable detailed investigation of the behavior of surface codes under different physical error models, supporting advanced fault-tolerant protocols such as lattice surgery, state injection, and magic state distillation as future extensions.

## Features:

- Intuitive surface code representation
- Apply quantum operations: X, Z, H, CNOT, and syndrome measurement
- Simulate various noise channels: Pauli noise, depolarizing, bit-flip, phase-flip errors
- Analyse logical error rates and syndrome measurement statistics for error correction
- Modular and extensible framework for surface code simulation and fault-tolerant quantum protocols

## Examples

```shell
uv run examples/main.py
```

## Notebooks

```shell
uvx juv run notebooks/main.py
```

## References

- [Improved Simulation of Stabilizer Circuits](https://arxiv.org/pdf/quant-ph/0406196v5) – Aaronson and Gottesman, 2008
- [Stim: a fast stabilizer circuit simulator](https://arxiv.org/abs/2103.02202) – Gidney, 2021
- [STABSim: A Parallelized Clifford Simulator with Features Beyond Direct Simulation](https://arxiv.org/abs/2507.03092) – Garner et al., 2025
- [The Heisenberg Representation of Quantum Computers](https://arxiv.org/abs/quant-ph/9807006) - Gottesman, 2024

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "surfq",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.13",
    "maintainer_email": null,
    "keywords": "python, project, surfq",
    "author": null,
    "author_email": "Jo\u00e3o Ramos <1joaoramos1@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/b2/bf/346b3f4e72309117992bbc0918ce6608c22be766b1d474601cfe1ed97397/surfq-0.1.2.tar.gz",
    "platform": null,
    "description": "# SurfQ\n\n**SurfQ** is a Python framework for efficiently simulating surface codes under noise. The aim is to enable detailed investigation of the behavior of surface codes under different physical error models, supporting advanced fault-tolerant protocols such as lattice surgery, state injection, and magic state distillation as future extensions.\n\n## Features:\n\n- Intuitive surface code representation\n- Apply quantum operations: X, Z, H, CNOT, and syndrome measurement\n- Simulate various noise channels: Pauli noise, depolarizing, bit-flip, phase-flip errors\n- Analyse logical error rates and syndrome measurement statistics for error correction\n- Modular and extensible framework for surface code simulation and fault-tolerant quantum protocols\n\n## Examples\n\n```shell\nuv run examples/main.py\n```\n\n## Notebooks\n\n```shell\nuvx juv run notebooks/main.py\n```\n\n## References\n\n- [Improved Simulation of Stabilizer Circuits](https://arxiv.org/pdf/quant-ph/0406196v5) \u2013 Aaronson and Gottesman, 2008\n- [Stim: a fast stabilizer circuit simulator](https://arxiv.org/abs/2103.02202) \u2013 Gidney, 2021\n- [STABSim: A Parallelized Clifford Simulator with Features Beyond Direct Simulation](https://arxiv.org/abs/2507.03092) \u2013 Garner et al., 2025\n- [The Heisenberg Representation of Quantum Computers](https://arxiv.org/abs/quant-ph/9807006) - Gottesman, 2024\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A surface code simulator",
    "version": "0.1.2",
    "project_urls": null,
    "split_keywords": [
        "python",
        " project",
        " surfq"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e3e117987c09b2f36611d3bc0aadc2a120b558f240f0ff4493138342ebeda9aa",
                "md5": "8c68b97492bd4c4a55ad5f68118b1fea",
                "sha256": "378a82e8ca756f3c7c6d8046fd71922a47b0be5250a1c0d8cd048c21bb47cb35"
            },
            "downloads": -1,
            "filename": "surfq-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8c68b97492bd4c4a55ad5f68118b1fea",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.13",
            "size": 95161,
            "upload_time": "2025-08-20T16:21:18",
            "upload_time_iso_8601": "2025-08-20T16:21:18.738316Z",
            "url": "https://files.pythonhosted.org/packages/e3/e1/17987c09b2f36611d3bc0aadc2a120b558f240f0ff4493138342ebeda9aa/surfq-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b2bf346b3f4e72309117992bbc0918ce6608c22be766b1d474601cfe1ed97397",
                "md5": "e57927b72d42a4e540934571eb7752eb",
                "sha256": "43894382acda2fe43d54277d22bfff172adac67357991d16a8f28d9d16254cbb"
            },
            "downloads": -1,
            "filename": "surfq-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "e57927b72d42a4e540934571eb7752eb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.13",
            "size": 95681,
            "upload_time": "2025-08-20T16:21:20",
            "upload_time_iso_8601": "2025-08-20T16:21:20.858626Z",
            "url": "https://files.pythonhosted.org/packages/b2/bf/346b3f4e72309117992bbc0918ce6608c22be766b1d474601cfe1ed97397/surfq-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-20 16:21:20",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "surfq"
}