Metadata-Version: 2.1
Name: nxsconfigtool
Version: 2.2.0
Summary: Configuration tool  for creating components
Home-page: https://github.com/nexdatas/nxsdesigner/
Author: Jan Kotanski, Eugen Wintersberger , Halil Pasic
Author-email: jankotan@gmail.com, eugen.wintersberger@gmail.com, halil.pasic@gmail.com
Maintainer: Jan Kotanski, Eugen Wintersberger , Halil Pasic
Maintainer-email: jankotan@gmail.com, eugen.wintersberger@gmail.com, halil.pasic@gmail.com
License: GPLv3
Keywords: configuration writer Tango component nexus data
Platform: Linux
Platform: Windows
Platform: MacOS
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13

Welcome to nxsconfigtool's documentation!
=========================================

|github workflow|
|docs|
|Pypi Version|
|Python Versions|

.. |github workflow| image:: https://github.com/nexdatas/nxsdesigner/actions/workflows/tests.yml/badge.svg
   :target: https://github.com/nexdatas/nxsdesigner/actions
   :alt:

.. |docs| image:: https://img.shields.io/badge/Documentation-webpages-ADD8E6.svg
   :target: https://nexdatas.github.io/nxsdesigner/index.html
   :alt:

.. |Pypi Version| image:: https://img.shields.io/pypi/v/nxsconfigtool.svg
                  :target: https://pypi.python.org/pypi/nxsconfigtool
                  :alt:

.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/nxsconfigtool.svg
                     :target: https://pypi.python.org/pypi/nxsconfigtool/
                     :alt:



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.

| Source code: https://github.com/nexdatas/nxsdesigner
| Web page: https://nexdatas.github.io/nxsdesigner/
| NexDaTaS Web page: https://nexdatas.github.io

------------
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

|    https://github.com/nexdatas/nxsdesigner/

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

.. code-block:: console

	  $ python3 setup.py install

and launch

.. code-block:: console

	  $ nxsdesigner

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

.. 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/trixie-pni-hdri.sources

Finally,

.. code-block:: console

	  $ apt-get update
	  $ apt-get install nxsconfigtool

To instal other NexDaTaS packages

.. code-block:: console

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

and

.. code-block:: console

	  $ 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.

.. code-block:: console

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

   $ pip install pyqt5
   $ pip install nxsconfigtool

Moreover it is also good to install

.. code-block:: console

   $ pip install pytango


General overview
================


   Component Designer

.. image:: 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.
