nxswriter 3.10.0__tar.gz → 3.11.1__tar.gz

{nxswriter-3.10.0 → nxswriter-3.11.1}/.ci/install.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 # restart mysqldb
-if [ "$1" = "debian11" ] || [ "$1" = "debian12" ]; then
+if [ "$1" = "debian11" ] || [ "$1" = "debian12" ] || [ "$1" = "ubuntu24.04" ]; then
     docker exec --user root ndts service mariadb restart
 else
     # workaround for a bug in debian9, i.e. starting mysql hangs
@@ -15,24 +15,35 @@ else
     # docker exec  --user root ndts /bin/bash -c '$(service mysql start &) && sleep 30'
 fi
 
-
-echo "install tango db"
-docker exec  --user root ndts /bin/sh -c 'apt-get -qq update; apt-get -qq install -y   tango-db tango-common; sleep 10'
-if [ "$?" != "0" ]; then exit 255; fi
-
-docker exec --user root ndts /bin/bash -c 'export DEBIAN_FRONTEND=noninteractive; apt-get -qq update; apt-get -qq install -y   tango-db tango-common; sleep 10'
-if [ "$?" != "0" ]; then exit 255; fi
-
-if [ "$1" = "ubuntu20.04" ] || [ "$1" = "ubuntu20.10" ] || [ "$1" = "ubuntu21.04" ] || [ "$1" = "ubuntu21.10" ] || [ "$1" = "ubuntu22.04" ] || [ "$1" = "ubuntu23.10" ]; then
+echo "install tango-common"
+docker exec  --user root ndts /bin/bash -c 'apt-get -qq update; export DEBIAN_FRONTEND=noninteractive; apt-get -qq install -y tango-common; sleep 10'
+if  [ "$1" = "ubuntu24.04" ]; then
+    # docker exec  --user tango ndts /bin/bash -c '/usr/lib/tango/DataBaseds 2 -ORBendPoint giop:tcp::10000  &'
+    docker exec  --user root ndts /bin/bash -c 'echo -e "[client]\nuser=root\npassword=rootpw" > /root/.my.cnf'
+    docker exec  --user root ndts /bin/bash -c 'echo -e "[client]\nuser=tango\nhost=localhost\npassword=rootpw" > /var/lib/tango/.my.cnf'
+    docker exec  --user root ndts /usr/bin/mysql -e 'GRANT ALL PRIVILEGES ON tango.* TO "tango"@"%" identified by "rootpw"'
+    docker exec  --user root ndts /usr/bin/mysql -e 'GRANT ALL PRIVILEGES ON tango.* TO "tango"@"localhost" identified by "rootpw"'
+    docker exec  --user root ndts /usr/bin/mysql -e 'FLUSH PRIVILEGES'
+fi
+if [ "$1" = "ubuntu20.04" ] || [ "$1" = "ubuntu20.10" ] || [ "$1" = "ubuntu21.04" ] || [ "$1" = "ubuntu21.10" ] || [ "$1" = "ubuntu22.04" ]; then
     # docker exec  --user tango ndts /bin/bash -c '/usr/lib/tango/DataBaseds 2 -ORBendPoint giop:tcp::10000  &'
-    docker exec  --user root ndts /bin/bash -c 'echo -e "[client]\nuser=tango\nhost=127.0.0.1\npassword=rootpw" > /var/lib/tango/.my.cnf'
     docker exec  --user root ndts /bin/bash -c 'echo -e "[client]\nuser=root\npassword=rootpw" > /root/.my.cnf'
+    docker exec  --user root ndts /bin/bash -c 'echo -e "[client]\nuser=tango\nhost=127.0.0.1\npassword=rootpw" > /var/lib/tango/.my.cnf'
+fi
+echo "install tango-db"
+docker exec  --user root ndts /bin/bash -c 'apt-get -qq update; export DEBIAN_FRONTEND=noninteractive; apt-get -qq install -y tango-db; sleep 10'
+if [ "$?" -ne "0" ]; then exit 255; fi
+if  [ "$1" = "ubuntu24.04" ]; then
+    docker exec  --user tango ndts /usr/bin/mysql -e 'create database tango'
+    docker exec  --user tango ndts /bin/bash -c '/usr/bin/mysql tango < /usr/share/dbconfig-common/data/tango-db/install/mysql'
 fi
+
 docker exec  --user root ndts service tango-db restart
 
+
 echo "install tango servers"
-docker exec  --user root ndts /bin/sh -c 'apt-get -qq update; apt-get -qq install -y  tango-starter tango-test'
-if [ "$?" != "0" ]; then exit 255; fi
+docker exec  --user root ndts /bin/bash -c 'apt-get -qq update; export DEBIAN_FRONTEND=noninteractive;  apt-get -qq install -y  tango-starter tango-test liblog4j1.2-java'
+if [ "$?" -ne "0" ]; then exit 255; fi
 
 # restart tango services
 docker exec  --user root ndts service tango-starter restart
@@ -43,7 +54,7 @@ if [ "$2" = "2" ]; then
     docker exec  --user root ndts /bin/sh -c 'apt-get -qq update; apt-get -qq install -y   python-pytango nxsconfigserver-db python-nxstools'
 else
     echo "install python3-pytango"
-    if [ "$1" = "ubuntu20.04" ] || [ "$1" = "ubuntu20.10" ] || [ "$1" = "ubuntu21.04" ] || [ "$1" = "ubuntu23.10" ] || [ "$1" = "ubuntu22.04" ] || [ "$1" = "debian11" ] || [ "$1" = "debian12" ]; then
+    if [ "$1" = "ubuntu20.04" ] || [ "$1" = "ubuntu20.10" ] || [ "$1" = "ubuntu21.04" ] || [ "$1" = "ubuntu24.04" ] || [ "$1" = "ubuntu23.10" ] || [ "$1" = "ubuntu22.04" ] || [ "$1" = "debian11" ] || [ "$1" = "debian12" ]; then
 	docker exec  --user root ndts /bin/sh -c 'apt-get -qq update; apt-get -qq install -y   python3-tango nxsconfigserver-db python3-nxstools'
     else
 	docker exec  --user root ndts /bin/sh -c 'apt-get -qq update; apt-get -qq install -y   python3-pytango nxsconfigserver-db python3-nxstools'

{nxswriter-3.10.0 → nxswriter-3.11.1}/.github/workflows/tests.yml

@@ -24,7 +24,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        os: [debian12, debian11, debian10, ubuntu23.10, ubuntu22.04, ubuntu20.04]
+        os: [debian12, debian11, debian10, ubuntu24.04, ubuntu22.04, ubuntu20.04]
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2

{nxswriter-3.10.0 → nxswriter-3.11.1}/ChangeLog

@@ -1,3 +1,11 @@
+2023-11-09 Jan Kotanski <jankotan@gmail.com>
+	* call finish on writer if exists  (#165)
+	* tagged as 3.11.1
+
+2023-11-09 Jan Kotanski <jankotan@gmail.com>
+	* add support for h5redis writer (#165)
+	* tagged as 3.11.0
+
 2023-11-09 Jan Kotanski <jankotan@gmail.com>
 	* change tango.Device_4Impl to tango.LatestDeviceImpl (#160)
 	* tagged as 3.10.0

nxswriter-3.11.1/PKG-INFO

@@ -0,0 +1,273 @@
+Metadata-Version: 2.1
+Name: nxswriter
+Version: 3.11.1
+Summary: Nexus Data writer implemented as a Tango Server
+Home-page: https://github.com/nexdatas/nxsdatawriter
+Author: Jan Kotanski, Eugen Wintersberger , Halil Pasic
+Author-email: jankotan@gmail.com, eugen.wintersberger@gmail.com, halil.pasic@gmail.com
+License: GNU GENERAL PUBLIC LICENSE v3
+Keywords: writer Tango server nexus data
+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 v3 (GPLv3)
+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
+
+Welcome to NXSDataWriter's documentation!
+=========================================
+
+|github workflow|
+|docs|
+|Pypi Version|
+|Python Versions|
+
+.. |github workflow| image:: https://github.com/nexdatas/nxsdatawriter/actions/workflows/tests.yml/badge.svg
+   :target: https://github.com/nexdatas/nxsdatawriter/actions
+   :alt:
+
+.. |docs| image:: https://img.shields.io/badge/Documentation-webpages-ADD8E6.svg
+   :target: https://nexdatas.github.io/nxsdatawriter/index.html
+   :alt:
+
+.. |Pypi Version| image:: https://img.shields.io/pypi/v/nxswriter.svg
+                  :target: https://pypi.python.org/pypi/nxswriter
+                  :alt:
+
+.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/nxswriter.svg
+                     :target: https://pypi.python.org/pypi/nxswriter/
+                     :alt:
+
+
+Authors: Jan Kotanski, Eugen Wintersberger, Halil Pasic
+
+------------
+Introduction
+------------
+
+NXSDataWriter is a Tango server which allows to store NeXuS Data in H5 files.
+
+The server provides storing data from other Tango devices,
+various databases as well as passed by a user client via JSON strings.
+
+Tango Server API: https://nexdatas.github.io/nxsdatawriter/doc_html
+
+| Source code: https://github.com/nexdatas/nxsdatawriter
+| Project Web page: https://nexdatas.github.io/nxsdatawriter
+| NexDaTaS Web page: https://nexdatas.github.io
+
+------------
+Installation
+------------
+
+Install the dependencies:
+
+|    pninexus or h5py, tango, numpy, nxstools, sphinx
+
+From sources
+""""""""""""
+
+Download the latest NexDaTaS version from
+
+|    https://github.com/nexdatas/nxsdatawriter
+
+Extract sources and run
+
+.. code-block:: console
+
+	  $ python setup.py install
+
+Debian packages
+"""""""""""""""
+
+Debian `bookworm`, `bullseye`, `buster`  or Ubuntu `lunar`, `jammy`, `focal`  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 tango server
+
+.. code-block:: console
+
+	  $ apt-get update
+	  $ apt-get install nxswriter
+
+or
+
+.. code-block:: console
+
+	  $ apt-get update
+	  $ apt-get install nxswriter3
+
+for older python3 releases.
+
+To install only the python3 package
+
+.. code-block:: console
+
+	  $ apt-get update
+	  $ apt-get install python3-nxswriter
+
+and for python2
+
+.. code-block:: console
+
+	  $ apt-get update
+	  $ apt-get install python-nxswriter
+
+if exists.
+
+
+
+From pip
+""""""""
+
+To install it from pip you can
+
+.. code-block:: console
+
+   $ python3 -m venv myvenv
+   $ . myvenv/bin/activate
+
+   $ pip install nxswriter
+
+Moreover it is also good to install
+
+.. code-block:: console
+
+   $ pip install pytango
+   $ pip install pymysqldb
+   $ pip install psycopg2-binary
+   $ pip install cx-oracle
+
+Setting NeXus Writer Server
+"""""""""""""""""""""""""""
+
+To set up  NeXus Writer Server run
+
+.. code-block:: console
+
+          $ nxsetup -x NXSDataWriter
+
+The *nxsetup* command comes from the **python-nxstools** package.
+
+-----------
+Client code
+-----------
+
+In order to use Nexus Data Server one has to write a client code. Some simple client codes
+are in the  nexdatas repository. In this section we add some
+comments related to the client code.
+
+.. code-block:: python
+
+   # To use the Tango Server we must import the tango module and
+   # create DeviceProxy for the server.
+
+   import tango
+
+   device = "p09/tdw/r228"
+   dpx = tango.DeviceProxy(device)
+   dpx.set_timeout_millis(10000)
+
+   dpx.Init()
+
+   # Here device corresponds to a name of our Nexus Data Server.
+   # The Init() method resets the state of the server.
+
+   dpx.FileName = "test.h5"
+   dpx.OpenFile()
+
+   # We set the name of the output HDF5 file and open it.
+
+   # Now we are ready to pass the XML settings describing a structure of
+   # the output file as well as defining a way of data storing.
+   # Examples of the XMLSettings can be found in the XMLExamples directory.
+
+   with open("test.xml", 'r') as fl:
+       xml = fl.read()
+   dpx.XMLSettings = xml
+
+   dpx.JSONRecord = '{"data": {"parameterA":0.2},
+			 "decoders":{"DESY2D":"desydecoders.desy2Ddec.desy2d"},
+			 "datasources":{
+		              "MCLIENT":"sources.DataSources.LocalClientSource"}
+   }'
+
+   dpx.OpenEntry()
+
+   # We read our XML settings settings from a file and pass them to the server via
+   # the XMLSettings attribute. Then we open an entry group related to the XML
+   # configuration. Optionally, we can also set JSONRecord, i.e. an attribute
+   # which contains a global JSON string with data needed to store during opening
+   # the entry and also other stages of recording. If external decoder for
+   # DevEncoded data is need one can registred it passing its packages and
+   # class names in JSONRecord,
+   # e.g. "desy2d" class of "DESY2D" label in "desydecoders.desy2Ddec" package.
+   # Similarly making use of "datasources" records of the JSON string one can
+   # registred additional datasources. The OpenEntry method stores data defined
+   # in the XML string with strategy=INIT.
+   # The JSONRecord attribute can be changed during recording our data.
+
+   # After finalization of the configuration process we can start recording
+   # the main experiment data in a STEP mode.
+
+   dpx.Record('{"data": {"p09/counter/exp.01":0.1, "p09/counter/exp.02":1.1}}')
+
+   # Every time we call the Record method all nexus fields defined with
+   # strategy=STEP are extended by one record unit and the assigned to them data
+   # is stored. As the method argument we pass a local JSON string with the client
+   # data. To record the client data one can also use the global JSONRecord string.
+   # Contrary to the global JSON string the local one is only
+   # valid during one record step.
+
+   dpx.Record('{"data": {"emittance_x": 0.1},  "triggers":["trigger1", "trigger2"]  }')
+
+   # If you denote in your XML configuration string some fields by additional
+   # trigger attributes you may ask the server to store your data only in specific
+   # record steps. This can be helpful if you want to store your data in
+   # asynchronous mode. To this end you define in the local JSON string a list of
+   # triggers which are used in the current record step.
+
+   dpx.JSONRecord = '{"data": {"parameterB":0.3}}'
+   dpx.CloseEntry()
+
+   # After scanning experiment data in 'STEP' mode we close the entry.
+   # To this end we call the CloseEntry method which also stores data defined
+   # with strategy=FINAL. Since our HDF5 file can contain many entries we can again
+   # open the entry and repeat our record procedure. If we define more than one entry
+   # in one XML setting string the defined entries are recorded parallel
+   # with the same steps.
+
+   # Finally, we can close our output file by
+
+   dpx.CloseFile()
+
+Additionally, one can use asynchronous versions of **OpenEntry**, **Record**, **CloseEntry**, i.e.
+**OpenEntryAsynch**, **RecordAsynch**, **CloseEntryAsynch**. In this case data is stored
+in a background thread and during this writing Tango Data Server has a state *RUNNING*.
+
+In order to build the XML configurations in the easy way the authors of the server provide
+for this purpose a specialized GUI tool, Component Designer.
+The attached to the server XML examples
+was created by XMLFile class defined in XMLCreator/simpleXML.py.

{nxswriter-3.10.0 → nxswriter-3.11.1}/nxswriter/Release.py

@@ -21,4 +21,4 @@
 
 
 #: package version
-__version__ = "3.10.0"
+__version__ = "3.11.1"

{nxswriter-3.10.0 → nxswriter-3.11.1}/nxswriter/TangoDataWriter.py

@@ -58,7 +58,14 @@ try:
     WRITERS["h5cpp"] = H5CppWriter
 except Exception:
     pass
-DEFAULTWRITERS = ["h5cpp", "h5py"]
+
+
+try:
+    from nxstools import h5rediswriter as H5RedisWriter
+    WRITERS["h5redis"] = H5RedisWriter
+except Exception:
+    pass
+DEFAULTWRITERS = ["h5cpp", "h5py", "h5redis"]
 
 
 #: (:obj:`bool`) tango bug #213 flag related to EncodedAttributes in python3
@@ -545,6 +552,9 @@ class TangoDataWriter(object):
                 self.__nextfile()
             elif "swmr" in self.__pars.keys() and self.__pars["swmr"]:
                 self.__nxFile.reopen(readonly=False, **self.__pars)
+        if self.__nxFile and hasattr(self.__nxFile, "prepare"):
+            # print("START")
+            self.__nxFile.prepare()
 
     def __nextfile(self):
         self.__nxFile.close()
@@ -625,6 +635,10 @@ class TangoDataWriter(object):
 
         if self.__nxFile and hasattr(self.__nxFile, "flush"):
             self.__nxFile.flush()
+        if self.__nxFile and hasattr(self.__nxFile, "start") and \
+           self.__datasources.counter == 1:
+            # print("START")
+            self.__nxFile.start()
         if self.stepsperfile > 0:
             if (self.__datasources.counter) % self.stepsperfile == 0:
                 self.__nextfile()
@@ -703,6 +717,8 @@ class TangoDataWriter(object):
 
         if self.__nxFile and hasattr(self.__nxFile, "flush"):
             self.__nxFile.flush()
+        if self.__nxFile and hasattr(self.__nxFile, "finish"):
+            self.__nxFile.finish()
 
         if NXSMETA and self.__nxRoot:
             args = {}

nxswriter-3.11.1/nxswriter.egg-info/PKG-INFO

@@ -0,0 +1,273 @@
+Metadata-Version: 2.1
+Name: nxswriter
+Version: 3.11.1
+Summary: Nexus Data writer implemented as a Tango Server
+Home-page: https://github.com/nexdatas/nxsdatawriter
+Author: Jan Kotanski, Eugen Wintersberger , Halil Pasic
+Author-email: jankotan@gmail.com, eugen.wintersberger@gmail.com, halil.pasic@gmail.com
+License: GNU GENERAL PUBLIC LICENSE v3
+Keywords: writer Tango server nexus data
+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 v3 (GPLv3)
+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
+
+Welcome to NXSDataWriter's documentation!
+=========================================
+
+|github workflow|
+|docs|
+|Pypi Version|
+|Python Versions|
+
+.. |github workflow| image:: https://github.com/nexdatas/nxsdatawriter/actions/workflows/tests.yml/badge.svg
+   :target: https://github.com/nexdatas/nxsdatawriter/actions
+   :alt:
+
+.. |docs| image:: https://img.shields.io/badge/Documentation-webpages-ADD8E6.svg
+   :target: https://nexdatas.github.io/nxsdatawriter/index.html
+   :alt:
+
+.. |Pypi Version| image:: https://img.shields.io/pypi/v/nxswriter.svg
+                  :target: https://pypi.python.org/pypi/nxswriter
+                  :alt:
+
+.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/nxswriter.svg
+                     :target: https://pypi.python.org/pypi/nxswriter/
+                     :alt:
+
+
+Authors: Jan Kotanski, Eugen Wintersberger, Halil Pasic
+
+------------
+Introduction
+------------
+
+NXSDataWriter is a Tango server which allows to store NeXuS Data in H5 files.
+
+The server provides storing data from other Tango devices,
+various databases as well as passed by a user client via JSON strings.
+
+Tango Server API: https://nexdatas.github.io/nxsdatawriter/doc_html
+
+| Source code: https://github.com/nexdatas/nxsdatawriter
+| Project Web page: https://nexdatas.github.io/nxsdatawriter
+| NexDaTaS Web page: https://nexdatas.github.io
+
+------------
+Installation
+------------
+
+Install the dependencies:
+
+|    pninexus or h5py, tango, numpy, nxstools, sphinx
+
+From sources
+""""""""""""
+
+Download the latest NexDaTaS version from
+
+|    https://github.com/nexdatas/nxsdatawriter
+
+Extract sources and run
+
+.. code-block:: console
+
+	  $ python setup.py install
+
+Debian packages
+"""""""""""""""
+
+Debian `bookworm`, `bullseye`, `buster`  or Ubuntu `lunar`, `jammy`, `focal`  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 tango server
+
+.. code-block:: console
+
+	  $ apt-get update
+	  $ apt-get install nxswriter
+
+or
+
+.. code-block:: console
+
+	  $ apt-get update
+	  $ apt-get install nxswriter3
+
+for older python3 releases.
+
+To install only the python3 package
+
+.. code-block:: console
+
+	  $ apt-get update
+	  $ apt-get install python3-nxswriter
+
+and for python2
+
+.. code-block:: console
+
+	  $ apt-get update
+	  $ apt-get install python-nxswriter
+
+if exists.
+
+
+
+From pip
+""""""""
+
+To install it from pip you can
+
+.. code-block:: console
+
+   $ python3 -m venv myvenv
+   $ . myvenv/bin/activate
+
+   $ pip install nxswriter
+
+Moreover it is also good to install
+
+.. code-block:: console
+
+   $ pip install pytango
+   $ pip install pymysqldb
+   $ pip install psycopg2-binary
+   $ pip install cx-oracle
+
+Setting NeXus Writer Server
+"""""""""""""""""""""""""""
+
+To set up  NeXus Writer Server run
+
+.. code-block:: console
+
+          $ nxsetup -x NXSDataWriter
+
+The *nxsetup* command comes from the **python-nxstools** package.
+
+-----------
+Client code
+-----------
+
+In order to use Nexus Data Server one has to write a client code. Some simple client codes
+are in the  nexdatas repository. In this section we add some
+comments related to the client code.
+
+.. code-block:: python
+
+   # To use the Tango Server we must import the tango module and
+   # create DeviceProxy for the server.
+
+   import tango
+
+   device = "p09/tdw/r228"
+   dpx = tango.DeviceProxy(device)
+   dpx.set_timeout_millis(10000)
+
+   dpx.Init()
+
+   # Here device corresponds to a name of our Nexus Data Server.
+   # The Init() method resets the state of the server.
+
+   dpx.FileName = "test.h5"
+   dpx.OpenFile()
+
+   # We set the name of the output HDF5 file and open it.
+
+   # Now we are ready to pass the XML settings describing a structure of
+   # the output file as well as defining a way of data storing.
+   # Examples of the XMLSettings can be found in the XMLExamples directory.
+
+   with open("test.xml", 'r') as fl:
+       xml = fl.read()
+   dpx.XMLSettings = xml
+
+   dpx.JSONRecord = '{"data": {"parameterA":0.2},
+			 "decoders":{"DESY2D":"desydecoders.desy2Ddec.desy2d"},
+			 "datasources":{
+		              "MCLIENT":"sources.DataSources.LocalClientSource"}
+   }'
+
+   dpx.OpenEntry()
+
+   # We read our XML settings settings from a file and pass them to the server via
+   # the XMLSettings attribute. Then we open an entry group related to the XML
+   # configuration. Optionally, we can also set JSONRecord, i.e. an attribute
+   # which contains a global JSON string with data needed to store during opening
+   # the entry and also other stages of recording. If external decoder for
+   # DevEncoded data is need one can registred it passing its packages and
+   # class names in JSONRecord,
+   # e.g. "desy2d" class of "DESY2D" label in "desydecoders.desy2Ddec" package.
+   # Similarly making use of "datasources" records of the JSON string one can
+   # registred additional datasources. The OpenEntry method stores data defined
+   # in the XML string with strategy=INIT.
+   # The JSONRecord attribute can be changed during recording our data.
+
+   # After finalization of the configuration process we can start recording
+   # the main experiment data in a STEP mode.
+
+   dpx.Record('{"data": {"p09/counter/exp.01":0.1, "p09/counter/exp.02":1.1}}')
+
+   # Every time we call the Record method all nexus fields defined with
+   # strategy=STEP are extended by one record unit and the assigned to them data
+   # is stored. As the method argument we pass a local JSON string with the client
+   # data. To record the client data one can also use the global JSONRecord string.
+   # Contrary to the global JSON string the local one is only
+   # valid during one record step.
+
+   dpx.Record('{"data": {"emittance_x": 0.1},  "triggers":["trigger1", "trigger2"]  }')
+
+   # If you denote in your XML configuration string some fields by additional
+   # trigger attributes you may ask the server to store your data only in specific
+   # record steps. This can be helpful if you want to store your data in
+   # asynchronous mode. To this end you define in the local JSON string a list of
+   # triggers which are used in the current record step.
+
+   dpx.JSONRecord = '{"data": {"parameterB":0.3}}'
+   dpx.CloseEntry()
+
+   # After scanning experiment data in 'STEP' mode we close the entry.
+   # To this end we call the CloseEntry method which also stores data defined
+   # with strategy=FINAL. Since our HDF5 file can contain many entries we can again
+   # open the entry and repeat our record procedure. If we define more than one entry
+   # in one XML setting string the defined entries are recorded parallel
+   # with the same steps.
+
+   # Finally, we can close our output file by
+
+   dpx.CloseFile()
+
+Additionally, one can use asynchronous versions of **OpenEntry**, **Record**, **CloseEntry**, i.e.
+**OpenEntryAsynch**, **RecordAsynch**, **CloseEntryAsynch**. In this case data is stored
+in a background thread and during this writing Tango Data Server has a state *RUNNING*.
+
+In order to build the XML configurations in the easy way the authors of the server provide
+for this purpose a specialized GUI tool, Component Designer.
+The attached to the server XML examples
+was created by XMLFile class defined in XMLCreator/simpleXML.py.