Welcome to nxstools's documentation!
====================================
|github workflow|
|docs|
|Pypi Version|
|Python Versions|
.. |github workflow| image:: https://github.com/nexdatas/nxstools/actions/workflows/tests.yml/badge.svg
:target: https://github.com/nexdatas/nxstools/actions
:alt:
.. |docs| image:: https://img.shields.io/badge/Documentation-webpages-ADD8E6.svg
:target: https://nexdatas.github.io/nxstools/index.html
:alt:
.. |Pypi Version| image:: https://img.shields.io/pypi/v/nxstools.svg
:target: https://pypi.python.org/pypi/nxstools
:alt:
.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/nxstools.svg
:target: https://pypi.python.org/pypi/nxstools/
:alt:
Authors: Jan Kotanski
------------
Introduction
------------
Configuration tools for NeXDaTaS Tango Servers consists of the following command-line scripts:
- `nxscollect <https://nexdatas.github.io/nxstools/nxscollect.html>`__ uploads external images into the NeXus/HDF5 file
- `nxsconfig <https://nexdatas.github.io/nxstools/nxsconfig.html>`__ reads NeXus Configuration Server settings
- `nxscreate <https://nexdatas.github.io/nxstools/nxscreate.html>`__ creates NeXus Configuration components
- `nxsdata <https://nexdatas.github.io/nxstools/nxsdata.html>`__ runs NeXus Data Writer
- `nxsfileinfo <https://nexdatas.github.io/nxstools/nxsfileinfo.html>`__ shows metadata of the NeXus/HDF5 file
- `nxsetup <https://nexdatas.github.io/nxstools/nxsetup.html>`__ setups NeXDaTaS Tango Server environment
as well as the `nxstools <https://nexdatas.github.io/nxstools/nxstools.html>`__ package which allows perform these operations
directly from a python code.
| Source code: https://github.com/nexdatas/nxstools
| Web page: https://nexdatas.github.io/nxstools
| NexDaTaS Web page: https://nexdatas.github.io
------------
Installation
------------
Install the dependencies:
| pninexus or h5py, numpy, tango, sphinx
From sources
""""""""""""
Download the latest NXS Tools version from
| https://github.com/nexdatas/nxstools
Extract sources and run
.. code-block:: console
$ python3 setup.py install
Debian packages
"""""""""""""""
Debian `bookworm`, `bullseye`, `buster` or Ubuntu `oracluar`, `noble`, `jammy` 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
.. code-block:: console
$ cd /etc/apt/sources.list.d
$ wget http://repos.pni-hdri.de/bookworm-pni-hdri.list
To install nxstools scripts
.. code-block:: console
$ apt-get update
$ apt-get install nxstools
or
.. code-block:: console
$ apt-get update
$ apt-get install nxstools3
for older python3 releases.
To install only the python3 package
.. code-block:: console
$ apt-get update
$ apt-get install python3-nxstools
and for python2
.. code-block:: console
$ apt-get update
$ apt-get install python-nxstools
if exists.
From pip
""""""""
To install it from pip you can
.. code-block:: console
$ python3 -m venv myvenv
$ . myvenv/bin/activate
$ pip install nxstools
Moreover it is also good to install
.. code-block:: console
$ pip install pytango
Raw data
{
"_id": null,
"home_page": "http://github.com/nexdatas/nxstools",
"name": "nxstools",
"maintainer": "Jan Kotanski, Eugen Wintersberger , Halil Pasic",
"docs_url": null,
"requires_python": null,
"maintainer_email": "jankotan@gmail.com, eugen.wintersberger@gmail.com, halil.pasic@gmail.com",
"keywords": "configuration writer Tango component nexus data",
"author": "Jan Kotanski, Eugen Wintersberger , Halil Pasic",
"author_email": "jankotan@gmail.com, eugen.wintersberger@gmail.com, halil.pasic@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/24/c2/1eda6a4440fc813d8737c68f926f9536c1985b9821953651e85eb625dcb4/nxstools-4.18.1.tar.gz",
"platform": "Linux",
"description": "Welcome to nxstools's documentation!\n====================================\n\n\n|github workflow|\n|docs|\n|Pypi Version|\n|Python Versions|\n\n.. |github workflow| image:: https://github.com/nexdatas/nxstools/actions/workflows/tests.yml/badge.svg\n :target: https://github.com/nexdatas/nxstools/actions\n :alt:\n\n.. |docs| image:: https://img.shields.io/badge/Documentation-webpages-ADD8E6.svg\n :target: https://nexdatas.github.io/nxstools/index.html\n :alt:\n\n.. |Pypi Version| image:: https://img.shields.io/pypi/v/nxstools.svg\n :target: https://pypi.python.org/pypi/nxstools\n :alt:\n\n.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/nxstools.svg\n :target: https://pypi.python.org/pypi/nxstools/\n :alt:\n\n\nAuthors: Jan Kotanski\n\n------------\nIntroduction\n------------\n\nConfiguration tools for NeXDaTaS Tango Servers consists of the following command-line scripts:\n\n- `nxscollect <https://nexdatas.github.io/nxstools/nxscollect.html>`__ uploads external images into the NeXus/HDF5 file\n- `nxsconfig <https://nexdatas.github.io/nxstools/nxsconfig.html>`__ reads NeXus Configuration Server settings\n- `nxscreate <https://nexdatas.github.io/nxstools/nxscreate.html>`__ creates NeXus Configuration components\n- `nxsdata <https://nexdatas.github.io/nxstools/nxsdata.html>`__ runs NeXus Data Writer\n- `nxsfileinfo <https://nexdatas.github.io/nxstools/nxsfileinfo.html>`__ shows metadata of the NeXus/HDF5 file\n- `nxsetup <https://nexdatas.github.io/nxstools/nxsetup.html>`__ setups NeXDaTaS Tango Server environment\n\nas well as the `nxstools <https://nexdatas.github.io/nxstools/nxstools.html>`__ package which allows perform these operations\ndirectly from a python code.\n\n| Source code: https://github.com/nexdatas/nxstools\n| Web page: https://nexdatas.github.io/nxstools\n| NexDaTaS Web page: https://nexdatas.github.io\n\n------------\nInstallation\n------------\n\nInstall the dependencies:\n\n| pninexus or h5py, numpy, tango, sphinx\n\nFrom sources\n\"\"\"\"\"\"\"\"\"\"\"\"\n\nDownload the latest NXS Tools version from\n\n| https://github.com/nexdatas/nxstools\n\nExtract sources and run\n\n.. code-block:: console\n\n\t $ python3 setup.py install\n\nDebian packages\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nDebian `bookworm`, `bullseye`, `buster` or Ubuntu `oracluar`, `noble`, `jammy` 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\t $ sudo su\n\t $ 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\t $ chmod 644 /etc/apt/trusted.gpg.d/debian-hdri-repo.gpg\n\nand then download the corresponding source list\n\n.. code-block:: console\n\n\t $ cd /etc/apt/sources.list.d\n\t $ wget http://repos.pni-hdri.de/bookworm-pni-hdri.list\n\nTo install nxstools scripts\n\n.. code-block:: console\n\n\t $ apt-get update\n\t $ apt-get install nxstools\n\nor\n\n.. code-block:: console\n\n\t $ apt-get update\n\t $ apt-get install nxstools3\n\nfor older python3 releases.\n\nTo install only the python3 package\n\n.. code-block:: console\n\n\t $ apt-get update\n\t $ apt-get install python3-nxstools\n\nand for python2\n\n.. code-block:: console\n\n\t $ apt-get update\n\t $ apt-get install python-nxstools\n\nif exists.\n\n\nFrom pip\n\"\"\"\"\"\"\"\"\n\nTo install it from pip you can\n\n.. code-block:: console\n\n $ python3 -m venv myvenv\n $ . myvenv/bin/activate\n\n $ pip install nxstools\n\nMoreover it is also good to install\n\n.. code-block:: console\n\n $ pip install pytango\n",
"bugtrack_url": null,
"license": "GNU GENERAL PUBLIC LICENSE version 3",
"summary": "Configuration tools for NeXDaTaS Tango Servers",
"version": "4.18.1",
"project_urls": {
"Homepage": "http://github.com/nexdatas/nxstools"
},
"split_keywords": [
"configuration",
"writer",
"tango",
"component",
"nexus",
"data"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "69ddd72dd8d7dada8acc4be377110c145727f027a5a4c2b2e03fefe5fd6ed2b0",
"md5": "08a94515b59e965b353e382f00cc6e90",
"sha256": "b7309d66850c71f2c54aa11c74e4f1d13042ac25d1ed3b5401602d2c8aab36dc"
},
"downloads": -1,
"filename": "nxstools-4.18.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "08a94515b59e965b353e382f00cc6e90",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 303520,
"upload_time": "2024-12-11T11:04:25",
"upload_time_iso_8601": "2024-12-11T11:04:25.618510Z",
"url": "https://files.pythonhosted.org/packages/69/dd/d72dd8d7dada8acc4be377110c145727f027a5a4c2b2e03fefe5fd6ed2b0/nxstools-4.18.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "24c21eda6a4440fc813d8737c68f926f9536c1985b9821953651e85eb625dcb4",
"md5": "fe52c675987f1e6d302e2cd184f44349",
"sha256": "ae0391cbeda314d409d110714325be9fc9b50394f5071d25d50e8becbe0dd321"
},
"downloads": -1,
"filename": "nxstools-4.18.1.tar.gz",
"has_sig": false,
"md5_digest": "fe52c675987f1e6d302e2cd184f44349",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1020747,
"upload_time": "2024-12-11T11:04:30",
"upload_time_iso_8601": "2024-12-11T11:04:30.419540Z",
"url": "https://files.pythonhosted.org/packages/24/c2/1eda6a4440fc813d8737c68f926f9536c1985b9821953651e85eb625dcb4/nxstools-4.18.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-11 11:04:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nexdatas",
"github_project": "nxstools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nxstools"
}
JSON
