isx 2.1.0

A python package for interacting with Inscopix data.

pyisx

isx is a python package for interacting with Inscopix data. This package encapsulates the following I/O functionality:

• Reading Inscopix files (.isxd, .isxb, .gpio, .imu)
• Writing Inscopix files (.isxd)
• Exporting Inscopix files to third-party formats (.mp4, .tiff, .csv)

The isx package is built from the pyisx project, a python binding for isxcore, a C++ API for interacting with Inscopix data.

Documentation

For help, please refer to the documentation.

Install

Pre-built binaries of this API can be installed from PyPi.

pip install isx

Note: Currently, pyisx is only supported for x86 architectures, which can be problematic, specifically on the newer Mac computers with Apple Silicon. For usage with Apple Silicon, the Rosetta software must be installed, and the Terminal app must be configured to use this software for automatic translation of x86 binaries to arm64. Read more here on how to configure Rosetta on Mac computers.

Supported Platforms

This library has been built and tested on the following operating systems, for python versions 3.9 - 3.12.

OS	Version	Architecture
macOS	13	x86_64
Ubuntu (Linux)	20.04	x86_64
Windows	11	amd64

Development Guide

This guide documents how to build the python package wheel locally.

1. Clone the repo

Setup the repo and initialize its submodule:

git clone [e-mail]:inscopix/pyisx.git
git submodule update --init

1. Setup isxcore Follow the setup instructions for the C++ isxcore repo.

2. Setup python virtual environment

Create a python virtual environment using venv, specifying the desired python version.

make env PYTHON=python3.13

Note: Currently, pyisx is only supported for x86 architectures, which can be problematic, specifically on the newer Mac computers with Apple Silicon. For usage with Apple Silicon, the Rosetta software must be installed, and the Terminal app must be configured to use this software for automatic translation of x86 binaries to arm64. Read more here on how to configure Rosetta on Mac computers.

In the Rosetta terminal, install Homebrew. This will install Homebrew to the /usr/local directory, indicating an x86 installation

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Next, in Rosetta terminal, install the desired python version using the x86 installation of brew:

/usr/local/bin/brew install python@3.13

To verify the installation worked correctly run the following command:

python3.13 -c "import sysconfig; print(sysconfig.get_platform())"

The output will be macosx-13.0-x86_64 is running x86 version of python, otherwise the output will instead be macosx-13.0-arm64 if running the arm version of python.

3. Build the package

Once the virtual environment is setup, the package can be built.

make build THIRD_PARTY_DIR=/path/to/third/party/dir

4. Run the unit tests

make test THIRD_PARTY_DIR=/path/to/third/party/dir TEST_DATA_DIR=/path/to/test/data/dir

Support

For any questions or bug reports, please open an issue in our issue tracker.