Metadata-Version: 2.4
Name: sonpy
Version: 1.9.12
Summary: SonPy is a Python module that provides an interface to the 64 bit SON filing system, provided and maintained by CED. With it, you can read, write and create Spike2 data files from within Python.
Author-email: CED <softhelp@ced.co.uk>
License: SonPy, the Python interface to the 64-bit SON library by CED
        Copyright (C) 2020 Cambridge Electronic Design Ltd.
        
        This program is free software: you can redistribute it and/or modify
        it under the terms of the GNU General Public License as published by
        the Free Software Foundation, either version 3 of the License, or
        (at your option) any later version.
        
        This program is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        GNU General Public License for more details.
        
        You should have received a copy of the GNU General Public License
        along with this program.  If not, see <https://www.gnu.org/licenses/>.
Keywords: sonpy,Spike2,CED
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: license.txt
Dynamic: license-file

# SonPy
SonPy is a Python interface to the SON filing system, provided and maintained by CED. With it, you can read, write and create Spike2 data files from within Python. SonPy is available for multiple versions of Python 3 on Windows, Linux, and Mac. We expect it to be very portable, working on multiple versions of each OS, but we cannot guarantee this to be the case. It is provided ‘as is’ with no warranty. A test script which verifies all of Sonpy's functionality can be downloaded from the CED website.

# How to use

## Installation

Install SonPy using:

```bash
pip install sonpy
```

If your system has multiple Python installations, you may need to use:

```bash
pip3 install sonpy
```

## Dependency

SonPy requires NumPy. If it is not already installed, you can install it using:

```bash
pip install numpy
```

## Verification

To verify that the package is installed and importable:

```bash
python -c "import sonpy as sp; print(sp)"
```

To verify the sonpy version:

```bash
python -c "import sonpy as sp; print(sp.__version__)"
```

Or in a Python session:

```python
import sonpy as sp
```

---

## Support

Further guidance on how to use this library is available on the CED website.

For questions or support, contact a SonPy maintainer or email:

```
softhelp@ced.co.uk
```
