LiberTEM-live

LiberTEM-live is an extension module for LiberTEM [CWR+21] that allows live data processing.

Note

LiberTEM-live is still experimental and under active development, including the overall architecture. New releases can include changes that break backwards compatibility until the code and architecture are proven in practical application and stabilized sufficiently.

That being said, we encourage early experimental use, are happy to support real-world application and appreciate feedback! You can contact us by creating or commenting on an Issue on GitHub or in the LiberTEM Gitter chat.

LiberTEM user-defined functions (UDFs) are designed to work without modification on both offline data and live data streams. That means all LiberTEM applications and LiberTEM-based modules can work with all supported detectors in LiberTEM-live.

Installation

The short version to install into an existing LiberTEM environment:

(libertem) $ python -m pip install "libertem-live"

See the LiberTEM installation instructions for more details on installing LiberTEM.

Detectors

• Quantum Detectors Merlin

• DECTRIS EIGER2-based

• Amsterdam Scientific Instruments CheeTah TPX3

See the documentation for details.

Support for the Gatan K2 IS, ASI MPX3, and X-Spectrum cameras is currently under development.

License

LiberTEM-live is licensed under GPLv3. The I/O parts are also available under the MIT license, please see LICENSE files in the subdirectories for details.

Acknowledgements

We are very grateful for your continuing support for LiberTEM-live!

See the acknowledgement page for a list of authors and contributors to LiberTEM-live and other LiberTEM projects. See also our info on funding and industry partners.

Documentation

Contents:

• Installation
• Usage
  • Common setup code
  • Coordinating live processing
  • Passive mode
  • Active mode
  • Hooks
  • Live visualization
  • Included UDFs
  • Recording data
• Supported Detectors
  • Amsterdam Scientific Instruments CheeTah TPX3
  • DECTRIS SIMPLON
  • Quantum Detectors Merlin
• Examples
  • Continuous live preview
  • Example notebooks
• Reference
  • ASI TPX3 reference
  • DECTRIS reference
  • Memory “detector” reference
  • Quantum detectors Merlin Medipix reference
  • Live Context
  • UDFs
  • Base classes
  • Hooks
• Changelog
  • 0.3.0.dev0
  • 0.2.1 / 2023-05-09
  • 0.2.0 / 2023-04-21
  • 0.1.0 / 2021-06-29
• Acknowledgements
  • Citing
  • Funding

Indices and tables

• Index

• Module Index

• Search Page

Citations

[CWR+21]

Alexander Clausen, Dieter Weber, Karina Ruzaeva, Vadim Migunov, Anand Baburajan, Abijith Bahuleyan, Jan Caron, Rahul Chandra, Shankhadeep Dey, Sayandip Halder, Daniel S. Katz, Barnaby D.A. Levin, Magnus Nord, Colin Ophus, Simon Peter, Jay Schyndel van, Jaeweon Shin, Sai Sunku, Knut Müller-Caspary, and Rafal E. Dunin-Borkowski. Libertem/libertem: 0.7.0. June 2021. URL: https://doi.org/10.5281/zenodo.4923277, doi:10.5281/zenodo.4923277.