pninexus


Namepninexus JSON
Version 3.2.2 PyPI version JSON
download
home_pagehttps://github.com/pni-libraries/python-pninexus
SummaryPython wrapper for the H5CPP and PNI libraries
upload_time2023-10-18 15:31:28
maintainerEugen Wintersberger, Jan Kotanski
docs_urlNone
authorEugen Wintersberger
requires_python
licenseGPLv2
keywords h5cpp hdf5 python photon science detector
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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>`__.
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/pni-libraries/python-pninexus",
    "name": "pninexus",
    "maintainer": "Eugen Wintersberger, Jan Kotanski",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "jan.kotanski@desy.de",
    "keywords": "h5cpp hdf5 python photon science detector",
    "author": "Eugen Wintersberger",
    "author_email": "eugen.wintersberger@desy.de",
    "download_url": "https://files.pythonhosted.org/packages/72/2b/3c6f65152e6fcbf4f3583c6dafc2c9e2658f90dffbe66f903eb46aa4a3b8/pninexus-3.2.2.tar.gz",
    "platform": null,
    "description": "Python bindings for PNI/NeXus and h5cpp\n=======================================\n\n\n|github workflow|\n|docs|\n|Pypi Version|\n|Python Versions|\n\n.. |github workflow| image:: https://github.com/pni-libraries/python-pninexus/actions/workflows/tests.yml/badge.svg\n   :target: https://github.com/pni-libraries/python-pninexus/actions\n   :alt:\n\n.. |docs| image:: https://img.shields.io/badge/Documentation-webpages-ADD8E6.svg\n   :target: https://pni-libraries.github.io/python-pninexus/index.html\n   :alt:\n\n.. |Pypi Version| image:: https://img.shields.io/pypi/v/pninexus.svg\n                  :target: https://pypi.python.org/pypi/pninexus\n                  :alt:\n\n.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/pninexus.svg\n                     :target: https://pypi.python.org/pypi/pninexus/\n                     :alt:\n\n\nPython wrapper for the `h5cpp <https://github.com/ess-dmsc/h5cpp>`__ and\n`libpninexus <https://github.com/pni-libraries/libpninexus>`__ C++\nlibraries. The wrapper supports Python 2.X and 3.X.\n\nInstallation\n------------\n\nRequired packages\n~~~~~~~~~~~~~~~~~\n\n-  *h5cpp* >= 0.5.0\n-  *libpninexus* >= 3.2.0\n-  python setuptools\n-  numpy\n-  c++ compiler\n-  boost-python library\n-  python sphinx to build the documentation\n\nInstall from sources\n~~~~~~~~~~~~~~~~~~~~\n\nThe code can be built with\n\n::\n\n       $ python setup.py install\n\nFor those who are still running on the old interface it is maybe whise\nto install this package in a custom location with something like this\n\n::\n\n       $ python setup.py install --prefix=<path to installation prefix>\n\nTo build the documentation use\n\n::\n\n       $ python setup.py build_sphinx\n\nThe resulting documentation can be found below ``build/sphinx/html`` in\nthe root directory of the source distribution.\n\nFinally, the package can be tested using\n\n::\n\n       $ python setup.py test\n\nFor Python3 just replace python with python3 in the above instructions.\n\nDebian and Ubuntu packages\n~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nDebian ``bookworm``, ``bullseye``, ``buster`` or Ubuntu ``lunar``,\n``jammy``, ``focal`` packages can be found in the HDRI repository.\n\nTo install the debian packages, add the PGP repository key\n\n::\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. for ``bullseye``\n\n::\n\n       $ cd /etc/apt/sources.list.d\n       $ wget http://repos.pni-hdri.de/bullseye-pni-hdri.list\n\nor ``jammy``\n\n::\n\n       $ cd /etc/apt/sources.list.d\n       $ wget http://repos.pni-hdri.de/jammy-pni-hdri.list\n\nrespectively.\n\nFinally,\n\n::\n\n       $ apt-get update\n       $ apt-get install python-pninexus\n\nor\n\n::\n\n       $ apt-get update\n       $ apt-get install python3-pninexus\n\nfor python3.\n\n\nManylinux wheels from PyPI\n~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nTo install pninexus in a conda or python virtual environment manylinux pip wheels can be used, e.g.\n\n.. code-block:: console\n\n   $ python3 -m venv myvenv\n   $ . myvenv/bin/activate\n   \n   $ pip install pip --upgrade\n   $ pip install numpy\n   \n   $ pip install pninexus -U wheel\n\nFor some versions of wheels numpy needs to be installed in advance.\n\nStarting from v3.2.2 the pninexus wheel contains the most important external filters.\nIn order to use them one needs to set HDF5_PLUGIN_PATH e.g. by\n\n.. code-block:: python\n\n   import pninexus\n\n\nMore information can be found at `online\ndocumentation <https://pni-libraries.github.io/python-pninexus/index.html>`__.\n\nChanges for a specific version of libpninexus can be found at\n`CHANGELOG <https://github.com/pni-libraries/python-pninexus/blob/develop/CHANGELOG.md>`__.",
    "bugtrack_url": null,
    "license": "GPLv2",
    "summary": "Python wrapper for the H5CPP and PNI libraries",
    "version": "3.2.2",
    "project_urls": {
        "Homepage": "https://github.com/pni-libraries/python-pninexus"
    },
    "split_keywords": [
        "h5cpp",
        "hdf5",
        "python",
        "photon",
        "science",
        "detector"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "47e407bdca635552dea7c785d555788024eeb3cc6d5fc37e097eb87fd3f8c19a",
                "md5": "8aa65021a68246882ea6b5200e6960a7",
                "sha256": "f648c0f7a742eca89609820dc69dc4422de47b5ac4f2a14f1c08eb7a3a64f46e"
            },
            "downloads": -1,
            "filename": "pninexus-3.2.2-cp39-cp39-manylinux_2_31_x86_64.whl",
            "has_sig": false,
            "md5_digest": "8aa65021a68246882ea6b5200e6960a7",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": null,
            "size": 27250110,
            "upload_time": "2023-10-18T15:41:08",
            "upload_time_iso_8601": "2023-10-18T15:41:08.459243Z",
            "url": "https://files.pythonhosted.org/packages/47/e4/07bdca635552dea7c785d555788024eeb3cc6d5fc37e097eb87fd3f8c19a/pninexus-3.2.2-cp39-cp39-manylinux_2_31_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "722b3c6f65152e6fcbf4f3583c6dafc2c9e2658f90dffbe66f903eb46aa4a3b8",
                "md5": "6d72b1ac644cab5cfa738e3cfe0fe81f",
                "sha256": "fa0bcf6610d93b776afb8542620a2475cdcb2e830d8f4e2d30361adef2341f41"
            },
            "downloads": -1,
            "filename": "pninexus-3.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "6d72b1ac644cab5cfa738e3cfe0fe81f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 183217,
            "upload_time": "2023-10-18T15:31:28",
            "upload_time_iso_8601": "2023-10-18T15:31:28.764592Z",
            "url": "https://files.pythonhosted.org/packages/72/2b/3c6f65152e6fcbf4f3583c6dafc2c9e2658f90dffbe66f903eb46aa4a3b8/pninexus-3.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-18 15:31:28",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "pni-libraries",
    "github_project": "python-pninexus",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pninexus"
}
        
Elapsed time: 0.13217s