Metadata-Version: 2.1
Name: libertem-live
Version: 0.2.0
Summary: Live processing with LiberTEM
Home-page: https://libertem.github.io/LiberTEM-live
Author: the LiberTEM team
Author-email: libertem-dev@googlegroups.com
License: GPL v3
Keywords: electron microscopy
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
Provides-Extra: sim
Provides-Extra: pymemfd
Provides-Extra: pytango
License-File: LICENSE

|gitter|_ |azure|_ |github|_ |precommit|_ |zenodo|_

.. |gitter| image:: https://badges.gitter.im/Join%20Chat.svg
.. _gitter: https://gitter.im/LiberTEM/Lobby

.. |azure| image:: https://dev.azure.com/LiberTEM/LiberTEM-live/_apis/build/status/LiberTEM.LiberTEM-live?branchName=master
.. _azure: https://dev.azure.com/LiberTEM/LiberTEM-live/_build/latest?definitionId=5&branchName=master

.. |github| image:: https://img.shields.io/badge/GitHub-GPL--3.0-informational
.. _github: https://github.com/LiberTEM/LiberTEM-live/

.. |precommit| image:: https://results.pre-commit.ci/badge/github/LiberTEM/LiberTEM-live/master.svg
.. _precommit: https://results.pre-commit.ci/latest/github/LiberTEM/LiberTEM-live/master

.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4916315.svg
.. _zenodo: https://doi.org/10.5281/zenodo.4916315

LiberTEM-live is an extension module for `LiberTEM
<https://libertem.github.io/>`_ 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
  <https://github.com/LiberTEM/LiberTEM-live/issues>`_ or in the `LiberTEM
  Gitter chat <https://gitter.im/LiberTEM/Lobby>`_.

LiberTEM `user-defined functions (UDFs)
<https://libertem.github.io/LiberTEM/udf.html>`_ are designed to work without
modification on both offline data and live data streams. That means all
`LiberTEM applications <https://libertem.github.io/LiberTEM/applications.html>`_
and `LiberTEM-based modules
<https://libertem.github.io/LiberTEM/packages.html>`_ can work with all
supported detectors in LiberTEM-live.

Installation
------------

The short version to install into an existing LiberTEM environment:

.. code-block:: shell

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

See the `LiberTEM installation instructions
<https://libertem.github.io/LiberTEM/install.html>`_ for more details on
installing LiberTEM.

Detectors
---------

* Quantum Detectors Merlin
* DECTRIS EIGER2-based
* Amsterdam Scientific Instruments CheeTah TPX3

See `the documentation <https://libertem.github.io/LiberTEM-live/detectors.html>`_
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
<https://libertem.github.io/acknowledgements.html#libertem-live>`_ for a list of
authors and contributors to LiberTEM-live and other LiberTEM projects. See also
our info on `funding <https://libertem.github.io/#funding>`_ and `industry
partners <https://libertem.github.io/#industry-partners>`_.


