python-adc-eval


Namepython-adc-eval JSON
Version 0.3.0 PyPI version JSON
download
home_pageNone
SummaryADC Evaluation Library
upload_time2024-06-25 19:31:21
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9.0
licenseMIT
keywords adc analog-to-digital evaluation eval spectrum
VCS
bugtrack_url
requirements matplotlib
Travis-CI No Travis.
coveralls test coverage No coveralls.
            python-adc-eval |Lint| |PyPi Version| |Codecov| |Codestyle|
=============================================================

A python-based ADC evaluation tool, suitable for standalone or library-based usage

Details
--------

Inspired by
`esynr3z/adc-eval <https://github.com/esynr3z/adc-eval>`__

Performs spectral analysis of a dataset utilizing the Bartlett method. Calculates SFDR, SNDR, as well as harmonics.

.. figure:: analyser.png
   :alt: analyser

   analyser


USAGE
=======

To load the library in a module:

.. code-block:: python

    import adc_eval


Given an array of values representing the output of an ADC, the spectrum can be analyzed with the following:

.. code-block:: python

    import adc_eval

    adc_eval.spectrum.analyze(
        <data>,
        <fft bins>,
        fs=<sample frequency>,
        dr=<dynamicrange/vref>,
        harmonics=<num of harmonics to find>,
        leak=<adjacent bins to filter>,
        window=<window type (rectangular/hanning)>,
        no_plot=<True/False>,
        yaxis=<"power"/"fullscale">
    )


.. |Lint| image:: https://github.com/fronzbot/python-adc-eval/workflows/Lint/badge.svg
   :target: https://github.com/fronzbot/python-adc-eval/actions?query=workflow%3ALint
.. |PyPi Version| image:: https://img.shields.io/pypi/v/python-adc-eval.svg
   :target: https://pypi.org/project/python-adc-eval
.. |Codestyle| image:: https://img.shields.io/badge/code%20style-black-000000.svg
   :target: https://github.com/psf/black
.. |Codecov| image:: https://codecov.io/gh/fronzbot/python-adc-eval/graph/badge.svg?token=156GMQ4NNV 
 :target: https://codecov.io/gh/fronzbot/python-adc-eval

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "python-adc-eval",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9.0",
    "maintainer_email": null,
    "keywords": "adc, analog-to-digital, evaluation, eval, spectrum",
    "author": null,
    "author_email": "Kevin Fronczak <kfronczak@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/54/e9/3ea1748b5cbe3470cc9611aa9a35d66ce99af08bb75c38b459fb4b8f1857/python-adc-eval-0.3.0.tar.gz",
    "platform": "any",
    "description": "python-adc-eval |Lint| |PyPi Version| |Codecov| |Codestyle|\n=============================================================\n\nA python-based ADC evaluation tool, suitable for standalone or library-based usage\n\nDetails\n--------\n\nInspired by\n`esynr3z/adc-eval <https://github.com/esynr3z/adc-eval>`__\n\nPerforms spectral analysis of a dataset utilizing the Bartlett method. Calculates SFDR, SNDR, as well as harmonics.\n\n.. figure:: analyser.png\n   :alt: analyser\n\n   analyser\n\n\nUSAGE\n=======\n\nTo load the library in a module:\n\n.. code-block:: python\n\n    import adc_eval\n\n\nGiven an array of values representing the output of an ADC, the spectrum can be analyzed with the following:\n\n.. code-block:: python\n\n    import adc_eval\n\n    adc_eval.spectrum.analyze(\n        <data>,\n        <fft bins>,\n        fs=<sample frequency>,\n        dr=<dynamicrange/vref>,\n        harmonics=<num of harmonics to find>,\n        leak=<adjacent bins to filter>,\n        window=<window type (rectangular/hanning)>,\n        no_plot=<True/False>,\n        yaxis=<\"power\"/\"fullscale\">\n    )\n\n\n.. |Lint| image:: https://github.com/fronzbot/python-adc-eval/workflows/Lint/badge.svg\n   :target: https://github.com/fronzbot/python-adc-eval/actions?query=workflow%3ALint\n.. |PyPi Version| image:: https://img.shields.io/pypi/v/python-adc-eval.svg\n   :target: https://pypi.org/project/python-adc-eval\n.. |Codestyle| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n   :target: https://github.com/psf/black\n.. |Codecov| image:: https://codecov.io/gh/fronzbot/python-adc-eval/graph/badge.svg?token=156GMQ4NNV \n :target: https://codecov.io/gh/fronzbot/python-adc-eval\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "ADC Evaluation Library",
    "version": "0.3.0",
    "project_urls": {
        "Bug Reports": "https://github.com/fronzbot/python-adc-eval/issues",
        "Source Code": "https://github.com/fronzbot/python-adc-eval"
    },
    "split_keywords": [
        "adc",
        " analog-to-digital",
        " evaluation",
        " eval",
        " spectrum"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "778d0dbf187a06272fb7125127ddd4e65bddd562dee4b88ab5b0c98ae5c0beb8",
                "md5": "cd37a0210ece674aee3307285608f52b",
                "sha256": "0881da4446462e0284d3c806b4fb9e49cbd939f324733617c2f5d4a04e94171e"
            },
            "downloads": -1,
            "filename": "python_adc_eval-0.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cd37a0210ece674aee3307285608f52b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9.0",
            "size": 6971,
            "upload_time": "2024-06-25T19:31:19",
            "upload_time_iso_8601": "2024-06-25T19:31:19.920458Z",
            "url": "https://files.pythonhosted.org/packages/77/8d/0dbf187a06272fb7125127ddd4e65bddd562dee4b88ab5b0c98ae5c0beb8/python_adc_eval-0.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "54e93ea1748b5cbe3470cc9611aa9a35d66ce99af08bb75c38b459fb4b8f1857",
                "md5": "61360b08fb58c75a2c5caf0dfbcc0ffe",
                "sha256": "20166e2ebbfe7138f3e0dd587db8cf05dea2d477219af8d0359a8d4a795919cc"
            },
            "downloads": -1,
            "filename": "python-adc-eval-0.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "61360b08fb58c75a2c5caf0dfbcc0ffe",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9.0",
            "size": 10288,
            "upload_time": "2024-06-25T19:31:21",
            "upload_time_iso_8601": "2024-06-25T19:31:21.564118Z",
            "url": "https://files.pythonhosted.org/packages/54/e9/3ea1748b5cbe3470cc9611aa9a35d66ce99af08bb75c38b459fb4b8f1857/python-adc-eval-0.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-25 19:31:21",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "fronzbot",
    "github_project": "python-adc-eval",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "matplotlib",
            "specs": [
                [
                    "==",
                    "3.9.0"
                ]
            ]
        }
    ],
    "tox": true,
    "lcname": "python-adc-eval"
}
        
Elapsed time: 1.54147s