Metadata-Version: 2.1
Name: slmsuite
Version: 0.5.0
Summary: Package for high-performance spatial light modulator (SLM) control and holography.
Author-email: "Holodyne Labs, Inc." <slmsuite@holodyne.com>
Project-URL: Homepage, https://github.com/holodyne/slmsuite
Project-URL: Documentation, https://slmsuite.holodyne.com/en/latest/
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: opencv-python
Requires-Dist: matplotlib
Requires-Dist: h5py
Requires-Dist: tqdm
Provides-Extra: cameras
Requires-Dist: pylablib ; extra == 'cameras'
Requires-Dist: pymmcore ; extra == 'cameras'
Requires-Dist: pypylon ; extra == 'cameras'
Requires-Dist: instrumental-lib ; extra == 'cameras'
Provides-Extra: dev
Requires-Dist: slmsuite[test] ; extra == 'dev'
Requires-Dist: slmsuite[jupyter] ; extra == 'dev'
Requires-Dist: slmsuite[docs] ; extra == 'dev'
Requires-Dist: slmsuite[gpu] ; extra == 'dev'
Requires-Dist: slmsuite[torch] ; extra == 'dev'
Requires-Dist: slmsuite[slms] ; extra == 'dev'
Requires-Dist: slmsuite[cameras] ; extra == 'dev'
Requires-Dist: line-profiler ; extra == 'dev'
Requires-Dist: snakeviz ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: nbsphinx ; extra == 'docs'
Requires-Dist: IPython ; extra == 'docs'
Requires-Dist: docutils ; extra == 'docs'
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: sphinx-copybutton ; extra == 'docs'
Requires-Dist: sphinx-last-updated-by-git ; extra == 'docs'
Requires-Dist: requests ; extra == 'docs'
Requires-Dist: pypandoc-binary ; extra == 'docs'
Requires-Dist: pydata-sphinx-theme ; extra == 'docs'
Requires-Dist: sphinx-design ; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints ; extra == 'docs'
Provides-Extra: gpu
Requires-Dist: cupy-cuda13x ; extra == 'gpu'
Provides-Extra: images
Requires-Dist: imageio ; extra == 'images'
Requires-Dist: pygifsicle ; extra == 'images'
Requires-Dist: av ; extra == 'images'
Provides-Extra: jupyter
Requires-Dist: jupyter ; extra == 'jupyter'
Requires-Dist: ipywidgets ; extra == 'jupyter'
Requires-Dist: ipyevents ; extra == 'jupyter'
Requires-Dist: slmsuite[images] ; extra == 'jupyter'
Provides-Extra: slms
Requires-Dist: pyglet ; extra == 'slms'
Requires-Dist: hidapi ; extra == 'slms'
Requires-Dist: pyyaml ; extra == 'slms'
Provides-Extra: test
Requires-Dist: imageio ; extra == 'test'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-benchmark ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: pytest-subtests ; extra == 'test'
Requires-Dist: pytest-notebook ; extra == 'test'
Requires-Dist: nbformat ; extra == 'test'
Requires-Dist: pyyaml ; extra == 'test'
Requires-Dist: ipywidgets ; extra == 'test'
Provides-Extra: torch
Requires-Dist: torch ; extra == 'torch'

<p align="center">
<img alt="slmsuite" src="https://raw.githubusercontent.com/holodyne/slmsuite/main/docs/source/static/slmsuite.svg" width="256">
</p>

<h2 align="center">High-Performance Spatial Light Modulator Control and Holography</h2>

<p align="center">
<a href="https://slmsuite.holodyne.com/en/latest"><img alt="Documentation Status" src="https://readthedocs.org/projects/slmsuite/badge/?version=latest"></a>
<a href="https://github.com/holodyne/slmsuite/blob/main/LICENSE"><img alt="License: MIT" src="https://img.shields.io/github/license/holodyne/slmsuite?color=purple"></a>
<!--<a href="https://pepy.tech/project/slmsuite"><img alt="Downloads" src="https://pepy.tech/badge/slmsuite"></a>-->
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
<a href="https://github.com/holodyne/slmsuite"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/holodyne/slmsuite"></a>
</p>

## Installation

Install the stable version of `slmsuite` from [PyPI](https://pypi.org/project/slmsuite/) using:

```console
$ pip install slmsuite
```


Install the latest version of `slmsuite` from GitHub using:

```console
$ pip install git+https://github.com/holodyne/slmsuite
```

## Documentation and Examples

Extensive
[documentation](https://slmsuite.holodyne.com/en/latest/)
and
[API reference](https://slmsuite.holodyne.com/en/latest/api.html)
are available through readthedocs.

Examples can be found embedded in
[documentation](https://slmsuite.holodyne.com/en/latest/examples.html)
or directly in
[source](https://github.com/holodyne/slmsuite-examples).


<p align="center">
<img alt="qp-slm" src="https://raw.githubusercontent.com/holodyne/slmsuite-examples/main/examples/ex-zernike-spots.gif" width="512">
</p>

`slmsuite` is maintained by [Holodyne Labs, Inc](https://www.holodyne.com). Contact slmsuite@holodyne.com for additional information.
