Metadata-Version: 2.4
Name: navigate-micro
Version: 0.0.9
Summary: Open source, smart, light-sheet microscopy control software.
Author: The Dean Lab, UT Southwestern Medical Center
Project-URL: Source, https://github.com/TheDeanLab/navigate
Classifier: Intended Audience :: Developers
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.9.7
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: matplotlib-inline==0.1.3
Requires-Dist: PyYAML==6.0
Requires-Dist: pyserial==3.5
Requires-Dist: PIPython==2.6.0.1
Requires-Dist: nidaqmx==0.5.7
Requires-Dist: tifffile==2021.11.2
Requires-Dist: scipy==1.7.3
Requires-Dist: pyusb==1.2.1
Requires-Dist: pandas==1.3.5
Requires-Dist: pandastable==0.12.2.post1
Requires-Dist: opencv-python==4.5.5.62
Requires-Dist: numpy==1.22.0; sys_platform != "darwin"
Requires-Dist: numpy==1.21.6; sys_platform == "darwin"
Requires-Dist: scikit-image==0.19.1
Requires-Dist: zarr==2.14.2
Requires-Dist: fsspec==2022.8.2; sys_platform != "darwin"
Requires-Dist: fsspec==2022.5.0; sys_platform == "darwin"
Requires-Dist: h5py==3.7.0
Requires-Dist: requests==2.28.1
Requires-Dist: psutil==6.0.0
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-xvfb; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: pytest-rerunfailures; extra == "dev"
Requires-Dist: ipykernel; extra == "dev"
Requires-Dist: jupyterlab; extra == "dev"
Requires-Dist: pydantic-ome-ngff==0.5.3; extra == "dev"
Provides-Extra: docs
Requires-Dist: numpydoc; extra == "docs"
Requires-Dist: nbconvert; extra == "docs"
Requires-Dist: sphinx<6.0.0; extra == "docs"
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: sphinx-issues; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Requires-Dist: pyyaml; extra == "docs"
Requires-Dist: pydata_sphinx_theme==0.10.0rc2; extra == "docs"
Requires-Dist: sphinx-toolbox; extra == "docs"
Provides-Extra: robot
Requires-Dist: mecademicpy; extra == "robot"
Dynamic: license-file

<h1 align="center">
<img src="https://github.com/TheDeanLab/navigate/blob/develop/src/navigate/view/icon/mic.ico?raw=true" />

navigate
<h2 align="center">
	open source light sheet microscope control
</h2>
</h1>


[![Tests](https://github.com/TheDeanLab/navigate/actions/workflows/push_checks.yaml/badge.svg)](https://github.com/TheDeanLab/navigate/actions/workflows/push_checks.yaml)
[![codecov](https://codecov.io/gh/TheDeanLab/navigate/branch/develop/graph/badge.svg?token=270RFSZGG5)](https://codecov.io/gh/TheDeanLab/navigate)

**navigate** is an open source Python package for control of light-sheet microscopes.
It allows for easily reconfigurable hardware setups and automated acquisition routines.

### Quick install

Download and install [Miniconda](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links).

```
conda create -n navigate python=3.9.7
conda activate navigate
pip install git+https://github.com/TheDeanLab/navigate.git
```

To test, run `conda activate navigate` and launch in synthetic hardware mode with `navigate
-sh`. Developers will have to install additional dependencies with
`pip install -e '.[dev]'`.
### Documentation
Please refer to and contribute to the documentation, which can be found on GitHub Pages: [https://thedeanlab.github.io/navigate/](https://thedeanlab.github.io/navigate/).

### Command Line Arguments

Below are the optional arguments that can be passed to the navigate software:

- `-h, --help`
  Provides information on the optional arguments that can be passed to **navigate**.
- `-sh, --synthetic_hardware`
  Open the software without any hardware attached for testing
  and setting up a new system.
- `-c, --configurator`
  Open the **navigate** configuration wizard, which provides a
  graphical interface for setting up the hardware configuration.
- `-d`
  Enables the debugging menu in the software.
- `--config-file`
  Pass a non-default `configuration.yaml` file to **navigate**.
- `--experiment_file`
  Pass a non-default `experiment.yaml` file to **navigate**.
- `--gui-config-file`
  Pass a non-default `gui_config.yaml` file to **navigate**.
- `--waveform-constants-file`
  Pass a non-default waveform constants file to **navigate**.
- `--rest_api_file`
  Pass a non-default REST API file to **navigate**.
- `--logging_config`
  Pass a non-default logging configuration file to **navigate**.
