| Name | parallax-app JSON |
| Version |
1.10.0
JSON |
| download |
| home_page | None |
| Summary | GUI software for photogrammetry-assisted probe targeting in electrophysiology |
| upload_time | 2025-07-14 22:46:09 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | ~=3.8 |
| license | MIT |
| keywords |
parallax
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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](https://parallax.readthedocs.io/en/latest/index.html).
### Prerequisites
- **Python==3.8** (Recommended to install via
[Anaconda](https://www.anaconda.com/products/individual) or
[Miniconda](https://docs.conda.io/en/latest/miniconda.html))
- Python 3.8 is required for the Spinnaker library.
- PySpin (for Linux or Mac OS users)
- [Spinnaker SDK](https://www.teledynevisionsolutions.com/products/spinnaker-sdk)
### Installation
1. Create a virtual environment with **Python 3.8** and activate it:
- On Windows:
```bash
conda create -n parallax python=3.8
conda activate parallax
```
2. To install Parallax into a fresh environment, run:
```bash
pip install parallax-app
```
To upgrade to the latest version, run:
```bash
pip install parallax-app --upgrade
```
3. To install the camera interface:
```bash
pip install parallax-app[camera]
```
#### Additional Setup for Linux and macOS
* Download the Spinnaker SDK package for your system [here](https://flir.app.boxcn.net/v/SpinnakerSDK)
* Follow the installation instructions in the README
* Install the Python bindings found alongside the SDK package
### Running Parallax
```bash
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](https://github.com/magicleap/SuperGluePretrainedNetwork) before use.
Manual Setup Instructions
Clone the repository into the external/ folder in your Parallax project root:
```bash
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:
```bash
parallax/
├── external/
│ └── SuperGluePretrainedNetwork/
│ └── models/
│ ├── superpoint.py
│ └── weights/
│ ├── superpoint_v1.pth
│ └── superglue_indoor.pth
```
### For developers:
1. Clone the repository:
```bash
git clone https://github.com/AllenNeuralDynamics/parallax.git
```
2. Install the package along with dev dependencies:
```bash
pip install -e .[dev]
```
### Documentation
1. To install the dependencies:
```bash
pip install -e .[docs]
```
2. Then to create the documentation html files, run:
```bash
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](https://github.com/AllenNeuralDynamics/parallax/issues)
on GitHub.
### License
Parallax is licensed under the MIT License. For more details, see
the [LICENSE](LICENSE) file.
Raw data
{
"_id": null,
"home_page": null,
"name": "parallax-app",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.8",
"maintainer_email": null,
"keywords": "parallax",
"author": null,
"author_email": "Hanna Lee <hanna.lee@alleninstitute.org>",
"download_url": "https://files.pythonhosted.org/packages/b2/98/e52acc462a65ebaf6c6a61251188aac5cbc7409195ceda64734c07ba9af4/parallax_app-1.10.0.tar.gz",
"platform": null,
"description": "# Parallax\n\n\n\nParallax is a graphical user interface designed to streamline the process of \nsetting up and performing acute *in vivo* electrophysiology experiments.\n\n**Documentation**: [parallax.readthedocs.io](https://parallax.readthedocs.io/en/latest/index.html).\n\n### Prerequisites\n- **Python==3.8** (Recommended to install via \n[Anaconda](https://www.anaconda.com/products/individual) or \n[Miniconda](https://docs.conda.io/en/latest/miniconda.html))\n - Python 3.8 is required for the Spinnaker library.\n- PySpin (for Linux or Mac OS users)\n- [Spinnaker SDK](https://www.teledynevisionsolutions.com/products/spinnaker-sdk)\n\n\n### Installation\n1. Create a virtual environment with **Python 3.8** and activate it:\n- On Windows:\n```bash\nconda create -n parallax python=3.8\nconda activate parallax\n```\n\n2. To install Parallax into a fresh environment, run:\n```bash\npip install parallax-app\n```\n\nTo upgrade to the latest version, run:\n```bash\npip install parallax-app --upgrade\n```\n\n3. To install the camera interface:\n```bash\npip install parallax-app[camera]\n```\n\n#### Additional Setup for Linux and macOS\n* Download the Spinnaker SDK package for your system [here](https://flir.app.boxcn.net/v/SpinnakerSDK)\n* Follow the installation instructions in the README\n* Install the Python bindings found alongside the SDK package\n\n### Running Parallax\n```bash\npython -m parallax\n```\n\n### Optional: Enable SuperPoint + SuperGlue Reticle Detection\nParallax supports reticle detection using SuperPoint + LightGlue.\nTo enable reticle detection using SuperPoint + SuperGlue, you must manually download 'SuperGluePretrainedNetwork' pretrained models.\n\nThe SuperGluePretrainedNetwork is not included in this repository and is distributed under its own licensing terms.\nPlease review their [license](https://github.com/magicleap/SuperGluePretrainedNetwork) before use.\n\nManual Setup Instructions\nClone the repository into the external/ folder in your Parallax project root:\n```bash\npip install git+https://github.com/AllenNeuralDynamics/sfm.git@main\ngit clone https://github.com/magicleap/SuperGluePretrainedNetwork.git external/SuperGluePretrainedNetwork\n```\nVerify your folder structure looks like this:\n```bash\nparallax/\n\u251c\u2500\u2500 external/\n\u2502 \u2514\u2500\u2500 SuperGluePretrainedNetwork/\n\u2502 \u2514\u2500\u2500 models/\n\u2502 \u251c\u2500\u2500 superpoint.py\n\u2502 \u2514\u2500\u2500 weights/\n\u2502 \u251c\u2500\u2500 superpoint_v1.pth\n\u2502 \u2514\u2500\u2500 superglue_indoor.pth\n```\n\n### For developers:\n1. Clone the repository:\n```bash\ngit clone https://github.com/AllenNeuralDynamics/parallax.git\n```\n2. Install the package along with dev dependencies:\n```bash\npip install -e .[dev]\n```\n\n### Documentation\n1. To install the dependencies:\n```bash\npip install -e .[docs]\n```\n2. Then to create the documentation html files, run:\n```bash\nsphinx-build -b html docs/ docs/_build\n```\n\n### Support and Contribution\nIf you encounter any problems or would like to contribute to the project, \nplease submit an [Issue](https://github.com/AllenNeuralDynamics/parallax/issues) \non GitHub.\n\n### License\nParallax is licensed under the MIT License. For more details, see \nthe [LICENSE](LICENSE) file.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "GUI software for photogrammetry-assisted probe targeting in electrophysiology",
"version": "1.10.0",
"project_urls": null,
"split_keywords": [
"parallax"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "47c88469030804dddd3e9b234dbec79f1dd2424fb9db874daeee70acce04418f",
"md5": "5db015f026a4012f69cf1c59cc0510cd",
"sha256": "6cafa0586a3f35e9fef9426ef02c91ae8d63e9aae3973383e9afdc04c6458e99"
},
"downloads": -1,
"filename": "parallax_app-1.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5db015f026a4012f69cf1c59cc0510cd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 2578898,
"upload_time": "2025-07-14T22:46:07",
"upload_time_iso_8601": "2025-07-14T22:46:07.244693Z",
"url": "https://files.pythonhosted.org/packages/47/c8/8469030804dddd3e9b234dbec79f1dd2424fb9db874daeee70acce04418f/parallax_app-1.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b298e52acc462a65ebaf6c6a61251188aac5cbc7409195ceda64734c07ba9af4",
"md5": "d0acf82c7d556765dfdb6b2bf3153469",
"sha256": "7e4ad494811ff5aa96e50e04d7960d565cd082e85c2d01bdf3be99cc5751527a"
},
"downloads": -1,
"filename": "parallax_app-1.10.0.tar.gz",
"has_sig": false,
"md5_digest": "d0acf82c7d556765dfdb6b2bf3153469",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 57777416,
"upload_time": "2025-07-14T22:46:09",
"upload_time_iso_8601": "2025-07-14T22:46:09.500252Z",
"url": "https://files.pythonhosted.org/packages/b2/98/e52acc462a65ebaf6c6a61251188aac5cbc7409195ceda64734c07ba9af4/parallax_app-1.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-14 22:46:09",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "parallax-app"
}
