Skip to content

Latest commit

 

History

History
84 lines (61 loc) · 3.99 KB

README.md

File metadata and controls

84 lines (61 loc) · 3.99 KB
Raw

logo

SepiaWrapper

Python control for PicoQuant Sepia PDL 828 laser drivers

Author: Johan Hummert Organization: PicoQuant GmbH, Berlin, Germany Version: 2024.0.1

Python Package to control Sepia2 laser devices.

Disclaimer

This repository contains experimental Python code that was originally developed for internal use. While we are making it publicly available, please be aware of the following:

  1. No Warranty: The code is provided “as is”, without any warranty of any kind, either express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. Use it at your own risk.
  2. Experimental Nature: This code was primarily developed for internal research and experimentation. As such, it may not be fully optimized, thoroughly tested, or suitable for production environments. It is intended for use by developers who are comfortable working with experimental software.
  3. Limited Support: While we are open-sourcing this project, we do not guarantee active maintenance or support. Issues, bugs, and pull requests may be addressed as time permits, but there are no commitments regarding response times or future updates.
  4. Liability: We assume no responsibility for any damage or loss caused by the use of this code. You are solely responsible for ensuring that the software meets your requirements and complies with applicable laws and regulations.
  5. Contributions: We welcome contributions, but please be aware that any code you submit will be subject to the same disclaimer and license terms as the original project.

By using this code, you acknowledge that you understand and agree to the above terms.

Dependencies

  • Python 3: Tested with python 3.11

Installation

To use the package you need to first install the PDL 828 software and DLL, including the python programming examples. Then you can clone / download the git repository and place the directory PythonWrapper/PythonWrapper in your $PYTHONPATH.

Getting started

To list the Sepia devices available call:

import SepiaWrapper
SepiaWrapper.list_devices()

You can then connect to the laser device on device_index 0 with

sepia2 = SepiaWrapper.sepia2(0)

which will create an instance of the sepia2 class. To start a single laser on a device with a SOMD oscillator and a SLM laser device (e.g. and LDH type laser head) you can use this instance with

laser_index = 0
repetition rate = 20 # in MHz
intensity = 80.3 # in %
delay = 8.2 # in ns
sepia2.start_laser_simple(laser_index, repetition_rate, intensity, delay=delay)

In the example python notebook you can see how to set more complex parameters of the SOMD oscillator, such as burst values or sequencer combinations.

Note that if the sepia2 instance is left to the garbage collector, this will soft-lock the laser for safety. If you want to end your python program and leave the laser on, call:

sepia2.close()

What is included

  • SOM and SOMD oscillators With SOM and SOMD oscillators most functions for internal triggering of the oscillator are included. You can set burst values, use the combiner, delay lasers for SOMD oscillators
  • Sepia laser modules (SLM) Setting of pulse parameters and intensity

What is not included

  • External Triggering of Oscillators
  • SML functions
  • SWM functions
  • VCL functions
  • Solea functions
  • VisUV/IR functions
  • Prima functions
  • Linux Support Most of this might work under wine, but none of it was tested under wine
  • Most hardware diagnostics, such as voltages and temperatures

Examples

A more detailed example is available as a jupyter notebook explaining how to connect to a sepia2 device and control some parameters. You will need to install jupyter to run the example.