opticalib 1.0.0__tar.gz

opticalib-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Pietro Ferraiuolo (pietro.ferraiuolo@inaf.it)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

opticalib-1.0.0/MANIFEST.in

@@ -0,0 +1,5 @@
+include README.md
+include requirements.txt
+include opticalib/core/_configurations/configuration.yaml
+include setup_calpy.py
+recursive-include labott *.py

opticalib-1.0.0/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.4
+Name: opticalib
+Version: 1.0.0
+Summary: This package is a python interface for laboratory adaptive optics systems, with a focus on the calibration of deformable mirrors (DMs) and the acquisition of wavefront data using interferometers.
+Home-page: https://github.com/pietroferraiuolo/LABOTT
+Author: Adaptive Optics Group - INAF - Osservatorio Astrofisico di Arcetri
+Author-email: pietro.ferraiuolo@inaf.it
+Maintainer: Pietro Ferraiuolo
+License: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Unix
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: arte
+Requires-Dist: astropy
+Requires-Dist: scikit-image
+Requires-Dist: scikit-learn
+Requires-Dist: thin-plate-spline
+Requires-Dist: scipy
+Requires-Dist: plico_dm
+Requires-Dist: ruamel.yaml
+Requires-Dist: Pyro4
+Requires-Dist: h5py
+Requires-Dist: jdcal
+Requires-Dist: tqdm
+Requires-Dist: matplotlib
+Requires-Dist: xupy
+Requires-Dist: numpy
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: maintainer
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# OptiCalib : adaptive OPTics package for deformable dirrors CALibration
+
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/pietroferraiuolo/labott/tests.yml)
+
+`Adaptive Optics Group, INAF - Osservatorio Astrofisico di Arcetri`  
+
+- [Pietro Ferraiuolo](mailto:pietro.ferraiuolo@inaf.it)
+
+- [Marco Xompero](mailto:marco.xompero@inaf.it)
+
+OptiCalib is a python package which first goal is to make easy deformable mirror's calibration in the laboratory (and not only).
+
+It was born as a general extrapolation of the software built for the control and calibration of the `ELT @ M4` adaptive mirror and it's calibration tower, `OTT` (`Optical Test Tower`).
+
+## Description
+
+The `OPTICALIB` package serves two main purposes:
+
+- Making connection to the hardware (interferometers, DMs, ...) easy;
+
+- Providing routines for Deformable Mirrors calibrations.
+
+It can be installed from the repository, while waiting for an official release, as
+
+```bash
+pip install git+"https://github.com/pietroferraiuolo/labott.git"
+```
+
+The software will create an entry point script called `calpy`, which is usefull to set up a specific experiment's environment. Let's say we have an optical bench composed of an interferometer 4D PhaseCam6110 and an Alpao Deformable mirror, say DM820. We can create the experiment's environment just like:
+
+```bash
+calpy -f ~/alpao_experiment --create
+```
+
+This will create, in the `~/alpao_experiment` folder, the package's data folder tree, together with a configuration file in the `SysConfig` folder. The [configuration file](./opticalib/core/_configurations/configuration.yaml), documented [here](./opticalib/core/_configurations/DOCS.md), is where all devices must be specified.
+
+Once done with the configuration, we can then start using out instruments:
+
+```bash
+calpy -f ~/alpao_experiment
+```
+
+```python
+# The `calpy` function will automatically import opticalib (with `opt` as alias), as well as the `opticalib.dmutils` as dmutils
+
+interf = opt.PhaseCam(6110) # set in the configuration file
+dm = opt.AlpaoDm(820)       # set in the configuration file
+
+# Having the bench set up and the configuration file set, we can acquire an Influence Function by just doing
+
+tn = dmutils.iff_module.iffDataAcquisition(dm, interf) # Optional paramenters are `modesList, modesAmplitude, template`, which if not specified are read from the configuration file
+```
+
+## Documentation
+For the API references, check [here](docs/opticalib.pdf) (work in progress...), while for the configuration file documentation check [here](./opticalib/core/_configurations/DOCS.md)

opticalib-1.0.0/README.md

@@ -0,0 +1,55 @@
+# OptiCalib : adaptive OPTics package for deformable dirrors CALibration
+
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/pietroferraiuolo/labott/tests.yml)
+
+`Adaptive Optics Group, INAF - Osservatorio Astrofisico di Arcetri`  
+
+- [Pietro Ferraiuolo](mailto:pietro.ferraiuolo@inaf.it)
+
+- [Marco Xompero](mailto:marco.xompero@inaf.it)
+
+OptiCalib is a python package which first goal is to make easy deformable mirror's calibration in the laboratory (and not only).
+
+It was born as a general extrapolation of the software built for the control and calibration of the `ELT @ M4` adaptive mirror and it's calibration tower, `OTT` (`Optical Test Tower`).
+
+## Description
+
+The `OPTICALIB` package serves two main purposes:
+
+- Making connection to the hardware (interferometers, DMs, ...) easy;
+
+- Providing routines for Deformable Mirrors calibrations.
+
+It can be installed from the repository, while waiting for an official release, as
+
+```bash
+pip install git+"https://github.com/pietroferraiuolo/labott.git"
+```
+
+The software will create an entry point script called `calpy`, which is usefull to set up a specific experiment's environment. Let's say we have an optical bench composed of an interferometer 4D PhaseCam6110 and an Alpao Deformable mirror, say DM820. We can create the experiment's environment just like:
+
+```bash
+calpy -f ~/alpao_experiment --create
+```
+
+This will create, in the `~/alpao_experiment` folder, the package's data folder tree, together with a configuration file in the `SysConfig` folder. The [configuration file](./opticalib/core/_configurations/configuration.yaml), documented [here](./opticalib/core/_configurations/DOCS.md), is where all devices must be specified.
+
+Once done with the configuration, we can then start using out instruments:
+
+```bash
+calpy -f ~/alpao_experiment
+```
+
+```python
+# The `calpy` function will automatically import opticalib (with `opt` as alias), as well as the `opticalib.dmutils` as dmutils
+
+interf = opt.PhaseCam(6110) # set in the configuration file
+dm = opt.AlpaoDm(820)       # set in the configuration file
+
+# Having the bench set up and the configuration file set, we can acquire an Influence Function by just doing
+
+tn = dmutils.iff_module.iffDataAcquisition(dm, interf) # Optional paramenters are `modesList, modesAmplitude, template`, which if not specified are read from the configuration file
+```
+
+## Documentation
+For the API references, check [here](docs/opticalib.pdf) (work in progress...), while for the configuration file documentation check [here](./opticalib/core/_configurations/DOCS.md)

opticalib-1.0.0/opticalib/__init__.py

@@ -0,0 +1,53 @@
+"""
+OPTICALIB: adaptive OPTIcs package for dm CALIBration
+=====================================================
+
+Author(s)
+---------
+- Pietro Ferraiuolo : pietro.ferraiuolo@inaf.it
+
+Description
+-----------
+`opticalib` is a package for the control of laboratory instrumentations, like
+Interferometers and Deformable Mirrors. It also provides tools for the
+analysis of wavefronts and images.
+
+How to Use:
+-----------
+```python
+> import opticalib
+> interf = opticalib.PhaseCam('193.206.155.218', 8011)
+> img = interf.acquire_map()
+```
+"""
+
+from .__version__ import __version__
+from . import analyzer
+from .ground.osutils import load_fits, save_fits, getFileList, read_phasemap
+from .core.root import (
+    folders,
+    create_configuration_file,
+)
+from .core import read_config
+from .core.fitsarray import fits_array
+from .devices import *
+from .devices.interferometer import _4DInterferometer
+
+getCameraSettings = _4DInterferometer.getCameraSettings
+getFrameRate = _4DInterferometer.getFrameRate
+
+del _4DInterferometer
+
+__all__ = [
+    "analyzer",
+    "load_fits",
+    "save_fits",
+    "read_phasemap",
+    "getFileList",
+    "folders",
+    "create_configuration_file",
+    "read_config",
+    "getCameraSettings",
+    "getFrameRate",
+    "fits_array",
+]

opticalib-1.0.0/opticalib/__version__.py

@@ -0,0 +1,29 @@
+"""
+Created on March 2025
+
+Author
+------
+Pietro Ferraiuolo
+"""
+
+__title__ = "opticalib"
+__long_title__ = "OPTICALIB : adaptive OPTIcs package for dm CALibrationS"
+__description__ = "This package is a python interface for laboratory adaptive optics systems, with a focus on the calibration of deformable mirrors (DMs) and the acquisition of wavefront data using interferometers."
+__version__ = "1.0.0"
+__author__ = "Adaptive Optics Group - INAF - Osservatorio Astrofisico di Arcetri"
+__maintainer__ = "Pietro Ferraiuolo"
+__author_email__ = "pietro.ferraiuolo@inaf.it"
+__license__ = "MIT License"
+__url__ = "https://github.com/pietroferraiuolo/LABOTT"
+
+__all__ = [
+    "__title__",
+    "__long_title__",
+    "__description__",
+    "__version__",
+    "__author__",
+    "__maintainer__",
+    "__author_email__",
+    "__license__",
+    "__url__",
+]