py-shr-parser


Namepy-shr-parser JSON
Version 1.0.0 PyPI version JSON
download
home_pageNone
SummaryPython library for parsing Signal Hound SHR files
upload_time2025-07-24 21:21:12
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords shr signal hound
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ===========================
py-shr-parser
===========================

Overview
--------

Provides tools for parsing and handling Signal Hound spectrum sweep and capture
(SHR) files. These files are generated by Spike, Signal Hound's Spectrum Analyzer
Software, and contain metadata and several spectrum sweeps.

BSD-3 license, (C) 2025 WiSELab-CMU

Documentation
-------------
For API documentation, usage and examples, see the files in the "Documentation" directory. 
The ".rst" files can be read in any text editor or being converted to HTML or PDF
using Sphinx_. Examples can be found in the documentation and tests.

.. _Sphinx: https://www.sphinx-doc.org/en/master/

Installation
------------

.. code-block:: none

    pip install py-shr-parser

Basic Example
-------------
This shows how to open an SHR file and load all the sweep data.

.. code-block:: python

    from shr_parser import ShrFileParser
    with ShrFileParser("foo.shr") as parser:
        sweeps = parser.get_all_sweeps()

The above example is very basic. For more advanced examples, please refer to the Documentation.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "py-shr-parser",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "SHR, Signal Hound",
    "author": null,
    "author_email": "Tom Schmitz <tschmitz@andrew.cmu.edu>",
    "download_url": "https://files.pythonhosted.org/packages/98/74/3a180fa3bba2d0369af0939477d194b988661a87d44b6be70e4fa60bf220/py_shr_parser-1.0.0.tar.gz",
    "platform": null,
    "description": "===========================\npy-shr-parser\n===========================\n\nOverview\n--------\n\nProvides tools for parsing and handling Signal Hound spectrum sweep and capture\n(SHR) files. These files are generated by Spike, Signal Hound's Spectrum Analyzer\nSoftware, and contain metadata and several spectrum sweeps.\n\nBSD-3 license, (C) 2025 WiSELab-CMU\n\nDocumentation\n-------------\nFor API documentation, usage and examples, see the files in the \"Documentation\" directory. \nThe \".rst\" files can be read in any text editor or being converted to HTML or PDF\nusing Sphinx_. Examples can be found in the documentation and tests.\n\n.. _Sphinx: https://www.sphinx-doc.org/en/master/\n\nInstallation\n------------\n\n.. code-block:: none\n\n    pip install py-shr-parser\n\nBasic Example\n-------------\nThis shows how to open an SHR file and load all the sweep data.\n\n.. code-block:: python\n\n    from shr_parser import ShrFileParser\n    with ShrFileParser(\"foo.shr\") as parser:\n        sweeps = parser.get_all_sweeps()\n\nThe above example is very basic. For more advanced examples, please refer to the Documentation.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Python library for parsing Signal Hound SHR files",
    "version": "1.0.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/WiseLabCMU/py-shr-parser/issues",
        "Homepage": "https://github.com/WiseLabCMU/py-shr-parser"
    },
    "split_keywords": [
        "shr",
        " signal hound"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "262a4dd090cf239d8030331a6cb1012497235f294d1041dd77779daa8fad113a",
                "md5": "f8b9715c289f67843d723ee51787250d",
                "sha256": "d9126c328a52729eb7627a3cadd5be318e4b68704c079ef9b0a55f329526b668"
            },
            "downloads": -1,
            "filename": "py_shr_parser-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f8b9715c289f67843d723ee51787250d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 12994,
            "upload_time": "2025-07-24T21:21:11",
            "upload_time_iso_8601": "2025-07-24T21:21:11.684710Z",
            "url": "https://files.pythonhosted.org/packages/26/2a/4dd090cf239d8030331a6cb1012497235f294d1041dd77779daa8fad113a/py_shr_parser-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "98743a180fa3bba2d0369af0939477d194b988661a87d44b6be70e4fa60bf220",
                "md5": "1508c32a4e04354e15ce0aa8268629fb",
                "sha256": "7fde98a13479af7c8376b85c2e1a7f11f5dc1dec22def8c130f331a801165b82"
            },
            "downloads": -1,
            "filename": "py_shr_parser-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "1508c32a4e04354e15ce0aa8268629fb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 11725,
            "upload_time": "2025-07-24T21:21:12",
            "upload_time_iso_8601": "2025-07-24T21:21:12.788841Z",
            "url": "https://files.pythonhosted.org/packages/98/74/3a180fa3bba2d0369af0939477d194b988661a87d44b6be70e4fa60bf220/py_shr_parser-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-24 21:21:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "WiseLabCMU",
    "github_project": "py-shr-parser",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "py-shr-parser"
}
        
Elapsed time: 1.29130s