Metadata-Version: 2.1
Name: LoadWaveSurfer
Version: 1.0.1
Summary: Load and parse ephys data acquired using Janelia's WaveSurfer.
Author-email: Raul Mojica <rmojica@mit.edu>
License: MIT License
        
        Copyright (c) 2022 Raúl Mojica Soto-Albors
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/ralbso/LoadWaveSurfer
Project-URL: Bug Tracker, https://github.com/ralbso/LoadWaveSurfer/issues
Keywords: wavesurfer,loader,parser
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: Microsoft :: Windows
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

![PyPI](https://img.shields.io/pypi/v/LoadWaveSurfer?color=g)
# LoadWaveSurfer
 Load and parse ephys data acquired using Janelia's WaveSurfer.

## Example usage
```
from loadwavesurfer import loadws

# initialize loadws object
f = loadws(inputFile, filter=False)

# access the data as a named tuple
f.data()

# or individually
f.data().volt
f.data().curr
f.data().time

# and their units
voltage_units, current_units, time_units = f.units()

# reconstruct current or voltage stimulation parameters
f.stimParams()

# get sampling rate
f.sampleRate()

# get timestamp at start of recording, in UNIX time
f.clock()
```
