Metadata-Version: 2.1
Name: parallax-app
Version: 0.37.6
Summary: GUI software for photogrammetry-assisted probe targeting in electrophysiology
Author-email: Hanna Lee <hanna.lee@alleninstitute.org>
License: MIT
Keywords: parallax
Classifier: Programming Language :: Python :: 3
Requires-Python: ~=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pip
Requires-Dist: PyQt5>=5.15
Requires-Dist: pyqtgraph
Requires-Dist: opencv-python
Requires-Dist: scipy
Requires-Dist: pandas
Requires-Dist: scikit-image
Requires-Dist: requests
Requires-Dist: scikit-learn
Provides-Extra: dev
Requires-Dist: parallax-app[linters]; extra == "dev"
Provides-Extra: camera
Requires-Dist: spinnaker-python; extra == "camera"
Provides-Extra: linters
Requires-Dist: codespell; extra == "linters"
Requires-Dist: coverage; extra == "linters"
Requires-Dist: flake8; extra == "linters"
Requires-Dist: interrogate; extra == "linters"
Requires-Dist: isort; extra == "linters"
Requires-Dist: pytest-mock; extra == "linters"
Provides-Extra: docs
Requires-Dist: Sphinx; extra == "docs"
Requires-Dist: sphinx-jinja; extra == "docs"
Requires-Dist: furo; extra == "docs"

# Parallax

![Parallax](ui/ParallaxReadME.JPG)

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](https://parallax.readthedocs.io/en/latest/).

### 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))
- PySpin (for Linux or Mac OS users)


### Installation
1. Create virtual environment using **Python version 3.8** and activate it:
- On Windows:
```bash
python -m venv venv
./venv/Scripts/activate
```
- On Linux/Mac:
```bash
python -m venv venv
source venv/bin/activate
```

2. To install the latest version:
```bash
pip install parallax-app
```
To upgrate to the latest version:
```bash
pip install parallax-app --upgrade
```

3. To install camera interface:
```bash
pip install parallax-app[camera]
```

### Running Parallax
```bash
python -m parallax
```

### Development mode
1. Clone the repository:
```bash
git clone https://github.com/AllenNeuralDynamics/parallax.git
```
2. Install 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
```

### 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](https://flir.app.boxcn.net/v/SpinnakerSDK)
* 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.
