Metadata-Version: 2.4
Name: py-shr-parser
Version: 1.0.0
Summary: Python library for parsing Signal Hound SHR files
Author-email: Tom Schmitz <tschmitz@andrew.cmu.edu>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://github.com/WiseLabCMU/py-shr-parser
Project-URL: Bug Tracker, https://github.com/WiseLabCMU/py-shr-parser/issues
Keywords: SHR,Signal Hound
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: matplotlib
Dynamic: license-file

===========================
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.
