lavue


Namelavue JSON
Version 2.94.2 PyPI version JSON
download
home_pagehttps://github.com/lavue-org/lavue
SummaryLive image viewer application for photon science detectors.
upload_time2024-12-18 08:50:45
maintainerNone
docs_urlNone
authorJ.Kotanski, Ch.Rosemann, A.Rothkirch
requires_pythonNone
licenseGPLv2
keywords live viewer photon science detector
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            LaVue - Live Image Viewer
=========================

|github workflow|
|docs|
|Pypi Version|
|Python Versions|

.. |github workflow| image:: https://github.com/lavue-org/lavue/actions/workflows/tests.yml/badge.svg
   :target: https://github.com/lavue-org/lavue/actions
   :alt:

.. |docs| image:: https://img.shields.io/badge/Documentation-webpages-ADD8E6.svg
   :target: https://lavue-org.github.io/lavue/index.html
   :alt:

.. |Pypi Version| image:: https://img.shields.io/pypi/v/lavue.svg
                  :target: https://pypi.python.org/pypi/lavue
                  :alt:

.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/lavue.svg
                     :target: https://pypi.python.org/pypi/lavue/
                     :alt:

Authors: Christoph Rosemann <christoph.rosemann at desy.de>, Jan Kotański <jan.kotanski at desy.de>, André Rothkirch <andre.rothkirch at desy.de>

Introduction
------------

This is a simple implementation of a live viewer front end.
It is supposed to show a live image view from xray-detectors at PETRA3 @ desy.de,
e.g. ``Pilatus``, ``Lambda``, ``Eiger``, ``PerkinElmer``, ``PCO``, ``LimaCCD``, and others.

.. image:: https://github.com/lavue-org/lavue/blob/develop/doc/_images/lavue.png?raw=true


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

LaVue requires the following python packages: ``qt5/qt4  pyqtgraph  numpy  zmq  scipy``

It is also recommended to install: ``pytango  hidra  pil  fabio  requests  h5py  pni  nxstools``


From sources
""""""""""""

Download the latest LaVue version from https://github.com/lavue-org/lavue

Extract sources and run

.. code-block:: console

   $ python setup.py install

The ``setup.py`` script may need: ``setuptools  sphinx  numpy  pytest`` python packages as well as ``qtbase5-dev-tools`` or ``libqt4-dev-bin``.

Debian packages
"""""""""""""""

Debian `bookworm`, `bullseye`, `buster` or Ubuntu  `noble`, `jammy`, `oracular` packages can be found in the HDRI repository.

To install the debian packages, add the PGP repository key

.. code-block:: console

   $ sudo su
   $ curl -s http://repos.pni-hdri.de/debian_repo.pub.gpg  | gpg --no-default-keyring --keyring gnupg-ring:/etc/apt/trusted.gpg.d/debian-hdri-repo.gpg --import
   $ chmod 644 /etc/apt/trusted.gpg.d/debian-hdri-repo.gpg

and then download the corresponding source list, e.g.

.. code-block:: console

   $ cd /etc/apt/sources.list.d

and

.. code-block:: console

   $ wget http://repos.pni-hdri.de/bookworm-pni-hdri.list

or

.. code-block:: console

   $ wget http://repos.pni-hdri.de/bullseye-pni-hdri.list

or

.. code-block:: console

   $ wget http://repos.pni-hdri.de/noble-pni-hdri.list

or

.. code-block:: console

   $ wget http://repos.pni-hdri.de/jammy-pni-hdri.list

respectively.

Finally,

.. code-block:: console

   $ apt-get update
   $ apt-get install python3-lavue
   $ apt-get install lavue-controller

or

.. code-block:: console

   $ apt-get install lavue-controller3
   
for python 3 version (for older debian/ubuntu releases).

From pip
""""""""

To install it from pip you need to install pyqt5 in advance, e.g.

.. code-block:: console

   $ python3 -m venv myvenv
   $ . myvenv/bin/activate

   $ pip install PyQtWebKit

or

.. code-block:: console

   $ pip install pyqt5

or

.. code-block:: console

   $ pip install PyQt5==5.14

and then

.. code-block:: console


   $ pip install lavue

Moreover it is also good to install the following python packages:

.. code-block:: console

   $ pip install fabio
   $ pip install pillow
   $ pip install pyFAI
   $ pip install lavuefilters
   $ pip install pytango

Start the Viewer
----------------

To start LaVue

.. code-block:: console

   $ lavue

or

.. code-block:: console

   $ lavue3

for python 3 version (for older debian/ubuntu releases).

Start the Viewer in the expert mode
"""""""""""""""""""""""""""""""""""

Changing LaVue settings is available in the expert mode, i.e.

.. code-block:: console

   $ lavue -m expert

under an additional button: Configuration.

Launching options
"""""""""""""""""

To get all possible command-line parameters

.. code-block:: console

   $ lavue -h

Further reading
---------------

More information can be found at: `LaVue <https://lavue-org.github.io/lavue>`_

| ``Conflunce`` page: https://confluence.desy.de/display/FSEC/LaVue+-+Live+Image+Viewer
| ``LavueController`` Tango Server API: https://lavue-org.github.io/lavue/stable/doc_html

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/lavue-org/lavue",
    "name": "lavue",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "live viewer photon science detector",
    "author": "J.Kotanski, Ch.Rosemann, A.Rothkirch",
    "author_email": "jan.kotanski@desy.de, christoph.rosemann@desy.de, andre.rothkirch@desy.de",
    "download_url": "https://files.pythonhosted.org/packages/73/1c/cc42eb5d410481de694258e53fb656fc3f367110765d1e954f07eb42db12/lavue-2.94.2.tar.gz",
    "platform": null,
    "description": "LaVue - Live Image Viewer\n=========================\n\n|github workflow|\n|docs|\n|Pypi Version|\n|Python Versions|\n\n.. |github workflow| image:: https://github.com/lavue-org/lavue/actions/workflows/tests.yml/badge.svg\n   :target: https://github.com/lavue-org/lavue/actions\n   :alt:\n\n.. |docs| image:: https://img.shields.io/badge/Documentation-webpages-ADD8E6.svg\n   :target: https://lavue-org.github.io/lavue/index.html\n   :alt:\n\n.. |Pypi Version| image:: https://img.shields.io/pypi/v/lavue.svg\n                  :target: https://pypi.python.org/pypi/lavue\n                  :alt:\n\n.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/lavue.svg\n                     :target: https://pypi.python.org/pypi/lavue/\n                     :alt:\n\nAuthors: Christoph Rosemann <christoph.rosemann at desy.de>, Jan Kota\u0144ski <jan.kotanski at desy.de>, Andr\u00e9 Rothkirch <andre.rothkirch at desy.de>\n\nIntroduction\n------------\n\nThis is a simple implementation of a live viewer front end.\nIt is supposed to show a live image view from xray-detectors at PETRA3 @ desy.de,\ne.g. ``Pilatus``, ``Lambda``, ``Eiger``, ``PerkinElmer``, ``PCO``, ``LimaCCD``, and others.\n\n.. image:: https://github.com/lavue-org/lavue/blob/develop/doc/_images/lavue.png?raw=true\n\n\nInstallation\n------------\n\nLaVue requires the following python packages: ``qt5/qt4  pyqtgraph  numpy  zmq  scipy``\n\nIt is also recommended to install: ``pytango  hidra  pil  fabio  requests  h5py  pni  nxstools``\n\n\nFrom sources\n\"\"\"\"\"\"\"\"\"\"\"\"\n\nDownload the latest LaVue version from https://github.com/lavue-org/lavue\n\nExtract sources and run\n\n.. code-block:: console\n\n   $ python setup.py install\n\nThe ``setup.py`` script may need: ``setuptools  sphinx  numpy  pytest`` python packages as well as ``qtbase5-dev-tools`` or ``libqt4-dev-bin``.\n\nDebian packages\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nDebian `bookworm`, `bullseye`, `buster` or Ubuntu  `noble`, `jammy`, `oracular` packages can be found in the HDRI repository.\n\nTo install the debian packages, add the PGP repository key\n\n.. code-block:: console\n\n   $ sudo su\n   $ curl -s http://repos.pni-hdri.de/debian_repo.pub.gpg  | gpg --no-default-keyring --keyring gnupg-ring:/etc/apt/trusted.gpg.d/debian-hdri-repo.gpg --import\n   $ chmod 644 /etc/apt/trusted.gpg.d/debian-hdri-repo.gpg\n\nand then download the corresponding source list, e.g.\n\n.. code-block:: console\n\n   $ cd /etc/apt/sources.list.d\n\nand\n\n.. code-block:: console\n\n   $ wget http://repos.pni-hdri.de/bookworm-pni-hdri.list\n\nor\n\n.. code-block:: console\n\n   $ wget http://repos.pni-hdri.de/bullseye-pni-hdri.list\n\nor\n\n.. code-block:: console\n\n   $ wget http://repos.pni-hdri.de/noble-pni-hdri.list\n\nor\n\n.. code-block:: console\n\n   $ wget http://repos.pni-hdri.de/jammy-pni-hdri.list\n\nrespectively.\n\nFinally,\n\n.. code-block:: console\n\n   $ apt-get update\n   $ apt-get install python3-lavue\n   $ apt-get install lavue-controller\n\nor\n\n.. code-block:: console\n\n   $ apt-get install lavue-controller3\n   \nfor python 3 version (for older debian/ubuntu releases).\n\nFrom pip\n\"\"\"\"\"\"\"\"\n\nTo install it from pip you need to install pyqt5 in advance, e.g.\n\n.. code-block:: console\n\n   $ python3 -m venv myvenv\n   $ . myvenv/bin/activate\n\n   $ pip install PyQtWebKit\n\nor\n\n.. code-block:: console\n\n   $ pip install pyqt5\n\nor\n\n.. code-block:: console\n\n   $ pip install PyQt5==5.14\n\nand then\n\n.. code-block:: console\n\n\n   $ pip install lavue\n\nMoreover it is also good to install the following python packages:\n\n.. code-block:: console\n\n   $ pip install fabio\n   $ pip install pillow\n   $ pip install pyFAI\n   $ pip install lavuefilters\n   $ pip install pytango\n\nStart the Viewer\n----------------\n\nTo start LaVue\n\n.. code-block:: console\n\n   $ lavue\n\nor\n\n.. code-block:: console\n\n   $ lavue3\n\nfor python 3 version (for older debian/ubuntu releases).\n\nStart the Viewer in the expert mode\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nChanging LaVue settings is available in the expert mode, i.e.\n\n.. code-block:: console\n\n   $ lavue -m expert\n\nunder an additional button: Configuration.\n\nLaunching options\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nTo get all possible command-line parameters\n\n.. code-block:: console\n\n   $ lavue -h\n\nFurther reading\n---------------\n\nMore information can be found at: `LaVue <https://lavue-org.github.io/lavue>`_\n\n| ``Conflunce`` page: https://confluence.desy.de/display/FSEC/LaVue+-+Live+Image+Viewer\n| ``LavueController`` Tango Server API: https://lavue-org.github.io/lavue/stable/doc_html\n",
    "bugtrack_url": null,
    "license": "GPLv2",
    "summary": "Live image viewer application for photon science detectors.",
    "version": "2.94.2",
    "project_urls": {
        "Homepage": "https://github.com/lavue-org/lavue"
    },
    "split_keywords": [
        "live",
        "viewer",
        "photon",
        "science",
        "detector"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4adc2d7ff1a6ae6474a9cef26696560387085552bc83bdd2aaf84069f69e42d0",
                "md5": "cef770bd15ae5c9556b76cb2bb2c5f0c",
                "sha256": "491a5065540ef2130b5d251411853ad83e74ae873f05c1318971a6d3d60c66f4"
            },
            "downloads": -1,
            "filename": "lavue-2.94.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cef770bd15ae5c9556b76cb2bb2c5f0c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 12214300,
            "upload_time": "2024-12-18T08:50:39",
            "upload_time_iso_8601": "2024-12-18T08:50:39.177151Z",
            "url": "https://files.pythonhosted.org/packages/4a/dc/2d7ff1a6ae6474a9cef26696560387085552bc83bdd2aaf84069f69e42d0/lavue-2.94.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "731ccc42eb5d410481de694258e53fb656fc3f367110765d1e954f07eb42db12",
                "md5": "28be7e2273a7617d096973fa451a36c2",
                "sha256": "a1c0aa055b7a856d017af8103a34074b7fef74063f86945a3148276cf8a0ac1e"
            },
            "downloads": -1,
            "filename": "lavue-2.94.2.tar.gz",
            "has_sig": false,
            "md5_digest": "28be7e2273a7617d096973fa451a36c2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 34942170,
            "upload_time": "2024-12-18T08:50:45",
            "upload_time_iso_8601": "2024-12-18T08:50:45.018632Z",
            "url": "https://files.pythonhosted.org/packages/73/1c/cc42eb5d410481de694258e53fb656fc3f367110765d1e954f07eb42db12/lavue-2.94.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-18 08:50:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "lavue-org",
    "github_project": "lavue",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "lavue"
}
        
Elapsed time: 0.40025s