Metadata-Version: 1.2
Name: pninexus
Version: 3.2.2
Summary: Python wrapper for the H5CPP and PNI libraries
Home-page: https://github.com/pni-libraries/python-pninexus
Author: Eugen Wintersberger
Author-email: eugen.wintersberger@desy.de
Maintainer: Eugen Wintersberger, Jan Kotanski
Maintainer-email: jan.kotanski@desy.de
License: GPLv2
Description: Python bindings for PNI/NeXus and h5cpp
        =======================================
        
        
        |github workflow|
        |docs|
        |Pypi Version|
        |Python Versions|
        
        .. |github workflow| image:: https://github.com/pni-libraries/python-pninexus/actions/workflows/tests.yml/badge.svg
           :target: https://github.com/pni-libraries/python-pninexus/actions
           :alt:
        
        .. |docs| image:: https://img.shields.io/badge/Documentation-webpages-ADD8E6.svg
           :target: https://pni-libraries.github.io/python-pninexus/index.html
           :alt:
        
        .. |Pypi Version| image:: https://img.shields.io/pypi/v/pninexus.svg
                          :target: https://pypi.python.org/pypi/pninexus
                          :alt:
        
        .. |Python Versions| image:: https://img.shields.io/pypi/pyversions/pninexus.svg
                             :target: https://pypi.python.org/pypi/pninexus/
                             :alt:
        
        
        Python wrapper for the `h5cpp <https://github.com/ess-dmsc/h5cpp>`__ and
        `libpninexus <https://github.com/pni-libraries/libpninexus>`__ C++
        libraries. The wrapper supports Python 2.X and 3.X.
        
        Installation
        ------------
        
        Required packages
        ~~~~~~~~~~~~~~~~~
        
        -  *h5cpp* >= 0.5.0
        -  *libpninexus* >= 3.2.0
        -  python setuptools
        -  numpy
        -  c++ compiler
        -  boost-python library
        -  python sphinx to build the documentation
        
        Install from sources
        ~~~~~~~~~~~~~~~~~~~~
        
        The code can be built with
        
        ::
        
               $ python setup.py install
        
        For those who are still running on the old interface it is maybe whise
        to install this package in a custom location with something like this
        
        ::
        
               $ python setup.py install --prefix=<path to installation prefix>
        
        To build the documentation use
        
        ::
        
               $ python setup.py build_sphinx
        
        The resulting documentation can be found below ``build/sphinx/html`` in
        the root directory of the source distribution.
        
        Finally, the package can be tested using
        
        ::
        
               $ python setup.py test
        
        For Python3 just replace python with python3 in the above instructions.
        
        Debian and Ubuntu packages
        ~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        Debian ``bookworm``, ``bullseye``, ``buster`` or Ubuntu ``lunar``,
        ``jammy``, ``focal`` packages can be found in the HDRI repository.
        
        To install the debian packages, add the PGP repository key
        
        ::
        
               $ 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. for ``bullseye``
        
        ::
        
               $ cd /etc/apt/sources.list.d
               $ wget http://repos.pni-hdri.de/bullseye-pni-hdri.list
        
        or ``jammy``
        
        ::
        
               $ cd /etc/apt/sources.list.d
               $ wget http://repos.pni-hdri.de/jammy-pni-hdri.list
        
        respectively.
        
        Finally,
        
        ::
        
               $ apt-get update
               $ apt-get install python-pninexus
        
        or
        
        ::
        
               $ apt-get update
               $ apt-get install python3-pninexus
        
        for python3.
        
        
        Manylinux wheels from PyPI
        ~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        To install pninexus in a conda or python virtual environment manylinux pip wheels can be used, e.g.
        
        .. code-block:: console
        
           $ python3 -m venv myvenv
           $ . myvenv/bin/activate
           
           $ pip install pip --upgrade
           $ pip install numpy
           
           $ pip install pninexus -U wheel
        
        For some versions of wheels numpy needs to be installed in advance.
        
        Starting from v3.2.2 the pninexus wheel contains the most important external filters.
        In order to use them one needs to set HDF5_PLUGIN_PATH e.g. by
        
        .. code-block:: python
        
           import pninexus
        
        
        More information can be found at `online
        documentation <https://pni-libraries.github.io/python-pninexus/index.html>`__.
        
        Changes for a specific version of libpninexus can be found at
        `CHANGELOG <https://github.com/pni-libraries/python-pninexus/blob/develop/CHANGELOG.md>`__.
        
        
Keywords: h5cpp hdf5 python photon science detector
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Programming Language :: Python :: 2.7
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: Programming Language :: Python :: 3.11
