broadbean


Namebroadbean JSON
Version 0.14.0 PyPI version JSON
download
home_page
SummaryPackage for easily generating and manipulating signal pulses.
upload_time2024-03-06 22:15:44
maintainer
docs_urlNone
author
requires_python>=3.9
licenseMIT
keywords pulsebuilding signal processing arbitrary waveforms
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ## Broadbean aka QCoDeS Pulse Builder

[ ![PyPi](https://badge.fury.io/py/broadbean.svg) ](https://badge.fury.io/py/broadbean)
[ ![Build Status Github Docs](https://github.com/QCoDeS/broadbean/workflows/build%20docs/badge.svg) ](https://github.com/QCoDeS/broadbean/actions?query=workflow%3A%22build+docs%22)
[ ![DOCS](https://img.shields.io/badge/read%20-thedocs-ff66b4.svg) ](https://qcodes.github.io/broadbean/index.html#)
[ ![PyPI python versions](https://img.shields.io/pypi/pyversions/broadbean.svg) ](https://pypi.python.org/pypi/broadbean/)
[ ![Build Status Github](https://github.com/QCoDeS/broadbean/workflows/Run%20mypy%20and%20pytest/badge.svg) ](https://github.com/QCoDeS/broadbean/actions?query=workflow%3A%22Run+mypy+and+pytest%22)

A library for making pulses that can be leveraged with QCoDeS (in
particular with Tektronix 5000/7000 series AWG drivers),
but also works as standalone.

Usage examples can be found in broadbean's documentation [here](https://qcodes.github.io/broadbean/examples/index.html).

Short description: The broadbean module lets the user compose and
manipulate pulse sequences. The aim of the module is to reduce pulse
building to the logical minimum of specifications so that building and
manipulation become as easy as saying "Gimme a square wave, then a
ramp, then a sine, and then wait for 10 ms" and, in particular, "Do
the same thing again, but now with the sine having twice the frequency
it had before".

The little extra module called `ripasso` performs frequency filtering
and frequency filter  compensation. It could be useful in a general
setting and is therefore factored out to its own module.

The name: The broad bean is one of my favourite pulses.

### Formal requirements

The broadbean package only works with python 3.9+

### Installation
In general, refer to [broadbeans documentation](https://qcodes.github.io/broadbean/start/index.html#installation)
for installation instructions.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "broadbean",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "QCoDeS Core Developers <qcodes-support@microsoft.com>",
    "keywords": "Pulsebuilding signal processing arbitrary waveforms",
    "author": "",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/38/c9/c64ec69941544561f503fe092f2f32b9117252b2dd22b90368787d2316a2/broadbean-0.14.0.tar.gz",
    "platform": null,
    "description": "## Broadbean aka QCoDeS Pulse Builder\n\n[ ![PyPi](https://badge.fury.io/py/broadbean.svg) ](https://badge.fury.io/py/broadbean)\n[ ![Build Status Github Docs](https://github.com/QCoDeS/broadbean/workflows/build%20docs/badge.svg) ](https://github.com/QCoDeS/broadbean/actions?query=workflow%3A%22build+docs%22)\n[ ![DOCS](https://img.shields.io/badge/read%20-thedocs-ff66b4.svg) ](https://qcodes.github.io/broadbean/index.html#)\n[ ![PyPI python versions](https://img.shields.io/pypi/pyversions/broadbean.svg) ](https://pypi.python.org/pypi/broadbean/)\n[ ![Build Status Github](https://github.com/QCoDeS/broadbean/workflows/Run%20mypy%20and%20pytest/badge.svg) ](https://github.com/QCoDeS/broadbean/actions?query=workflow%3A%22Run+mypy+and+pytest%22)\n\nA library for making pulses that can be leveraged with QCoDeS (in\nparticular with Tektronix 5000/7000 series AWG drivers),\nbut also works as standalone.\n\nUsage examples can be found in broadbean's documentation [here](https://qcodes.github.io/broadbean/examples/index.html).\n\nShort description: The broadbean module lets the user compose and\nmanipulate pulse sequences. The aim of the module is to reduce pulse\nbuilding to the logical minimum of specifications so that building and\nmanipulation become as easy as saying \"Gimme a square wave, then a\nramp, then a sine, and then wait for 10 ms\" and, in particular, \"Do\nthe same thing again, but now with the sine having twice the frequency\nit had before\".\n\nThe little extra module called `ripasso` performs frequency filtering\nand frequency filter  compensation. It could be useful in a general\nsetting and is therefore factored out to its own module.\n\nThe name: The broad bean is one of my favourite pulses.\n\n### Formal requirements\n\nThe broadbean package only works with python 3.9+\n\n### Installation\nIn general, refer to [broadbeans documentation](https://qcodes.github.io/broadbean/start/index.html#installation)\nfor installation instructions.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Package for easily generating and manipulating signal pulses.",
    "version": "0.14.0",
    "project_urls": {
        "Homepage": "https://github.com/QCoDeS/broadbean"
    },
    "split_keywords": [
        "pulsebuilding",
        "signal",
        "processing",
        "arbitrary",
        "waveforms"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "484d2b3b4b35456176182d45cdf977fdea80bf71be563f4074536ec3436eed9c",
                "md5": "3fe49472b23a12d2710375c2a5917102",
                "sha256": "7a9195ef16241853e2ea20aedc6f67ee72f5464a463b3584fcbedcb63daf88e7"
            },
            "downloads": -1,
            "filename": "broadbean-0.14.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3fe49472b23a12d2710375c2a5917102",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 36755,
            "upload_time": "2024-03-06T22:15:42",
            "upload_time_iso_8601": "2024-03-06T22:15:42.410802Z",
            "url": "https://files.pythonhosted.org/packages/48/4d/2b3b4b35456176182d45cdf977fdea80bf71be563f4074536ec3436eed9c/broadbean-0.14.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "38c9c64ec69941544561f503fe092f2f32b9117252b2dd22b90368787d2316a2",
                "md5": "25de440f12941497966883e8037ee84f",
                "sha256": "bfe3afea69529da246f7ca2803d0213c625f96b15a7ca4283b9c22f8fc5c655c"
            },
            "downloads": -1,
            "filename": "broadbean-0.14.0.tar.gz",
            "has_sig": false,
            "md5_digest": "25de440f12941497966883e8037ee84f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 44803,
            "upload_time": "2024-03-06T22:15:44",
            "upload_time_iso_8601": "2024-03-06T22:15:44.076966Z",
            "url": "https://files.pythonhosted.org/packages/38/c9/c64ec69941544561f503fe092f2f32b9117252b2dd22b90368787d2316a2/broadbean-0.14.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-06 22:15:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "QCoDeS",
    "github_project": "broadbean",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "broadbean"
}
        
Elapsed time: 0.27268s