Metadata-Version: 2.1
Name: isx
Version: 1.0.3
Summary: Python-based ISXD file reader
Home-page: https://github.com/inscopix/py_isx
Author: Srinivas Gorur-Shandilya
Author-email: s.gorur_shandilya@bruker.com
Maintainer: Zachary Ip
Maintainer-email: Zachary.Ip@bruker.com
Requires-Python: >=3.9,<4.0
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: beartype >=0.15.0
Requires-Dist: importlib-metadata <8.0.0,>=7.0.1
Requires-Dist: numpy >=1.26.2
Provides-Extra: dev
Requires-Dist: ipykernel >=6.20.1 ; extra == 'dev'
Requires-Dist: debugpy ==1.6 ; extra == 'dev'
Requires-Dist: matplotlib >=3.8.2 ; extra == 'dev'
Requires-Dist: poetry2setup <2.0.0,>=1.1.0 ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs <2.0.0,>=1.4.2 ; extra == 'docs'
Requires-Dist: mkdocs-material-extensions <2.0.0,>=1.1.1 ; extra == 'docs'
Requires-Dist: mkdocs-material <10.0.0,>=9.0.9 ; extra == 'docs'
Requires-Dist: mkdocstrings <0.25.0,>=0.24.0 ; extra == 'docs'
Requires-Dist: mkdocstrings-python <2.0.0,>=1.7.5 ; extra == 'docs'
Requires-Dist: mkdocs-git-revision-date-localized-plugin <2.0.0,>=1.2.2 ; extra == 'docs'
Requires-Dist: mkdocs-git-committers-plugin-2 <3.0.0,>=2.2.3 ; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest >=7.2.0 ; extra == 'test'
Requires-Dist: poetry2setup <2.0.0,>=1.1.0 ; extra == 'test'
Requires-Dist: requests <3.0.0,>=2.31.0 ; extra == 'test'

# isx: pure-python API to read Inscopix data

![](https://github.com/inscopix/py_isx/actions/workflows/main.yml/badge.svg) 
![](https://img.shields.io/pypi/v/isx)

This is a pure-python API to read Inscopix ISXD files. 


## Documentation

[Read the documentation](https://inscopix.github.io/py_isx/)

## Support

|  File type | Support |
|  --------- | ------- |
| ISXD CellSet   | ✅ |
| ISXD Movie   | ✅ |
| ISXD Movie (multi-plane)   | ❌ |
| ISXD Movie (dual-color)   | ❌ |
| GPIO data   | ❌ |
| ISXD Events   | ❌ |
| ISXD VesselSet   | ❌ |


## Install

### Poetry

```bash
poetry add isx
```

### pip


```bash
pip install isx
```

## Caution

This is a work in progress, and all reading functions in the IDPS Python API are not supported yet. 


## Testing

This code is tested using GitHub Actions on the following python
versions:

- 3.9
- 3.10
- 3.11
- 3.12
