parallax-app 0.37.5

GUI software for photogrammetry-assisted probe targeting in electrophysiology

Parallax

Parallax is a graphical user interface designed to streamline the process of setting up and performing acute in vivo electrophysiology experiments.

User documentation available on here.

Prerequisites

• Python~=3.8 (Recommended to install via Anaconda or Miniconda)
• PySpin (for Linux or Mac OS users)

Installation

1. Create virtual environment using Python version 3.8 and activate it:

• On Windows:

python -m venv venv
./venv/Scripts/activate

• On Linux/Mac:

python -m venv venv
source venv/bin/activate

2. To install the latest version:

pip install parallax-app

To upgrate to the latest version:

pip install parallax-app --upgrade

3. To install camera interface:

pip install parallax-app[camera]

Running Parallax

python -m parallax

Development mode

1. Clone the repository:

git clone https://github.com/AllenNeuralDynamics/parallax.git

2. Install Dependencies:

pip install -e .[dev]

Documentation

1. To install the dependencies:

pip install -e .[docs]

2. Then to create the documentation html files, run:

sphinx-build -b html docs/ docs/_build

Additional Setup for Linux and Mac OS

For Linux or Mac OS, you'll need to install PySpin manually (not required for Windows):

• download the Spinnaker SDK package for your system from here
• follow the installation instructions in the README
• Install the Python bindings found alongside the SDK package

Support and Contribution

If you encounter any issues or would like to contribute to the project, please check out our issues page on GitHub.

License

Parallax is licensed under the MIT License. For more details, see the LICENSE file.