Metadata-Version: 2.1
Name: laserstudio
Version: 1.0.0
Summary: Python3 software for hardware evaluation
License: LGPL-3.0-or-later
Author: Olivier Hériveaux
Author-email: olivier.heriveaux@ledger.fr
Requires-Python: >=3.9,<3.11
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Software Development :: Build Tools
Requires-Dist: flask (==3.0.3)
Requires-Dist: flask-restx (==1.3.0)
Requires-Dist: hidapi (>=0.14.0,<0.15.0)
Requires-Dist: numpy (==1.26.4)
Requires-Dist: opencv-python (==4.9.0.80)
Requires-Dist: pillow (==10.4.0)
Requires-Dist: pypdm (==1.1)
Requires-Dist: pyqt6 (>=6.0)
Requires-Dist: pystages (==1.2)
Requires-Dist: pyusb (==1.2.1)
Requires-Dist: pyyaml (==6.0.1)
Requires-Dist: requests (>=2.32.3,<3.0.0)
Requires-Dist: shapely (>=2.0.5,<3.0.0)
Requires-Dist: triangle (==20230923)
Project-URL: Documentation, https://laserstudio.readthedocs.org/
Description-Content-Type: text/markdown

# Laser Studio

An open source python3 software designed to control hardware evaluation benches
to conduct automatized evaluations.

Laser Studio permits to have a visual representation of a spatial environment,
define zones of interests, and launch an automated scanning process to physically
and randomly go through these zones, by controlling motion devices.

## Installation

Laser Studio works on Python 3.9+.

It can be installed through PyPI with:

```shell
pip install laserstudio
```

Otherwise, you can clone and install the project with:

```shell
git clone https://github.com/Ledger-Donjon/laserstudio.git
pip install ./laserstudio
```

### Package depedencies

It depends following packages to run:

- [PyQt6]
- [pystages]
- [Pillow]
- [opencv-python]
- [pyusb]
- [PyYAML]
- [shapely]
- [triangle]
- [requests]
- [numpy]
- [pypdm]
- [flask]
- [flask-restx]
- [hidapi]

Additionally, on Linux systems, the [pyNIT] package can be installed
to support NIT cameras.

```shell
pip install git+https://github.com/Ledger-Donjon/pynit.git
```

On Mac with Apple Silicon chips, the [triangle] package fails to install with `pip`.
Workaround is to install it from source before installing `laserstudio`:

```shell
pip install git+https://github.com/drufat/triangle.git
```

## Usage

To run Laser Studio, tune your configuration file `config.yaml` with appropriate
information about your hardware instruments, then a terminal and run Laser Studio in the
directory containing that `config.yaml`.

```shell
laserstudio
```

# Documentation

Advanced documentation of Laser Studio is available on [Read The Docs].

## Licensing

LaserStudio is released under GNU Lesser General Public License version 3 (LGPLv3). See LICENSE and LICENSE.LESSER for license detail

[PyQt6]: https://pypi.org/project/PyQt6/
[Pillow]: https://pillow.readthedocs.io/en/stable/index.html
[opencv-python]: https://github.com/opencv/opencv-python
[PyYAML]: https://pypi.org/project/PyYAML/
[pystages]: https://github.com/Ledger-Donjon/pystages
[shapely]: https://shapely.readthedocs.io/en/stable/manual.html
[triangle]: https://rufat.be/triangle/
[pyusb]: https://pypi.org/project/pyusb/
[requests]: https://pypi.org/project/requests/
[numpy]: https://pypi.org/project/numpy
[pypdm]: https://pypi.org/project/pypdm
[flask]: https://pypi.org/project/flask
[flask-restx]: https://pypi.org/project/flask-restx
[hidapi]: https://pipy.org/project/hidapi
[Read the Docs]: https://laserstudio.readthedocs.io/

