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.3.0.tar.gz (221.7 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.3.0-py3-none-any.whl (259.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for opticalib-1.3.0.tar.gz
Algorithm Hash digest
SHA256 2f7da37bbb0b9fd059111abd403b008a9166f2f7bd137ce703fcb3fb9cdf662e
MD5 77770f1cb1e51511625201415393b7e0
BLAKE2b-256 b1b8768cfea5e99580013a1149feb3492f3bd0134b709e5e309737c4228e63f6

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for opticalib-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ce8222d8799fd98a46e62977bf5b50c498bed8c44dc635e9c5722aeddb831e39
MD5 4dd374f7f85ad5860ae0eae178b57fde
BLAKE2b-256 27f729fd7300c0fe43d1b69293db1c04bc9f52b2c2f79b01f1189bde9b70f796

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