https://github.com/nexdatas/nxstools
NeXus command-line tools for setting NeXus tango servers and preparing their configurtation
https://github.com/nexdatas/nxstools
hdf5 nexusformat python tango
Last synced: 9 months ago
JSON representation
NeXus command-line tools for setting NeXus tango servers and preparing their configurtation
- Host: GitHub
- URL: https://github.com/nexdatas/nxstools
- Owner: nexdatas
- License: gpl-3.0
- Created: 2015-03-24T11:00:28.000Z (almost 11 years ago)
- Default Branch: develop
- Last Pushed: 2024-05-22T19:41:15.000Z (over 1 year ago)
- Last Synced: 2024-05-22T20:27:18.361Z (over 1 year ago)
- Topics: hdf5, nexusformat, python, tango
- Language: Python
- Homepage:
- Size: 8.7 MB
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.rst
- Changelog: ChangeLog
Awesome Lists containing this project
README
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 `__ uploads external images into the NeXus/HDF5 file
- `nxsconfig `__ reads NeXus Configuration Server settings
- `nxscreate `__ creates NeXus Configuration components
- `nxsdata `__ runs NeXus Data Writer
- `nxsfileinfo `__ shows metadata of the NeXus/HDF5 file
- `nxsetup `__ setups NeXDaTaS Tango Server environment
as well as the `nxstools `__ 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