{
    "info": {
        "author": "Lucas Saldyt",
        "author_email": "lucassaldyt@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3"
        ],
        "description": "# Qurry \n[![Unitary Fund](https://img.shields.io/badge/Supported%20By-UNITARY%20FUND-brightgreen.svg?style=for-the-badge)](http://unitary.fund)  \n\nQurry is a prototype of a quantum probabilistic programming language, done with the [unitary fund](https://unitary.fund).\nThe official project duration is one year, but the language may be usable before then (and in fact, can already be used to use all of the QUIL spec with some useful abstractions on top, like if statements, variable names, and so on).\n\nFor more information on the progress of the project, see a [summary](brainstorm.md) (from early October), or an in-progress [paper](paper/paper.pdf). \n\nIf you use Qurry or are influenced by it, all I ask is that you cite the software. A bibtex citation is available at the end of this file.\nOnce a paper is published, please cite that (I will update it here).\n\nSince Qurry is currently in major rework (until `September 16th, 2019`), the instructions and description previously available on this readme have been commented out.\n\n<!--\n\n## Installation\n\nRight now, Qurry can be cloned locally and run from this directory:\n\n```bash\ngit clone https://github.com/LSaldyt/qurry\ncd qurry\n./compile examples/bell.lisp # Compile the bell state generator into a circuit\n```\n\nTo run Qurry from anywhere, simply add this directory to your path:\n```\nexport PATH=$PATH:/home/your-username/your-directory/qurry\n```\n\n## Usage\n\nCurrently, Qurry can be used with the entire QUIL spec, as well as some small abstractions.\nTo review the QUIL spec and its arguments, call `./quilarity`.\n\n### Python bindings\n\nQurry acts as an extension to quil, and is usable in the same way:\n\n```\n>>> from qurry.api import *\n>>> program = Program(bernoulli(0.5, 0), H(0))\n>>> str(program)\n'RX(pi/2) 0\\nH 0\\n'\n>>>\n```\n\nQurry is also usable as a standalone language, which can be converted to the above python syntax at will.  \n\nFor example, the trivial Bell-state program is expressed as the following:\n```lisp\n(h 0)\n(cnot 0 1)\n```\n\nGate names can be either upper-case or lower-case.\n\nThe following are new instructions that Qurry offers:\n`def`, `bernoulli`, `clear`, `do`, `gaussian`, `if`, `map`, `multinomial`, `uniform`\n\nFirst there are the simple classical-probabilistic structures `bernoulli`, `gaussian`, `multinomial`, and `uniform`.\nBernoulli simply rotates a qubit such that it will be measured as `|1>` with a certain probability:\nFor instance, `(bernoulli 0.5 0)` creates a fair coin from qubit 0. \nThese can be chained together to create more complicated bit-states, which are useful in other algorithms, like Grover's or QFT.\n\nSimilarly, the `gaussian` function creates a discrete multinomial state which approximates a gaussian distribution.\nIt uses the `def` function to create a block of useable qubits:\n```\n(def gaussblock 0 4) ; block of 5 qubits\n(gaussian 0 1.0 gaussblock)\n```\nNote that much of the computation here is (as currently implemented) happening classically. \nThe gaussian cdf is not computed on the quantum computer, but instead a pre-determined discrete cdf is turned into a quantum gate which can be applied repeatedly to create multi-gaussian superpositions and so on.\n\nUniform does nothing special:\n```lisp\n(def uniformblock 0 7) ; eight qubits\n(uniform uniformblock)\n```\n\nMultinomial can create any discrete multinomial distribution on qubits:\n```\n(def multinomialblock 0 7) ; eight qubits\n(multinomial 0.1 0.2 0.1 0.0 0.1 0.4 0.1 0.0)\n```\n\nNext are control statements:\n\n`map` simply applies a single-qubit operator to an entire block. This is very useful for initializing bases:\n\n```\n(def newbasis 0 7)\n(map h newbasis)\n```\n\nThe `if` and `do` statements are intuitive:\n```\n(bernoulli 0.5 0)\n(measure 0 0)\n(if 0 ; If the classical bit 0 is equal to 1\n    (do (x 1)\n        (x 2))\n    (nop))\n```\nThis circuit will produce `111` and `000` with equal probability (but NOT using entanglement, since there is a possible intermediate state of `00`).\n\n## Hacking\n\nEach language feature is located in `lib/constructs/` under a file that has the same name as the feature.\nDoing this allows language features to be added dynamically.\nThe only requirement is that each feature-file have a function `create-feature` where `feature` is the name of the feature (i.e. `create-if`).\nThis function should take the arguments that the function does, and return valid QUIL code.  \n\nFor instance, the `if` statement is defined as follows:\n`lib/constructs/if.py`:\n```python3\nfrom ..utils import named_uuid\n\nif_template = '''# Conditional statement\nJUMP-WHEN @{first} [{cond}]\n  {b}\nJUMP @{end}\nLABEL @{first}\n  {a}\nLABEL @{end}'''\n\ndef create_if(cond, a, b, definitions=None):\n    '''\n    Create an if statement using labels and jumps.\n    (if (equal 0 1) (X 1) (X 0))\n    '''\n    if definitions is None:\n        definitions = dict()\n    return if_template.format(\n            cond=cond,\n            a=a,\n            b=b,\n            first=named_uuid('first'),\n            end=named_uuid('end'))\n```\n\nThe `if` statement uses a raw quil template that boils down to jump instructions, and the function `create_if` is a reserved name in this file.\nFor more on contributing, see [HACKING.md](HACKING.md)\n\n-->\n\n```\n@misc{saldyt_2018, title={Qurry, a probabilistic quantum programming language}, url={https://github.com/LSaldyt/qurry}, journal={GitHub}, author={Saldyt, Lucas}, year={2018}, month={Nov}}\n```\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/LSaldyt/qurry",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "qurry",
        "package_url": "https://pypi.org/project/qurry/",
        "platform": "",
        "project_url": "https://pypi.org/project/qurry/",
        "project_urls": {
            "Homepage": "https://github.com/LSaldyt/qurry"
        },
        "release_url": "https://pypi.org/project/qurry/0.0.3/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "A prototype quantum programming language",
        "version": "0.0.3"
    },
    "last_serial": 5863808,
    "releases": {
        "0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2614ee6be65334cca467a463e4aaa922",
                    "sha256": "9d2b0280ae09ff4a109f89364cace0ba361a8f8755d37a1f85fbaa43e57d8f54"
                },
                "downloads": -1,
                "filename": "qurry-0.0.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "2614ee6be65334cca467a463e4aaa922",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 24223,
                "upload_time": "2019-09-13T19:29:37",
                "url": "https://files.pythonhosted.org/packages/b4/7a/1baf7af9a31eadd21e555a8adb4eb32ac2341e98303986b71ebf50d15363/qurry-0.0.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "13635e753985be905c3bffc3f92b98ed",
                    "sha256": "523f2cfd0f960ff3e81c02a4d4208abb180c0f2e40705fe51e250b50657fcf7a"
                },
                "downloads": -1,
                "filename": "qurry-0.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "13635e753985be905c3bffc3f92b98ed",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 20899,
                "upload_time": "2019-09-13T19:05:13",
                "url": "https://files.pythonhosted.org/packages/18/f6/f66540643338ad67ccd4b020485d95df4855accec8c52503fb39215242c6/qurry-0.0-py3-none-any.whl"
            }
        ],
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c00bd34647947678c3c079ea3f52da9a",
                    "sha256": "edd46efdfdb7b7e9a7ee2fbddb64189c71f138690e1bbd99f5ba1a428018485c"
                },
                "downloads": -1,
                "filename": "qurry-0.0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "c00bd34647947678c3c079ea3f52da9a",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 24223,
                "upload_time": "2019-09-13T19:33:35",
                "url": "https://files.pythonhosted.org/packages/77/92/63884e3203aede7cc643be27b6e33e9437185cfaad87fa534bf4b2ea2aa9/qurry-0.0.1-py3-none-any.whl"
            }
        ],
        "0.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2a924e2619b05a71e1e5da617fdf3b07",
                    "sha256": "995ea5ece3aa0162dfd29a3f8f6929d78786f8af08a09e7de7d6a3df1021bcf8"
                },
                "downloads": -1,
                "filename": "qurry-0.0.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "2a924e2619b05a71e1e5da617fdf3b07",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 24583,
                "upload_time": "2019-09-13T21:41:20",
                "url": "https://files.pythonhosted.org/packages/c8/60/dc8dab406dc76907b32725e318e2adb740bea54332498da8d2969f0858f0/qurry-0.0.2-py3-none-any.whl"
            }
        ],
        "0.0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8f5ea2e635c3b8ebdd10ddb09d0f8dc3",
                    "sha256": "8306dced1629c3b8c64191bf50c3ac348d90747cacb22d9adcbfc369935833a9"
                },
                "downloads": -1,
                "filename": "qurry-0.0.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "8f5ea2e635c3b8ebdd10ddb09d0f8dc3",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 24877,
                "upload_time": "2019-09-20T19:30:56",
                "url": "https://files.pythonhosted.org/packages/c4/2c/67a9f66b98ac7d0a8b2ffd92bb2652a26f06ba27db616aae1652bc0cd641/qurry-0.0.3-py3-none-any.whl"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "8f5ea2e635c3b8ebdd10ddb09d0f8dc3",
                "sha256": "8306dced1629c3b8c64191bf50c3ac348d90747cacb22d9adcbfc369935833a9"
            },
            "downloads": -1,
            "filename": "qurry-0.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8f5ea2e635c3b8ebdd10ddb09d0f8dc3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 24877,
            "upload_time": "2019-09-20T19:30:56",
            "url": "https://files.pythonhosted.org/packages/c4/2c/67a9f66b98ac7d0a8b2ffd92bb2652a26f06ba27db616aae1652bc0cd641/qurry-0.0.3-py3-none-any.whl"
        }
    ]
}