Parallax
Parallax is a graphical user interface designed to streamline the process of setting up and performing acute in vivo electrophysiology experiments.
Documentation: parallax.readthedocs.io.
Prerequisites
- Python==3.10 (Recommended to install via
Anaconda or
Miniconda)
- Python 3.10 is required for the Spinnaker library.
- Spinnaker SDK 4.2
Installation
- Create a virtual environment with Python 3.10 and activate it:
- Install Parallax:
pip install parallax-app
To upgrade to the latest version, run:
pip install parallax-app --upgrade
- Install the camera interface Spinnaker SDK 4.2
# Install from the **wheel file** that comes with the Spinnaker SDK ver.4.2.
# Replace **<WHEEL_PATH>** with the *full path* to your `.whl`:
pip install "<WHEEL_PATH>"
Running Parallax
python -m parallax
Optional: Enable SuperPoint + SuperGlue Reticle Detection
Parallax supports reticle detection using SuperPoint + LightGlue. To enable reticle detection using SuperPoint + SuperGlue, you must manually download 'SuperGluePretrainedNetwork' pretrained models.
The SuperGluePretrainedNetwork is not included in this repository and is distributed under its own licensing terms. Please review their license before use.
Manual Setup Instructions
- Clone the repository if it hasn't been done already.
git clone https://github.com/AllenNeuralDynamics/parallax.git
- Clone the repository into the external/ folder in your Parallax project root:
pip install git+https://github.com/AllenNeuralDynamics/sfm.git@main
git clone https://github.com/magicleap/SuperGluePretrainedNetwork.git external/SuperGluePretrainedNetwork
- Verify your folder structure looks like this:
parallax/
├── external/
│ └── SuperGluePretrainedNetwork/
│ └── models/
│ ├── superpoint.py
│ └── weights/
│ ├── superpoint_v1.pth
│ └── superglue_indoor.pth
For developers:
- Clone the repository:
git clone https://github.com/AllenNeuralDynamics/parallax.git
- Install the package along with dev dependencies:
pip install -e .[dev]
Documentation
- To install the dependencies:
pip install -e .[docs]
- Then to create the documentation html files, run:
sphinx-build -b html docs/ docs/_build
Support and Contribution
If you encounter any problems or would like to contribute to the project, please submit an Issue on GitHub.
License
Parallax is licensed under the MIT License. For more details, see the LICENSE file.
2 maintainers
Metadata
2 maintainers
Release files for parallax-app 1.16.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| parallax_app-1.16.2.tar.gz | 81.8 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| parallax_app-1.16.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 85.0 MB
Release files / parallax_app-1.16.2.tar.gz
| Download URL | parallax_app-1.16.2.tar.gz |
|---|---|
| Size | 81.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8ef2f6a8182018cfce47d2493d06075ac33ca98fffabe2885c98a685136de541
|
|
BLAKE2b-256 checksum How to use checksums |
c80b1eb3dfc6d8e28e5ca2c5f87ae15a0723f96a3bff1c5f1be81d45cdb2ccb8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Release files / parallax_app-1.16.2-py3-none-any.whl
| Download URL | parallax_app-1.16.2-py3-none-any.whl |
|---|---|
| Size | 3.1 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9937c65975d004dad69c11a6dcc7d2a025db7b21d598e3fe759d80b4709eedf0
|
|
BLAKE2b-256 checksum How to use checksums |
10014c14d27d2eaae75cb01b8d8f92ccc0d93ea5fdb702fdb7ac7fbe7f53af3f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
