dsptoolbox


Namedsptoolbox JSON
Version 0.4.7 PyPI version JSON
download
home_pageNone
SummaryCollection of dsp algorithms to be used for analysis of audio signals
upload_time2024-10-24 10:19:05
maintainerNone
docs_urlNone
authorNicolas Franco-Gomez
requires_python>=3.10
licenseNone
keywords digital signal processing prototyping research dsp
VCS
bugtrack_url
requirements scipy numpy soundfile sounddevice numba matplotlib seaborn hatch wheel twine flake8 pytest ipykernel ipympl notebook furo numpydoc sphinx readthedocs-sphinx-search autodocsumm
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. image:: docs/logo/logo.png
   :width: 800
   :align: center

------------------------------------------------------------------------------

.. image:: https://readthedocs.org/projects/dsptoolbox/badge/?version=latest
    :target: https://dsptoolbox.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://img.shields.io/pypi/l/dsptoolbox?color=gr
    :target: https://en.wikipedia.org/wiki/MIT_License
    :alt: License

.. image:: https://img.shields.io/pypi/pyversions/dsptoolbox
    :target: https://www.python.org/downloads/release/python-3100/
    :alt: Python version

.. image:: https://img.shields.io/pypi/v/dsptoolbox?color=orange
    :target: https://pypi.org/project/dsptoolbox/
    :alt: PyPI version

Readme
======

This is a toolbox in form of a python package that contains algorithms to be used in dsp (digital signal processing) research projects.

This is kind of a "sandbox" project with many different experimental implementations across a variety of DSP-related topics. Some parts are more
thoroughly tested and validated than others, so "caution" is advised. Please feel free to reach out in case you find bugs or want
to talk about certain functionality.

It is under active development and it will take some time until it reaches a certain level of maturity. Beware that backwards compatibility is not an actual concern and significant
changes to the API might come in the future. If you find some implementations interesting or useful, please feel free to use it for your projects
and expand or change functionalities.

Getting Started
===============

Check out the `examples`_ for some basic examples of the dsptoolbox package
and refer to the `documentation`_ for the complete description of classes and functions.

Installation
============

Use pip to install dsptoolbox

.. code-block:: console

    $ pip install dsptoolbox

(Requires Python 3.10 or higher)

In order to install the package successfully using Linux, you need to install
PortAudio manually, since installing `sounddevice`_ will not do it automatically. To do this,
run the following commands on your console:

.. code-block:: console

    $ sudo apt-get install libasound-dev libportaudio2 libsndfile1

If this does not work properly for some reason, refer to the documentation for
`sounddevice`_ or `PortAudio`_.

.. _documentation: http://dsptoolbox.readthedocs.io/
.. _examples: https://github.com/nico-franco-gomez/dsptoolbox/tree/main/examples
.. _sounddevice: https://python-sounddevice.readthedocs.io/en/0.4.5/
.. _PortAudio: http://www.portaudio.com

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "dsptoolbox",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "Digital Signal Processing, Prototyping, Research, dsp",
    "author": "Nicolas Franco-Gomez",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/cf/a6/6830201e6b42c4e62176c1fe0d69f66b8216d85612b226644281a10f320f/dsptoolbox-0.4.7.tar.gz",
    "platform": null,
    "description": ".. image:: docs/logo/logo.png\n   :width: 800\n   :align: center\n\n------------------------------------------------------------------------------\n\n.. image:: https://readthedocs.org/projects/dsptoolbox/badge/?version=latest\n    :target: https://dsptoolbox.readthedocs.io/en/latest/?badge=latest\n    :alt: Documentation Status\n\n.. image:: https://img.shields.io/pypi/l/dsptoolbox?color=gr\n    :target: https://en.wikipedia.org/wiki/MIT_License\n    :alt: License\n\n.. image:: https://img.shields.io/pypi/pyversions/dsptoolbox\n    :target: https://www.python.org/downloads/release/python-3100/\n    :alt: Python version\n\n.. image:: https://img.shields.io/pypi/v/dsptoolbox?color=orange\n    :target: https://pypi.org/project/dsptoolbox/\n    :alt: PyPI version\n\nReadme\n======\n\nThis is a toolbox in form of a python package that contains algorithms to be used in dsp (digital signal processing) research projects.\n\nThis is kind of a \"sandbox\" project with many different experimental implementations across a variety of DSP-related topics. Some parts are more\nthoroughly tested and validated than others, so \"caution\" is advised. Please feel free to reach out in case you find bugs or want\nto talk about certain functionality.\n\nIt is under active development and it will take some time until it reaches a certain level of maturity. Beware that backwards compatibility is not an actual concern and significant\nchanges to the API might come in the future. If you find some implementations interesting or useful, please feel free to use it for your projects\nand expand or change functionalities.\n\nGetting Started\n===============\n\nCheck out the `examples`_ for some basic examples of the dsptoolbox package\nand refer to the `documentation`_ for the complete description of classes and functions.\n\nInstallation\n============\n\nUse pip to install dsptoolbox\n\n.. code-block:: console\n\n    $ pip install dsptoolbox\n\n(Requires Python 3.10 or higher)\n\nIn order to install the package successfully using Linux, you need to install\nPortAudio manually, since installing `sounddevice`_ will not do it automatically. To do this,\nrun the following commands on your console:\n\n.. code-block:: console\n\n    $ sudo apt-get install libasound-dev libportaudio2 libsndfile1\n\nIf this does not work properly for some reason, refer to the documentation for\n`sounddevice`_ or `PortAudio`_.\n\n.. _documentation: http://dsptoolbox.readthedocs.io/\n.. _examples: https://github.com/nico-franco-gomez/dsptoolbox/tree/main/examples\n.. _sounddevice: https://python-sounddevice.readthedocs.io/en/0.4.5/\n.. _PortAudio: http://www.portaudio.com\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Collection of dsp algorithms to be used for analysis of audio signals",
    "version": "0.4.7",
    "project_urls": {
        "Bug Tracker": "https://github.com/nico-franco-gomez/dsptoolbox/issues",
        "Documentation": "https://dsptoolbox.readthedocs.io/en/latest/",
        "Homepage": "https://github.com/nico-franco-gomez/dsptoolbox"
    },
    "split_keywords": [
        "digital signal processing",
        " prototyping",
        " research",
        " dsp"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b984ed345f0ae7f07926c145b2696d5501ecf627c330af1db50a447c98204b55",
                "md5": "1379e18c2caa0e5fb38fdc37c69716d6",
                "sha256": "7bb25eca8bebd6394506acd7b3fcd3cc2d081d492d5b249402a18302e1c0c68b"
            },
            "downloads": -1,
            "filename": "dsptoolbox-0.4.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1379e18c2caa0e5fb38fdc37c69716d6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 239305,
            "upload_time": "2024-10-24T10:17:46",
            "upload_time_iso_8601": "2024-10-24T10:17:46.013350Z",
            "url": "https://files.pythonhosted.org/packages/b9/84/ed345f0ae7f07926c145b2696d5501ecf627c330af1db50a447c98204b55/dsptoolbox-0.4.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cfa66830201e6b42c4e62176c1fe0d69f66b8216d85612b226644281a10f320f",
                "md5": "7db61ae287d0ab73634401391bff6fb4",
                "sha256": "49f8c08b0216da7d0174fc1c11d8fa6f366d7dd688858596c1359f8e1cad7008"
            },
            "downloads": -1,
            "filename": "dsptoolbox-0.4.7.tar.gz",
            "has_sig": false,
            "md5_digest": "7db61ae287d0ab73634401391bff6fb4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 6321920,
            "upload_time": "2024-10-24T10:19:05",
            "upload_time_iso_8601": "2024-10-24T10:19:05.362135Z",
            "url": "https://files.pythonhosted.org/packages/cf/a6/6830201e6b42c4e62176c1fe0d69f66b8216d85612b226644281a10f320f/dsptoolbox-0.4.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-24 10:19:05",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nico-franco-gomez",
    "github_project": "dsptoolbox",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "scipy",
            "specs": [
                [
                    "~=",
                    "1.12"
                ]
            ]
        },
        {
            "name": "numpy",
            "specs": [
                [
                    "~=",
                    "2.0"
                ]
            ]
        },
        {
            "name": "soundfile",
            "specs": [
                [
                    "~=",
                    "0.12"
                ]
            ]
        },
        {
            "name": "sounddevice",
            "specs": [
                [
                    "~=",
                    "0.4"
                ]
            ]
        },
        {
            "name": "numba",
            "specs": [
                [
                    "~=",
                    "0.60"
                ]
            ]
        },
        {
            "name": "matplotlib",
            "specs": [
                [
                    "~=",
                    "3.8"
                ]
            ]
        },
        {
            "name": "seaborn",
            "specs": [
                [
                    "~=",
                    "0.12"
                ]
            ]
        },
        {
            "name": "hatch",
            "specs": []
        },
        {
            "name": "wheel",
            "specs": []
        },
        {
            "name": "twine",
            "specs": []
        },
        {
            "name": "flake8",
            "specs": []
        },
        {
            "name": "pytest",
            "specs": []
        },
        {
            "name": "ipykernel",
            "specs": []
        },
        {
            "name": "ipympl",
            "specs": []
        },
        {
            "name": "notebook",
            "specs": []
        },
        {
            "name": "furo",
            "specs": []
        },
        {
            "name": "numpydoc",
            "specs": []
        },
        {
            "name": "sphinx",
            "specs": []
        },
        {
            "name": "readthedocs-sphinx-search",
            "specs": []
        },
        {
            "name": "autodocsumm",
            "specs": []
        }
    ],
    "tox": true,
    "lcname": "dsptoolbox"
}
        
Elapsed time: 0.89372s