Welcome to nxstools’s documentation!

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

$ python3 setup.py install

Debian packages

Debian trixie, bookworm, bullseye or Ubuntu questing, noble, jammy 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

$ cd /etc/apt/sources.list.d
$ wget http://repos.pni-hdri.de/trixie-pni-hdri.sources

To install nxstools scripts

$ apt-get update
$ apt-get install nxstools

$ apt-get update
$ apt-get install nxstools3

for older python3 releases.

To install only the python3 package

$ apt-get update
$ apt-get install python3-nxstools

and for python2

$ apt-get update
$ apt-get install python-nxstools

if exists.

From pip

To install it from pip you can

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

$ pip install nxstools

Moreover it is also good to install

$ pip install pytango

Metadata

Release files for nxstools 4.69.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nxstools 4.69.0
File	Size	Uploaded
nxstools-4.69.0.tar.gz	1.1 MB	Oct 15, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for nxstools 4.69.0
File	Interpreter	ABI	Platform	Reset
nxstools-4.69.0-py3-none-any.whl 387.0 kB Oct 15, 2026	Python 3	none	any	Details

Total release size: 1.5 MB

Release files / nxstools-4.69.0.tar.gz

Download URL	nxstools-4.69.0.tar.gz
Size	1.1 MB
Tags	Source
SHA-256 checksum How to use checksums	`fee05141d6d91f760b5e5caf219aa213772b87d29c873c639decf6c776e75f37`
BLAKE2b-256 checksum How to use checksums	`970d9d12c47dec44c97d66316fd418344d4310cf0b93dbdecdd32c0f1ead33a4`
Upload date	Oct 15, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.2`

Release files / nxstools-4.69.0-py3-none-any.whl

Download URL	nxstools-4.69.0-py3-none-any.whl
Size	387.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`515ec59d9b7d1ffbf57d76774db3872731f8b8baf6189e21aed31b6b286ce5d6`
BLAKE2b-256 checksum How to use checksums	`e34ebb2e0596b46a6194a23a8b4197e77ed101d20031231d1fbbcd0ffd4138de`
Upload date	Oct 15, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.2`