Skip to main content

Tools for tuning optical parametric amplifiers and multidimensional spectrometers.

Project description

attune

image

Tools for tuning optical parametric amplifiers and multidimensional spectrometers.

Documentation is available at https://attune.wright.tools/en/latest/.

Overview

attune has three primary jobs:

  1. attune parses calibration data to find optimal motor positions

    # data has scans of a motor position ("OPA1_SHS_crystal") against a signal
    # ("signal") for a set of second harmonic signal color setpoints
    # ("opa_color")
    calibration_data = wt.open(path_to_data.wt5)
    calibration_data.transform("opa_color", "motor")
    args = {
        "data": calibration_data,
        "channel": "signal",
        "arrangement": "SHS",
        "tune": "SHS_crystal",
        "instrument": "OPA1",
    }
    tuned_opa1 = attune.intensity(**args)
    
  2. attune organizes optimal motor positions. The motor positions are stored in a hierarchy of mappings. Beginning at the lowest level:

    • Tune : a map of OPA color (the "independent") to positions of a single motor (the "dependent").

      my_tune = attune.Tune(
          independent=[450, 600, 700],
          dependent=[3.225, 2.332, 1.987]
      )  # relate color to bbo angle
      
    • Arrangement : a collection of Tunes that define a concerted process (e.g. to generate idler photons, one might move several motors (bbo, g1, etc.))

      idler = attune.Arrangement("idler", dict(bbo=my_tune, g1=my_other_tune))
      
    • Instrument : a collection of Arrangements (e.g. an OPA may have signal and idler)

      my_opa = attune.Instrument({"idler": idler, "signal": signal}, name="opa1")
      

      Note: arrangements can be called as tunables if they exist in the same instrument. This can allow nested naming

      shi = attune.Arrangement(Dict(
          idler = Tune(shi_colors, idler_colors), 
          sh_crystal = Tune(shi_colors, angles)
      )) 
      
  3. attune stores motor mappings and remembers them through version tracking.

    • save a new instrument (or update an existing one)

      attune.store(my_opa)
      
    • lookup a saved instrument (by name)

      attune.catalog()  # lists all saved instruments
      my_opa = attune.load("opa1")  # fetches the most recent version of the instrument
      my_previous_opa = attune.undo(my_opa) # fetches the previous version of the instrument
      my_old_opa = attune.load("opa1", time="yesterday")  # optional kwarg specifies the version by time of usage    
      

Notes

  • attune uses default units of nanometers ("nm") for its independent variables. At this time, units cannot be changed, so alternate units must be handled externally (PRs are welcome!). WrightTools calibration data is automatically converted into "nm" units for parsing.

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

attune-0.5.1.tar.gz (26.4 kB view details)

Uploaded Source

Built Distribution

attune-0.5.1-py2.py3-none-any.whl (32.5 kB view details)

Uploaded Python 2Python 3

File details

Details for the file attune-0.5.1.tar.gz.

File metadata

  • Download URL: attune-0.5.1.tar.gz
  • Upload date:
  • Size: 26.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for attune-0.5.1.tar.gz
Algorithm Hash digest
SHA256 d67d3db7c255143c4d1d8915396b77acae2d8b7ac316d9fbe8a56cc2fe64c10a
MD5 f1c0ca1ff9ff43699725468fcd303889
BLAKE2b-256 78d3bd089e0ce30ea6f936f2ddcf60931aef7a96d1dded90a58e8ed96d95bf0a

See more details on using hashes here.

File details

Details for the file attune-0.5.1-py2.py3-none-any.whl.

File metadata

  • Download URL: attune-0.5.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 32.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for attune-0.5.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c5bc4ed506113bd732d24f219fd7b9e9f392245ad3728c40fcfe42f040737b7a
MD5 0b95eece35acdc9fd121d3bd10e97c27
BLAKE2b-256 6120ffb513ad27de20b26fa419dd4411db01eff2501c11a83a679aa500339b81

See more details on using hashes here.

Supported by

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