Metadata-Version: 2.1
Name: slmsuite
Version: 0.1.2
Summary: Package for high-performance spatial light modulator (SLM) control and holography.
Author: slmsuite developers
Author-email: qp-slm@mit.edu
Project-URL: Homepage, https://github.com/slmsuite/slmsuite
Project-URL: Documentation, https://slmsuite.readthedocs.io/en/latest/
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
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

<p align="center">
<img alt="slmsuite" src="https://raw.githubusercontent.com/slmsuite/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.readthedocs.io/en/latest"><img alt="Documentation Status" src="https://readthedocs.org/projects/slmsuite/badge/?version=latest"></a>
<a href="https://pypi.org/project/slmsuite/"><img alt="PyPi Package" src="https://img.shields.io/badge/pypi-v0.1.1-3776AB.svg"></a>
<a href="https://github.com/slmsuite/slmsuite/blob/main/LICENSE"><img alt="License: MIT" src="https://img.shields.io/github/license/slmsuite/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>
</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/slmsuite/slmsuite
```

## Documentation and Examples

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

Examples can be found embedded in
[documentation](https://slmsuite.readthedocs.io/en/latest/examples.html),
live through
[nbviewer](https://nbviewer.org/github/slmsuite/slmsuite-examples/tree/main/examples/),
or directly in
[source](https://github.com/slmsuite/slmsuite-examples).

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