Skip to content

Latest commit

 

History

History
158 lines (94 loc) · 3.93 KB

README.rst

File metadata and controls

158 lines (94 loc) · 3.93 KB
Raw

Welcome to nxsconfigtool's documentation!

Authors: Jan Kotanski, Eugen Wintersberger, Halil Pasic

Component Designer is a GUI configuration tool dedicated to create components as well as datasources which constitute the XML configuration strings of Nexus Data Writer (NXS). The created XML elements can be saved in the extended Nexus XML format in Configuration Tango Server or in disk files.

Installation

Install the dependencies:

PyQt4, PyTango (optional)

PyTango is only needed if one wants to use Configuration Server

From sources

Download the latest NXS Configuration Tool version from

and extract the sources.

One can also download the lastest version directly from the git repository by

git clone https://github.com/jkotan/nexdatas.configtool/

Next, run the installation script

$ python3 setup.py install

and launch

$ nxsdesigner

Debian packages

Debian Bookworm, Bullseye, Buster or Ubuntu Oracular, Noble, Jammy packages can be found in the HDRI repository.

To install the debian packages, add the PGP repository key

$ sudo su
$ wget -q -O - http://repos.pni-hdri.de/debian_repo.pub.gpg | apt-key add -

and then download the corresponding source list

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

Finally,

$ apt-get update
$ apt-get install nxsconfigtool

To instal other NexDaTaS packages

$ apt-get install python3-nxswriter python3-nxsconfigserver nxsconfigserver-db nxstools

and

$ apt-get install python3-nxsrecselector nxselector python3-sardana-nxsrecorder

for Component Selector and Sardana related packages.

From pip

To install it from pip you need to install pyqt5, e.g.

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

$ pip install pyqt5
$ pip install nxsconfigtool

Moreover it is also good to install

$ pip install pytango

General overview

Component Designer

https://github.com/nexdatas/nxsdesigner/blob/develop/doc/png/designer2.png?raw=true

The NXS Component Designer program allows to creates components as well as datasources which constitute the XML configuration strings of Nexus Data Writer (NXS). The created XML elements can be saved in the extended Nexus XML format in Configuration Tango Server or in disk files.

Collection Dock Window contains lists of the currently open components and datasources. Selecting one of the components or datasources from the lists causes opening either Component Window or DataSource Window.

All the most commonly used menu options are also available on Toolbar.

A short description of all actions can be found in Help menu.

Icons

Icons fetched from http://findicons.com/pack/990/vistaico_toolbar.