Welcome to TRSpectrometer’s documentation!

TRSpectrometer is a platform for time-resolved spectroscopy, encompassing both software and hardware designs. It can be used for both data acquisition, as well as viewing data and basic analysis.

Features:

• Completely open source hardware and software designs. Don’t get stuck with inflexible and buggy proprietary software!

• Plugin architecture to ease modifications and integration of new hardware devices or experimental methods.

• Supports the latest rapid-acquisition techniques.

• Cross platform python - Linux, Windows, MacOS.

The aim of the software is to be as open and flexible as possible, using a plugin system for the addition and customisation of features and functionality. For example, the same software that runs on a Windows machine acquiring data can be installed on a Linux or Mac OS computer and used for data viewing and analysis without restriction. The majority of the code base is written in Python, making development and modifications (hopefully!) more accessible to students and researchers who lack specific programming backgrounds.

The initial 1.0 version includes a reference hardware design for a transient absorption (pump–probe) spectrometer and a cross-platform software application for data acquisition and basic data exploration and analysis. In time, it is hoped that the platform will support a wider variety of hardware and additional time-resolved experimental techniques, as well as adding more advanced data exploration, analysis, and plotting tools. This will only truly be possible through contributions by users and other interested parties. See the Contributing page for more information.

Source code at https://gitlab.com/ptapping/trspectrometer.

Documentation online at https://ptapping.gitlab.io/trspectrometer.

Python Packaging Index (PyPI) page at https://pypi.org/project/trspectrometer.

Bug reports, feature requests and suggestions can be submitted to the issue tracker.

User Guide

• Getting Started
• Hardware
• Configuration
• Acquiring Data
• Loading and Viewing Raw Data
• Native Data Format
• Version History
• Contributing
• Licenses

Developer Guide

These sections will be useful for those wishing to create plugins or understand the design of the software. They are not required to be understood by the typical end user!

• Writing a User Plugin

API Documentation

• trspectrometer package
  • trspectrometer.plugins package
    • trspectrometer.plugins.acquisition package
      • trspectrometer.plugins.acquisition.ta_dummy module
      • trspectrometer.plugins.acquisition.ta_stepped module
      • trspectrometer.plugins.acquisition.ta_swept module
    • trspectrometer.plugins.aligncam package
      • trspectrometer.plugins.aligncam.alignmentpanel module
      • trspectrometer.plugins.aligncam.cv2camera module
    • trspectrometer.plugins.chopper package
      • trspectrometer.plugins.chopper.dummychopper module
      • trspectrometer.plugins.chopper.thorlabs_mc2000b module
    • trspectrometer.plugins.delay package
      • trspectrometer.plugins.delay.dummydelay module
      • trspectrometer.plugins.delay.thorlabs_apt module
    • trspectrometer.plugins.detector package
      • trspectrometer.plugins.detector.dummydetector module
      • trspectrometer.plugins.detector.zylafixed module
    • trspectrometer.plugins.interface package
      • trspectrometer.plugins.interface.dummyinterface module
      • trspectrometer.plugins.interface.trsi module
    • trspectrometer.plugins.repratemenu package
    • trspectrometer.plugins.scope package
      • trspectrometer.plugins.scope.scopepanel module
    • trspectrometer.plugins.zylaalign package
      • trspectrometer.plugins.zylaalign.zylaalignpanel module
  • trspectrometer.aboutpanel module
  • trspectrometer.busydialog module
  • trspectrometer.configuration module
  • trspectrometer.datapanel module
  • trspectrometer.datastorage module
  • trspectrometer.hardware module
  • trspectrometer.logpanel module
  • trspectrometer.mainwindow module
  • trspectrometer.qtwidgets module
  • trspectrometer.signalstorage module
  • trspectrometer.ufsfile module
  • trspectrometer.utils module

Indices and tables

• Index

• Module Index

• Search Page