sardana-nxsrecorder 3.18.1__tar.gz → 3.20.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/.ci/install.sh +55 -26
  2. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/.github/workflows/tests.yml +1 -1
  3. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/ChangeLog +8 -0
  4. sardana-nxsrecorder-3.20.0/PKG-INFO +250 -0
  5. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/README.rst +3 -0
  6. sardana-nxsrecorder-3.20.0/sardana_nxsrecorder.egg-info/PKG-INFO +250 -0
  7. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/sardananxsrecorder/__init__.py +1 -1
  8. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/sardananxsrecorder/nxsrecorder.py +86 -10
  9. sardana-nxsrecorder-3.18.1/PKG-INFO +0 -248
  10. sardana-nxsrecorder-3.18.1/sardana_nxsrecorder.egg-info/PKG-INFO +0 -248
  11. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/.ci/debian10_py2/Dockerfile +0 -0
  12. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/.ci/debian10_py3/Dockerfile +0 -0
  13. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/.ci/debian8_py2/Dockerfile +0 -0
  14. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/.ci/debian8_py3/Dockerfile +0 -0
  15. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/.ci/debian9_py2/Dockerfile +0 -0
  16. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/.ci/debian9_py3/Dockerfile +0 -0
  17. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/.ci/run.sh +0 -0
  18. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/.ci/ubuntu16.04_py2/Dockerfile +0 -0
  19. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/.ci/ubuntu16.04_py3/Dockerfile +0 -0
  20. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/.ci/ubuntu18.04_py2/Dockerfile +0 -0
  21. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/.ci/ubuntu18.04_py3/Dockerfile +0 -0
  22. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/.ci/ubuntu20.04_py3/Dockerfile +0 -0
  23. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/.flake8 +0 -0
  24. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/.gitignore +0 -0
  25. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/COPYRIGHT +0 -0
  26. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/MANIFEST.in +0 -0
  27. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/doc/Makefile +0 -0
  28. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/doc/conf.py +0 -0
  29. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/doc/index.rst +0 -0
  30. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/doc/make.bat +0 -0
  31. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/doc/sardananxsrecorder.rst +0 -0
  32. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/man/sardananxsrecorder.1 +0 -0
  33. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/sardana_nxsrecorder.egg-info/SOURCES.txt +0 -0
  34. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/sardana_nxsrecorder.egg-info/dependency_links.txt +0 -0
  35. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/sardana_nxsrecorder.egg-info/not-zip-safe +0 -0
  36. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/sardana_nxsrecorder.egg-info/requires.txt +0 -0
  37. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/sardana_nxsrecorder.egg-info/top_level.txt +0 -0
  38. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/setup.cfg +0 -0
  39. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/setup.py +0 -0
  40. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/test/__init__.py +0 -0
  41. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/test/__main__.py +0 -0
  42. {sardana-nxsrecorder-3.18.1 → sardana-nxsrecorder-3.20.0}/test/main.py +0 -0
@@ -1,7 +1,7 @@
1
1
  #!/usr/bin/env bash
2
2
 
3
3
  # workaround for a bug in debian9, i.e. starting mysql hangs
4
- if [ "$1" = "debian11" ] || [ "$1" = "debian12" ]; then
4
+ if [ "$1" = "debian11" ] || [ "$1" = "debian12" ] || [ "$1" = "ubuntu24.04" ]; then
5
5
  docker exec --user root ndts service mariadb restart
6
6
  else
7
7
  docker exec --user root ndts service mysql stop
@@ -14,26 +14,40 @@ else
14
14
  # docker exec --user root ndts /bin/bash -c '$(service mysql start &) && sleep 30'
15
15
  fi
16
16
 
17
- docker exec --user root ndts /bin/bash -c 'export DEBIAN_FRONTEND=noninteractive; apt-get -qq update; apt-get -qq install -y xvfb libxcb1 libx11-xcb1 libxcb-keysyms1 libxcb-image0 libxcb-icccm4 libxcb-render-util0 xkb-data tango-db tango-common; sleep 10'
17
+ docker exec --user root ndts /bin/bash -c 'export DEBIAN_FRONTEND=noninteractive; apt-get -qq update; apt-get -qq install -y xvfb libxcb1 libx11-xcb1 libxcb-keysyms1 libxcb-image0 libxcb-icccm4 libxcb-render-util0 xkb-data tango-common; sleep 10'
18
18
  if [ "$?" -ne "0" ]; then exit 255; fi
19
-
20
- docker exec --user root ndts mkdir -p /tmp/runtime-tango
21
- docker exec --user root ndts chown -R tango:tango /tmp/runtime-tango
22
-
19
+ if [ "$1" = "ubuntu24.04" ]; then
20
+ # docker exec --user tango ndts /bin/bash -c '/usr/lib/tango/DataBaseds 2 -ORBendPoint giop:tcp::10000 &'
21
+ docker exec --user root ndts /bin/bash -c 'echo -e "[client]\nuser=root\npassword=rootpw" > /root/.my.cnf'
22
+ docker exec --user root ndts /bin/bash -c 'echo -e "[client]\nuser=tango\nhost=localhost\npassword=rootpw" > /var/lib/tango/.my.cnf'
23
+ docker exec --user root ndts /usr/bin/mysql -e 'GRANT ALL PRIVILEGES ON tango.* TO "tango"@"%" identified by "rootpw"'
24
+ docker exec --user root ndts /usr/bin/mysql -e 'GRANT ALL PRIVILEGES ON tango.* TO "tango"@"localhost" identified by "rootpw"'
25
+ docker exec --user root ndts /usr/bin/mysql -e 'FLUSH PRIVILEGES'
26
+ fi
23
27
  if [ "$1" = "ubuntu20.04" ] || [ "$1" = "ubuntu20.10" ] || [ "$1" = "ubuntu21.04" ] || [ "$1" = "ubuntu21.10" ] || [ "$1" = "ubuntu22.04" ]; then
24
28
  # docker exec --user tango ndts /bin/bash -c '/usr/lib/tango/DataBaseds 2 -ORBendPoint giop:tcp::10000 &'
25
29
  docker exec --user root ndts /bin/bash -c 'echo -e "[client]\nuser=root\npassword=rootpw" > /root/.my.cnf'
26
30
  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'
27
31
  fi
32
+ echo "install tango-db"
33
+ 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'
34
+ if [ "$?" -ne "0" ]; then exit 255; fi
35
+ if [ "$1" = "ubuntu24.04" ]; then
36
+ docker exec --user tango ndts /usr/bin/mysql -e 'create database tango'
37
+ docker exec --user tango ndts /bin/bash -c '/usr/bin/mysql tango < /usr/share/dbconfig-common/data/tango-db/install/mysql'
38
+ fi
39
+
28
40
  docker exec --user root ndts service tango-db restart
29
41
 
42
+ docker exec --user root ndts mkdir -p /tmp/runtime-tango
43
+ docker exec --user root ndts chown -R tango:tango /tmp/runtime-tango
44
+
30
45
 
31
46
  if [ "$?" -ne "0" ]; then exit 255; fi
32
47
  echo "start Xvfb :99 -screen 0 1024x768x24 &"
33
48
  docker exec --user root ndts /bin/bash -c 'export DISPLAY=":99.0"; Xvfb :99 -screen 0 1024x768x24 &'
34
49
  if [ "$?" -ne "0" ]; then exit 255; fi
35
50
 
36
-
37
51
  echo "install tango servers"
38
52
  docker exec --user root ndts /bin/bash -c 'export DEBIAN_FRONTEND=noninteractive; apt-get -qq update; apt-get -qq install -y tango-starter tango-test liblog4j1.2-java git'
39
53
  if [ "$?" -ne "0" ]; then exit 255; fi
@@ -43,7 +57,7 @@ docker exec --user root ndts service tango-starter restart
43
57
 
44
58
  if [[ "$2" = "2" ]]; then
45
59
  echo "install python-pytango"
46
- docker exec --user root ndts /bin/bash -c 'export DEBIAN_FRONTEND=noninteractive; apt-get -qq update; apt-get -qq install -y python-pytango python-h5py python-qtpy python-click git python-itango python-pint'
60
+ docker exec --user root ndts /bin/bash -c 'export DEBIAN_FRONTEND=noninteractive; apt-get -qq update; apt-get -qq install -y python-pytango python-h5py python-qtpy python-click git python-itango python-pint nxsconfigserver-db ; sleep 10'
47
61
  else
48
62
  echo "install python3-pytango"
49
63
  if [ "$1" = "debian9" ]; then
@@ -53,55 +67,70 @@ else
53
67
  docker exec --user root ndts /bin/bash -c 'cd itango-src; git checkout tags/v0.1.7 -b b0.1.7; python3 setup.py install'
54
68
  # docker exec --user root ndts /bin/bash -c 'cd taurus-src; git checkout; python3 setup.py install'
55
69
  fi
56
- if [ "$1" = "debian10" ] || [ "$1" = "ubuntu20.04" ] || [ "$1" = "ubuntu22.04" ] || [ "$1" = "ubuntu20.10" ] || [ "$1" = "debian11" ] || [ "$1" = "debian12" ] ; then
70
+ if [ "$1" = "debian10" ] || [ "$1" = "ubuntu20.04" ] || [ "$1" = "ubuntu22.04" ] || [ "$1" = "ubuntu24.04" ] || [ "$1" = "ubuntu20.10" ] || [ "$1" = "debian11" ] || [ "$1" = "debian12" ] ; then
57
71
  docker exec --user root ndts /bin/bash -c 'export DEBIAN_FRONTEND=noninteractive; apt-get -qq update; apt-get install -y git python3-six python3-numpy graphviz python3-sphinx g++ build-essential python3-dev pkg-config python3-all-dev python3-setuptools libtango-dev python3-setuptools python3-tango python3-tz; apt-get -qq install -y nxsconfigserver-db; sleep 10'
58
72
  else
59
73
  docker exec --user root ndts /bin/bash -c 'export DEBIAN_FRONTEND=noninteractive; apt-get -qq update; apt-get install -y git python3-six python3-numpy graphviz python3-sphinx g++ build-essential python3-dev pkg-config python3-all-dev python3-setuptools libtango-dev python3-setuptools python3-pytango python3-tz; apt-get -qq install -y nxsconfigserver-db; sleep 10'
60
74
  fi
61
75
  docker exec --user root ndts /bin/bash -c 'export DEBIAN_FRONTEND=noninteractive; apt-get -qq update; apt-get install -y libboost-python-dev libboost-dev python3-h5py python3-qtpy python3-click python3-setuptools python3-pint'
62
- if [ "$1" = "ubuntu20.04" ] || [ "$1" = "ubuntu20.10" ] || [ "$1" = "ubuntu21.04" ] || [ "$1" = "ubuntu22.04" ] || [ "$1" = "debian11" ] || [ "$1" = "debian12" ] || [ "$1" = "debian10" ]; then
76
+ if [ "$1" = "ubuntu20.04" ] || [ "$1" = "ubuntu20.10" ] || [ "$1" = "ubuntu21.04" ] || [ "$1" = "ubuntu22.04" ]|| [ "$1" = "ubuntu24.04" ] || [ "$1" = "debian11" ] || [ "$1" = "debian12" ] || [ "$1" = "debian10" ]; then
63
77
  echo " "
64
78
  else
65
79
  docker exec --user root ndts /bin/bash -c 'export DEBIAN_FRONTEND=noninteractive; apt-get -qq update; apt-get install -y libtango-dev python3-dev'
66
80
  docker exec --user root ndts /bin/bash -c 'git clone https://gitlab.com/tango-controls/pytango pytango; cd pytango; git checkout tags/v9.2.5 -b b9.2.5'
67
81
  docker exec --user root ndts /bin/bash -c 'cd pytango; python3 setup.py install'
68
82
  fi
83
+ if [ "$1" = "ubuntu24.04" ]; then
84
+ docker exec --user root ndts /usr/bin/mysql -e 'GRANT ALL PRIVILEGES ON nxsconfig.* TO "tango"@"%" identified by "rootpw"'
85
+ docker exec --user root ndts /usr/bin/mysql -e 'GRANT ALL PRIVILEGES ON nxsconfig.* TO "tango"@"localhost" identified by "rootpw"'
86
+ docker exec --user root ndts /usr/bin/mysql -e 'FLUSH PRIVILEGES'
87
+ docker exec --user tango ndts /usr/bin/mysql -e 'create database nxsconfig'
88
+ docker exec --user tango ndts /bin/bash -c '/usr/bin/mysql nxsconfig < /usr/share/dbconfig-common/data/nxsconfigserver-db/install/mysql'
89
+ fi
69
90
  fi
70
91
  if [ "$?" -ne "0" ]; then exit 255; fi
71
92
 
72
93
  echo "install qt5"
73
- if [ "$1" = "debian12" ] ||[ "$1" = "debian11" ] || [ "$1" = "ubuntu22.04" ]; then
94
+ if [ "$1" = "debian12" ] ||[ "$1" = "debian11" ] || [ "$1" = "ubuntu22.04" ] || [ "$1" = "ubuntu24.04" ]; then
74
95
  docker exec --user root ndts /bin/bash -c 'export DEBIAN_FRONTEND=noninteractive; apt-get -qq update; apt-get -qq install -y qtbase5-dev-tools'
75
96
  else
76
97
  docker exec --user root ndts /bin/bash -c 'export DEBIAN_FRONTEND=noninteractive; apt-get -qq update; apt-get -qq install -y qtbase5-dev-tools qt5-default'
77
98
  fi
78
99
 
100
+
79
101
  if [ "$?" -ne "0" ]; then exit 255; fi
80
102
 
103
+
104
+ if [ "$2" = "2" ]; then
105
+ echo "install pytango and nxsconfigserver-db"
106
+ docker exec --user root ndts /bin/bash -c 'apt-get -qq update; apt-get install -y python-pytango nxsconfigserver-db ; sleep 10'
107
+ else
108
+ if [ "$1" = "debian10" ] || [ "$1" = "ubuntu24.04" ] || [ "$1" = "ubuntu22.04" ] || [ "$1" = "ubuntu20.04" ] || [ "$1" = "ubuntu20.10" ] || [ "$1" = "debian11" ] || [ "$1" = "debian12" ] ; then
109
+ echo "install pytango"
110
+ docker exec --user root ndts /bin/bash -c 'apt-get -qq update; apt-get install -y python3-tango'
111
+ echo "install nxsconfigserver-db"
112
+ docker exec --user root ndts /bin/bash -c 'apt-get -qq update; apt-get install -y nxsconfigserver-db'
113
+ else
114
+ echo "install pytango and nxsconfigserver-db"
115
+ docker exec --user root ndts /bin/bash -c 'apt-get -qq update; apt-get -qq install -y python3-pytango nxsconfigserver-db; sleep 10'
116
+ fi
117
+ fi
118
+ if [ "$?" != "0" ]; then exit 255; fi
119
+
120
+
81
121
  if [[ "$2" == "2" ]]; then
82
122
  echo "install sardana, taurus and nexdatas"
83
123
  docker exec --user root ndts /bin/bash -c 'export DEBIAN_FRONTEND=noninteractive; apt-get -qq update; apt-get -qq install -y nxsconfigserver-db; sleep 10; apt-get -qq install -y python-nxsconfigserver python-nxswriter python-nxstools python-nxsrecselector python-setuptools'
84
124
  if [[ "$1" == "debian10" ]]; then
85
125
  docker exec --user root ndts /bin/bash -c 'export DEBIAN_FRONTEND=noninteractive; apt-get -qq update; apt-get -qq install -y python-taurus python-sardana'
86
- else
87
- if [[ "$1" == "debian9" ]]; then
88
- docker exec --user root ndts /bin/bash -c 'git clone https://github.com/hgrecco/pint pint-src'
89
- docker exec --user root ndts /bin/bash -c 'cd pint-src; git checkout tags/0.9 -b b0.9; python setup.py install'
90
- fi
91
- docker exec --user root ndts /bin/bash -c 'git clone https://gitlab.com/taurus-org/taurus taurus-src; cd taurus-src'
92
- docker exec --user root ndts /bin/bash -c 'cd taurus-src; git checkout tags/4.6.1 -b b4.6.1; python setup.py install'
93
- docker exec --user root ndts /bin/bash -c 'git clone https://github.com/sardana-org/sardana sardana-src; cd sardana-src'
94
- docker exec --user root ndts /bin/bash -c 'cd sardana-src; git checkout tags/2.8.4 -b b2.8.4; python setup.py install'
95
126
  fi
96
127
  else
97
128
  echo "install sardana, taurus and nexdatas"
98
- docker exec --user root ndts /bin/bash -c 'export DEBIAN_FRONTEND=noninteractive; apt-get -qq update; apt-get install -y nxsconfigserver-db; sleep 10; apt-get -qq install -y python3-nxsconfigserver python3-nxswriter python3-nxstools python3-nxsrecselector python3-setuptools nxsrecselector3 nxswriter3 nxsconfigserver3 nxstools3 python3-packaging'
99
- if [ "$1" == "ubuntu18.04" ] ; then
100
- docker exec --user root ndts /bin/bash -c 'git clone https://gitlab.com/taurus-org/taurus taurus-src; cd taurus-src'
101
- docker exec --user root ndts /bin/bash -c 'cd taurus-src; git checkout tags/4.7.0 -b b4.7.0; python3 setup.py install'
102
- docker exec --user root ndts /bin/bash -c 'git clone https://github.com/sardana-org/sardana sardana-src; cd sardana-src'
103
- docker exec --user root ndts /bin/bash -c 'cd sardana-src; git checkout tags/3.1.0 -b b3.1.0; python3 setup.py install'
129
+ if [[ "$1" == "debian10" ]]; then
130
+ docker exec --user root ndts /bin/bash -c 'export DEBIAN_FRONTEND=noninteractive; apt-get -qq update; apt-get -qq install -y python3-nxsconfigserver python3-nxswriter python3-nxstools python3-nxsrecselector python3-setuptools nxsrecselector3 nxswriter3 nxsconfigserver3 nxstools3 python3-packaging'
131
+ docker exec --user root ndts /bin/bash -c 'export DEBIAN_FRONTEND=noninteractive; apt-get -qq update; apt-get -qq install -y python3-taurus python3-sardana'
104
132
  else
133
+ docker exec --user root ndts /bin/bash -c 'export DEBIAN_FRONTEND=noninteractive; apt-get -qq update; apt-get -qq install -y python3-nxsconfigserver python3-nxswriter python3-nxstools python3-nxsrecselector python3-setuptools nxsrecselector nxswriter nxsconfigserver nxstools python3-packaging'
105
134
  docker exec --user root ndts /bin/bash -c 'export DEBIAN_FRONTEND=noninteractive; apt-get -qq update; apt-get -qq install -y python3-taurus python3-sardana'
106
135
  fi
107
136
  fi
@@ -24,7 +24,7 @@ jobs:
24
24
  runs-on: ubuntu-latest
25
25
  strategy:
26
26
  matrix:
27
- os: [debian12, debian11, debian10, ubuntu22.04, ubuntu20.04]
27
+ os: [debian12, debian11, debian10, ubuntu24.04, ubuntu22.04, ubuntu20.04]
28
28
  steps:
29
29
  - uses: actions/checkout@v2
30
30
  - uses: actions/setup-python@v2
@@ -1,3 +1,11 @@
1
+ 2024-05-22 Jan Kotanski <jankotan@gmail.com>
2
+ * add support for creating measurement files (#105)
3
+ * tagged as 3.20.0
4
+
5
+ 2024-05-13 Jan Kotanski <jankotan@gmail.com>
6
+ * send count_time beamtime_id and npoints to writer (#103)
7
+ * tagged as 3.19.0
8
+
1
9
  2023-12-15 Jan Kotanski <jankotan@gmail.com>
2
10
  * fix convention for entry names in multi-scan NeXus files (#96)
3
11
  * tagged as 3.18.1
@@ -0,0 +1,250 @@
1
+ Metadata-Version: 2.1
2
+ Name: sardana-nxsrecorder
3
+ Version: 3.20.0
4
+ Summary: NeXus Sardana Scan Recorder
5
+ Home-page: https://github.com/nexdatas/sardana-nxs-filerecorder/
6
+ Author: Jan Kotanski
7
+ Author-email: jankotan@gmail.com
8
+ License: GNU GENERAL PUBLIC LICENSE v3
9
+ Keywords: NeXus sardana scan recorder data
10
+ Classifier: Development Status :: 5 - Production/Stable
11
+ Classifier: Intended Audience :: Science/Research
12
+ Classifier: Topic :: Scientific/Engineering :: Physics
13
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
14
+ Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
15
+ Classifier: Programming Language :: Python :: 2.7
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.4
18
+ Classifier: Programming Language :: Python :: 3.5
19
+ Classifier: Programming Language :: Python :: 3.6
20
+ Classifier: Programming Language :: Python :: 3.7
21
+ Classifier: Programming Language :: Python :: 3.8
22
+ Classifier: Programming Language :: Python :: 3.9
23
+ Classifier: Programming Language :: Python :: 3.10
24
+ Classifier: Programming Language :: Python :: 3.11
25
+
26
+ Welcome to sardananxsrecorder's documentation!
27
+ ==============================================
28
+ |github workflow|
29
+ |docs|
30
+ |Pypi Version|
31
+ |Python Versions|
32
+
33
+ .. |github workflow| image:: https://github.com/nexdatas/sardana-nxs-filerecorder/actions/workflows/tests.yml/badge.svg
34
+ :target: https://github.com/nexdatas/sardana-nxs-filerecorder/actions
35
+ :alt:
36
+
37
+ .. |docs| image:: https://img.shields.io/badge/Documentation-webpages-ADD8E6.svg
38
+ :target: https://nexdatas.github.io/sardana-nxs-filerecorder/index.html
39
+ :alt:
40
+
41
+ .. |Pypi Version| image:: https://img.shields.io/pypi/v/sardana-nxsrecorder.svg
42
+ :target: https://pypi.python.org/pypi/sardana-nxsrecorder
43
+ :alt:
44
+
45
+ .. |Python Versions| image:: https://img.shields.io/pypi/pyversions/sardana-nxsrecorder.svg
46
+ :target: https://pypi.python.org/pypi/sardana-nxsrecorder/
47
+ :alt:
48
+
49
+
50
+ NeXus scan recorder for Sardana which stores experimenal data in NeXus/HDF5 file with use of
51
+ NeXDatas Tango Server or packages, i.e. NXSDataWriter, NXSConfigServer, NXSRecSelector.
52
+
53
+ | Source code: https://github.com/nexdatas/sardana-nxs-filerecorder
54
+ | Web page: https://nexdatas.github.io/sardana-nxs-filerecorder
55
+ | NexDaTaS Web page: https://nexdatas.github.io
56
+
57
+
58
+ ------------
59
+ Installation
60
+ ------------
61
+
62
+ Install the dependencies:
63
+
64
+ | sardana, sphinx, NXSDataWriter, NXSConfigServer, NXSRecSelector
65
+
66
+ From sources
67
+ """"""""""""
68
+
69
+ Download the latest NeXuS Scan Recorder version from
70
+
71
+ | https://github.com/nexdatas/sardana-nxs-filerecorder
72
+
73
+ Extract sources and run
74
+
75
+ .. code-block:: console
76
+
77
+ $ python setup.py install
78
+
79
+ and add an *RecorderPath* property of *MacroServer* with its value
80
+ defining the package location, e.g.
81
+
82
+ | /usr/lib/python2.7/dist-packages/sardananxsrecorder
83
+
84
+
85
+ Debian packages
86
+ """""""""""""""
87
+
88
+ Debian Bookworm, Bullseye, Buster and Ubuntu Lunar, Jammy and Focal packages can be found in the HDRI repository.
89
+
90
+ To install the debian packages, add the PGP repository key
91
+
92
+ .. code-block:: console
93
+
94
+ $ sudo su
95
+ $ wget -q -O - http://repos.pni-hdri.de/debian_repo.pub.gpg | apt-key add -
96
+
97
+ and then download the corresponding source list
98
+
99
+ .. code-block:: console
100
+
101
+ $ cd /etc/apt/sources.list.d
102
+ $ wget http://repos.pni-hdri.de/bookworm-pni-hdri.list
103
+
104
+
105
+ Finally, for python2.7
106
+
107
+ .. code-block:: console
108
+
109
+ $ apt-get update
110
+ $ apt-get install python-sardana-nxsrecorder
111
+
112
+ and set the RecoderPath property of MacroServer with
113
+
114
+ .. code-block:: console
115
+
116
+ $ apt-get install sardana-nxsrecorder
117
+
118
+ For python3
119
+
120
+ .. code-block:: console
121
+
122
+ $ apt-get update
123
+ $ apt-get install python3-sardana-nxsrecorder
124
+ $ apt-get install sardana-nxsrecorder3
125
+
126
+ To instal other NexDaTaS packages
127
+
128
+ .. code-block:: console
129
+
130
+ $ apt-get install python-nxswriter nxsconfigserver-db python-nxsconfigserver nxsconfigtool python-nxstools nxswriter nxsconfigserver nxsrecselector
131
+
132
+ or for python 3
133
+
134
+ .. code-block:: console
135
+
136
+ $ apt-get install python3-nxswriter nxsconfigserver-db python3-nxsconfigserver nxsconfigtool3 python3-nxstools nxswriter3 nxsconfigserver3
137
+
138
+ and
139
+
140
+ .. code-block:: console
141
+
142
+ $ apt-get install python-nxsrecselector nxsrecselector nxselector
143
+
144
+ or for python3
145
+
146
+ .. code-block:: console
147
+
148
+ $ apt-get install python3-nxsrecselector nxsrecselector3 nxselector3
149
+
150
+ for Component Selector for Sardana related packages.
151
+
152
+ -------------------
153
+ Setting environment
154
+ -------------------
155
+
156
+ Setting Saradna
157
+ """""""""""""""
158
+
159
+ If sardana is not yet set up run
160
+
161
+
162
+ .. code-block:: console
163
+
164
+ $ Pool
165
+
166
+ - enter a new instance name
167
+ - create the new instance
168
+
169
+ Then wait a while until Pool is started and in a new terminal run
170
+
171
+ .. code-block:: console
172
+
173
+ $ MacroServer
174
+
175
+ - enter a new instance name
176
+ - create the new instance
177
+ - connect pool
178
+
179
+ Next, run Astor and change start-up levels: for Pool to 2,
180
+ for MacroServer to 3 and restart servers.
181
+
182
+ Alternatively, terminate Pool and MacroServer in the terminals and run
183
+
184
+ .. code-block:: console
185
+
186
+ $ nxsetup start Pool -l2
187
+
188
+ wait until Pool is started and run
189
+
190
+ .. code-block:: console
191
+
192
+ $ nxsetup start MacroServer -l3
193
+
194
+
195
+ Additionally, one can create dummy devices by running `sar_demo` in
196
+
197
+ .. code-block:: console
198
+
199
+ $ spock
200
+
201
+
202
+ Setting NeXus Servers
203
+ """""""""""""""""""""
204
+
205
+ To set up NeXus Servers run
206
+
207
+ .. code-block:: console
208
+
209
+ $ nxsetup set
210
+
211
+ or
212
+
213
+ .. code-block:: console
214
+
215
+ $ nxsetup set NXSDataWriter
216
+ $ nxsetup set NXSConfigServer
217
+ $ nxsetup set NXSRecSelector
218
+
219
+ for specific servers.
220
+
221
+ If the `RecoderPath` property of MacroServer is not set one can do it by
222
+
223
+ .. code-block:: console
224
+
225
+ $ nxsetup add-recorder-path /usr/lib/python2.7/dist-packages/sardananxsrecorder
226
+
227
+ where the path should point the `sardananxsrecorder` package.
228
+
229
+ -----------------
230
+ Sardana Variables
231
+ -----------------
232
+
233
+ The NeXus file recorder uses the following sardana environment variables
234
+
235
+ * **ActiveMntGrp** *(str)* - active measurement group
236
+ * **ScanID** *(int)* - the last scan identifier number, default: ``-1``
237
+ * **NeXusSelectorDevice** *(str)* - NXSRecSelector tango device if more installed, otherwise first one found
238
+
239
+ * **NXSAppendSciCatDataset** *(bool)* - append scan name to scicat dataset list file, default: ``False``
240
+ * **BeamtimeFilePath** *(str)* - beamtime file path to search beamtime metadata file, default: ``"/gpfs/current"``
241
+ * **BeamtimeFilePrefix** *(str)* - beamtime metadata file prefix, default: ``"beamtime-metadata-"``
242
+ * **BeamtimeFileExt** *(str)* - beamtime metadata file extension, default: ``".json"``
243
+ * **SciCatDatasetListFilePrefix** *(str)* - scicat dataset list file prefix, default: ``"scicat-datasets-"``
244
+ * **SciCatDatasetListFileExt** *(str)* - scicat dataset list file extension, default: ``".lst"``
245
+ * **SciCatDatasetListFileLocal** *(bool)* - add the hostname to the scicat dataset list file extension, default: ``False``
246
+ * **SciCatAutoGrouping** *(bool)* - group all scans with the measurement name set to the base scan filename, default: ``False``
247
+ * **MetadataScript** *(str)* - a python module file name containing ``main()`` which provides a dictionary with user metadata stored in the INIT mode, default: ``""``
248
+ * **ScicatMeasurements** *(dict)* - a dictionary of measurement names indexed by ``ScanDir`` and used by ``scingestor``, default: ``{}``
249
+ * **CreateMeasurementFile** *(bool)* - create a measurement file with its filename releated to ``ScicatMeasurements`` or ``ScanFile``, default: ``False``
250
+
@@ -220,3 +220,6 @@ The NeXus file recorder uses the following sardana environment variables
220
220
  * **SciCatDatasetListFileLocal** *(bool)* - add the hostname to the scicat dataset list file extension, default: ``False``
221
221
  * **SciCatAutoGrouping** *(bool)* - group all scans with the measurement name set to the base scan filename, default: ``False``
222
222
  * **MetadataScript** *(str)* - a python module file name containing ``main()`` which provides a dictionary with user metadata stored in the INIT mode, default: ``""``
223
+ * **ScicatMeasurements** *(dict)* - a dictionary of measurement names indexed by ``ScanDir`` and used by ``scingestor``, default: ``{}``
224
+ * **CreateMeasurementFile** *(bool)* - create a measurement file with its filename releated to ``ScicatMeasurements`` or ``ScanFile``, default: ``False``
225
+