Skip to main content

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.

Project description

OptiCalib : adaptive OPTics package for deformable mirrors CALibration

GitHub Actions Workflow Status

Adaptive Optics Group, INAF - Osservatorio Astrofisico di Arcetri

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.

The latests, stable, version can be installed from pypi:

pip install opticalib

The in-development version can be installed directly from this repository:

pip install git+"https://github.com/ArcetriAdaptiveOptics/opticalib.git"

But do expect some bugs!

Upon installation, 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:

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, documented here, is where all devices must be specified.

Example usage

Once done with the configuration, we can then start using out instruments:

calpy -f ~/alpao_experiment
# 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 (work in progress...), while for the configuration file documentation check here

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

opticalib-1.2.3.tar.gz (347.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

opticalib-1.2.3-py3-none-any.whl (373.9 kB view details)

Uploaded Python 3

File details

Details for the file opticalib-1.2.3.tar.gz.

File metadata

  • Download URL: opticalib-1.2.3.tar.gz
  • Upload date:
  • Size: 347.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for opticalib-1.2.3.tar.gz
Algorithm Hash digest
SHA256 6ee21b08982b9e5b046d52c66d773cdd34954ef512a71561a1a5dcbffd97e8d8
MD5 596092c0cdc27910a33d09d03a2051be
BLAKE2b-256 abfb786b4a1bc4cad4294abc54d9db412c9aa8d516bf3ae3ab25a37f7be40be6

See more details on using hashes here.

File details

Details for the file opticalib-1.2.3-py3-none-any.whl.

File metadata

  • Download URL: opticalib-1.2.3-py3-none-any.whl
  • Upload date:
  • Size: 373.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for opticalib-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ee2ed792cd3aa1bef3054dd36abe215ace9fc57099d4d8b6aee0755dd665b19b
MD5 ff334ba30ec95050b134d0afcad21f0d
BLAKE2b-256 34702c42ff78e6b8e71ac60c4c3e02dbd6db2890aef7e66c44650827d3d64e0d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page