diff --git a/.buildinfo b/.buildinfo index cd842fe7..8c284cd5 100644 --- a/.buildinfo +++ b/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 9dc2501bce5111257bf46e662605b035 +config: 62ad23e41a380c15862957808191a760 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/_modules/index.html b/_modules/index.html index de802274..cf8f1bb2 100644 --- a/_modules/index.html +++ b/_modules/index.html @@ -4,7 +4,7 @@
-
return h5writer.unlimited(parent)
:type readonly: :obj:`bool`
:param redisurl: redis URL
:type redisurl: :obj:`str`
+ :param session: redis session
+ :type session: :obj:`str`
:param libver: library version: 'lastest' or 'earliest'
:type libver: :obj:`str`
:returns: file object
:rtype: :class:`H5RedisFile`
"""
return H5RedisFile(h5imp=h5writer.open_file(filename, readonly, **pars),
- redisurl=redisurl)
h5imp=h5writer.load_file(membuffer, filename, readonly, **pars))
:type libver: :obj:`str`
:param redisurl: redis URL
:type redisurl: :obj:`str`
+ :param session: redis session
+ :type session: :obj:`str`
:returns: file object
:rtype: :class:`H5RedisFile`
"""
return H5RedisFile(
h5imp=h5writer.create_file(filename, overwrite, **pars),
- redisurl=redisurl)
"""
def __init__(self, h5object=None, filename=None, h5imp=None,
- redisurl=None):
+ redisurl=None, session=None):
""" constructor
:param h5object: h5 object
@@ -578,6 +584,8 @@ Source code for nxstools.h5rediswriter
:type h5imp: :class:`filewriter.FTFile`
:param redisurl: redis url string
:type redisurl: :obj:`str`
+ :param session: redis session
+ :type session: :obj:`str`
"""
if h5imp is not None:
H5File.__init__(self, h5imp.h5object, h5imp.name)
@@ -587,6 +595,7 @@ Source code for nxstools.h5rediswriter
H5File.__init__(self, h5object, filename)
#: (:obj:`str`) redis url
self.__redisurl = redisurl or "redis://localhost:6380"
+ self.__session = session or "test_session"
self.__datastore = None
self.__scan = None
self.__scan_lock = threading.Lock()
@@ -776,7 +785,7 @@ Source code for nxstools.h5rediswriter
scinfo = {
"name": fbase,
"scan_nb": number,
- "session_name": 'test_session',
+ "session_name": self.__session,
"data_policy": 'no_policy',
"user_name": getpass.getuser(),
"start_time":
@@ -1004,7 +1013,7 @@ Source code for nxstools.h5rediswriter
"number": sinfo["scan_nb"],
"dataset": fbase,
"path": dr,
- "session": "test_session",
+ "session": self.__session,
"collection": measurement,
"data_policy": "no_policy"}
if "beamtime_id" in sinfo:
@@ -1027,7 +1036,7 @@ Source code for nxstools.h5rediswriter
if 'proposal' not in scandct or not scandct["proposal"]:
if "experiment_identifier" in entry.names():
proposal = filewriter.first(
- self.open("experiment_identifier").read())
+ entry.open("experiment_identifier").read())
if proposal:
scandct["proposal"] = proposal
diff --git a/_static/documentation_options.js b/_static/documentation_options.js
index ed936747..9c9eafc2 100644
--- a/_static/documentation_options.js
+++ b/_static/documentation_options.js
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
- VERSION: '4.17.0',
+ VERSION: '4.18.0',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
diff --git a/genindex.html b/genindex.html
index c84f3106..585f4fb7 100644
--- a/genindex.html
+++ b/genindex.html
@@ -4,7 +4,7 @@
- Index — NXSTools 4.17.0 documentation
+ Index — NXSTools 4.18.0 documentation
@@ -37,7 +37,7 @@
NXSTools
- 4.17
+ 4.18
diff --git a/index.html b/index.html
index 354afeb0..bd284667 100644
--- a/index.html
+++ b/index.html
@@ -5,7 +5,7 @@
- Welcome to nxstools's documentation! — NXSTools 4.17.0 documentation
+ Welcome to nxstools's documentation! — NXSTools 4.18.0 documentation
@@ -39,7 +39,7 @@
NXSTools
- 4.17
+ 4.18
@@ -243,13 +243,13 @@ From sourceshttps://github.com/nexdatas/nxstools
Extract sources and run
-$ python setup.py install
+$ python3 setup.py install
Debian packages¶
-Debian bookworm, bullseye, buster or Ubuntu lunar, jammy, focal packages can be found in the HDRI repository.
+Debian bookworm, bullseye, buster or Ubuntu oracluar, 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
diff --git a/nxscollect.html b/nxscollect.html
index 885a918d..2382c651 100644
--- a/nxscollect.html
+++ b/nxscollect.html
@@ -5,7 +5,7 @@
- nxcollect — NXSTools 4.17.0 documentation
+ nxcollect — NXSTools 4.18.0 documentation
@@ -40,7 +40,7 @@
NXSTools
- 4.17
+ 4.18
diff --git a/nxsconfig.html b/nxsconfig.html
index db21fe26..32e2b164 100644
--- a/nxsconfig.html
+++ b/nxsconfig.html
@@ -5,7 +5,7 @@
- nxsconfig — NXSTools 4.17.0 documentation
+ nxsconfig — NXSTools 4.18.0 documentation
@@ -40,7 +40,7 @@
NXSTools
- 4.17
+ 4.18
diff --git a/nxscreate.html b/nxscreate.html
index a333676c..2f494cf5 100644
--- a/nxscreate.html
+++ b/nxscreate.html
@@ -5,7 +5,7 @@
- nxscreate — NXSTools 4.17.0 documentation
+ nxscreate — NXSTools 4.18.0 documentation
@@ -40,7 +40,7 @@
NXSTools
- 4.17
+ 4.18
diff --git a/nxsdata.html b/nxsdata.html
index 2e937b51..a029cacb 100644
--- a/nxsdata.html
+++ b/nxsdata.html
@@ -5,7 +5,7 @@
- nxsdata — NXSTools 4.17.0 documentation
+ nxsdata — NXSTools 4.18.0 documentation
@@ -40,7 +40,7 @@
NXSTools
- 4.17
+ 4.18
diff --git a/nxsetup.html b/nxsetup.html
index b7695cee..65168a8e 100644
--- a/nxsetup.html
+++ b/nxsetup.html
@@ -5,7 +5,7 @@
- nxsetup — NXSTools 4.17.0 documentation
+ nxsetup — NXSTools 4.18.0 documentation
@@ -40,7 +40,7 @@
NXSTools
- 4.17
+ 4.18
diff --git a/nxsfileinfo.html b/nxsfileinfo.html
index edbbe4f0..bc21ac59 100644
--- a/nxsfileinfo.html
+++ b/nxsfileinfo.html
@@ -5,7 +5,7 @@
- nxsfileinfo — NXSTools 4.17.0 documentation
+ nxsfileinfo — NXSTools 4.18.0 documentation
@@ -40,7 +40,7 @@
NXSTools
- 4.17
+ 4.18
diff --git a/nxstools.html b/nxstools.html
index ce566403..a8bcee95 100644
--- a/nxstools.html
+++ b/nxstools.html
@@ -5,7 +5,7 @@
- nxstools package — NXSTools 4.17.0 documentation
+ nxstools package — NXSTools 4.18.0 documentation
@@ -39,7 +39,7 @@
NXSTools
- 4.17
+ 4.18
@@ -1509,9 +1509,9 @@ Submodules
Parameters:
@@ -1534,7 +1534,7 @@ Submodules
Parameters:
-file_template (str
) -- file template
+file_template (str
) – file template
Returns:
filename generator object
@@ -1566,8 +1566,8 @@ Submodules
Parameters:
@@ -1625,7 +1625,7 @@ Submodules
Parameters:
-o (any
) -- python object
+o (any
) – python object
@@ -1641,8 +1641,8 @@ Submodules
Parameters:
@@ -1653,10 +1653,10 @@ Submodules
Parameters:
Returns:
@@ -1699,8 +1699,8 @@ Submodules
Parameters:
@@ -1804,8 +1804,8 @@ Submodules
Parameters:
@@ -1820,8 +1820,8 @@ Submodules
Parameters:
@@ -1860,8 +1860,8 @@ Submodules
Parameters:
@@ -1935,7 +1935,7 @@ Submodules
Parameters:
-o (any
) -- h5 object
+o (any
) – h5 object
@@ -1951,10 +1951,10 @@ Submodules
Parameters:
@@ -2033,9 +2033,9 @@ Submodules
Parameters:
@@ -2066,8 +2066,8 @@ Submodules
Parameters:
@@ -2092,11 +2092,11 @@ Submodules
Parameters:
Returns:
@@ -2115,8 +2115,8 @@ Submodules
Parameters:
Returns:
@@ -2135,9 +2135,9 @@ Submodules
Parameters:
@@ -2150,8 +2150,8 @@ Submodules
Parameters:
Returns:
@@ -2169,7 +2169,7 @@ Submodules
Parameters:
-name (str
) -- child name
+name (str
) – child name
Returns:
existing flag
@@ -2200,7 +2200,7 @@ Submodules
Parameters:
-name (str
) -- element name
+name (str
) – element name
Returns:
file tree object
@@ -2217,7 +2217,7 @@ Submodules
Parameters:
-name (str
) -- element name
+name (str
) – element name
Returns:
file tree object
@@ -2265,10 +2265,10 @@ Submodules
Parameters:
-
-
-
-
+
+
+
+
@@ -2283,8 +2283,8 @@ Submodules
Parameters:
@@ -2333,8 +2333,8 @@ Submodules
Parameters:
@@ -2344,7 +2344,7 @@ Submodules
Parameters:
-tparent (FTObject
) -- tree parent
+tparent (FTObject
) – tree parent
@@ -2413,7 +2413,7 @@ Submodules
Parameters:
-h5object (any
) -- h5 object
+h5object (any
) – h5 object
@@ -2426,7 +2426,7 @@ Submodules
Parameters:
-h5object (any
) -- h5 object
+h5object (any
) – h5 object
@@ -2436,9 +2436,9 @@ Submodules
- Parameters:
-key (tuple
) -- slide or selection
-source (FTTargetFieldView
) -- target field
-sourcekey (tuple
) -- slide or selection
+key (tuple
) – slide or selection
+source (FTTargetFieldView
) – target field
+sourcekey (tuple
) – slide or selection
@@ -2453,9 +2453,9 @@ Submodules
Parameters:
Returns:
@@ -2473,7 +2473,7 @@ Submodules
Parameters:
-parent (FTObject
) -- parent object
+parent (FTObject
) – parent object
Returns:
deflate filter object
@@ -2490,7 +2490,7 @@ Submodules
Parameters:
-parent (FTObject
) -- parent object
+parent (FTObject
) – parent object
Returns:
deflate filter object
@@ -2507,7 +2507,7 @@ Submodules
Parameters:
-array (any
) -- numpy array
+array (any
) – numpy array
Returns:
first element of the array
@@ -2521,7 +2521,7 @@ Submodules
Parameters:
-parent (FTObject
) -- parent object
+parent (FTObject
) – parent object
Returns:
list of link objects
@@ -2544,9 +2544,9 @@ Submodules
Parameters:
Returns:
@@ -2565,10 +2565,10 @@ Submodules
Parameters:
Returns:
@@ -2587,9 +2587,9 @@ Submodules
Parameters:
Returns:
@@ -2607,7 +2607,7 @@ Submodules
Parameters:
-wr (PNIWriter
or H5PYWriter
or H5CppWriter
) -- writer module
+wr (PNIWriter
or H5PYWriter
or H5CppWriter
) – writer module
@@ -2619,12 +2619,12 @@ Submodules
Parameters:
Returns:
@@ -2642,7 +2642,7 @@ Submodules
Parameters:
-parent (FTObject
) -- parent object
+parent (FTObject
) – parent object
Returns:
dataspace UNLIMITED variable
@@ -2660,10 +2660,10 @@ Submodules
Parameters:
Returns:
@@ -2694,8 +2694,8 @@ Submodules
Parameters:
@@ -2785,7 +2785,7 @@ Submodules
Parameters:
-o (any
) -- python object
+o (any
) – python object
@@ -2801,8 +2801,8 @@ Submodules
Parameters:
@@ -2819,10 +2819,10 @@ Submodules
Parameters:
Returns:
@@ -2891,8 +2891,8 @@ Submodules
Parameters:
@@ -2907,8 +2907,8 @@ Submodules
Parameters:
@@ -2923,8 +2923,8 @@ Submodules
Parameters:
@@ -2969,8 +2969,8 @@ Submodules
Parameters:
@@ -3070,7 +3070,7 @@ Submodules
Parameters:
-o (any
) -- h5 object
+o (any
) – h5 object
@@ -3086,8 +3086,8 @@ Submodules
Parameters:
@@ -3150,9 +3150,9 @@ Submodules
Parameters:
@@ -3183,8 +3183,8 @@ Submodules
Parameters:
@@ -3195,7 +3195,7 @@ Submodules
Parameters:
-group -- group object
+group – group object
@@ -3241,11 +3241,11 @@ Submodules
- Parameters:
-n (str
) -- group name
-type_code (str
) -- nexus field type
-
-
-dfilter (H5CppDataFilter
) -- filter deflater
+n (str
) – group name
+type_code (str
) – nexus field type
+
+
+dfilter (H5CppDataFilter
) – filter deflater
- Returns:
@@ -3264,8 +3264,8 @@ Submodules
- Parameters:
-
- Returns:
@@ -3284,9 +3284,9 @@ Submodules
- Parameters:
-
@@ -3298,7 +3298,7 @@ Submodules
Parameters:
-name (str
) -- child name
+name (str
) – child name
Returns:
existing flag
@@ -3349,7 +3349,7 @@ Submodules
Parameters:
-name (str
) -- element name
+name (str
) – element name
Returns:
file tree object
@@ -3366,7 +3366,7 @@ Submodules
Parameters:
-name (str
) -- element name
+name (str
) – element name
Returns:
file tree object
@@ -3414,8 +3414,8 @@ Submodules
Parameters:
@@ -3431,7 +3431,7 @@ Submodules
Parameters:
-obj (FTObject
) -- h5 node
+obj (FTObject
) – h5 node
Returns:
file name
@@ -3513,11 +3513,11 @@ Submodules
Parameters:
@@ -3556,10 +3556,10 @@ Submodules
Parameters:
@@ -3570,10 +3570,10 @@ Submodules
Parameters:
-key (tuple
) -- slide
-source (H5PYTargetFieldView
) -- target field view
-sourcekey (tuple
) -- slide or selection
-shape (tuple
) -- target shape in the layout
+key (tuple
) – slide
+source (H5PYTargetFieldView
) – target field view
+sourcekey (tuple
) – slide or selection
+shape (tuple
) – target shape in the layout
@@ -3600,9 +3600,9 @@ Submodules
Parameters:
Returns:
@@ -3621,12 +3621,12 @@ Submodules
Parameters:
-filterid (int
) -- hdf5 filter id
-name (str
) -- filter name
-
-availability (str
) -- filter availability i.e. 'optional' or 'mandatory'
-shuffle (bool
) -- filter shuffle
-rate (bool
) -- filter shuffle
+filterid (int
) – hdf5 filter id
+name (str
) – filter name
+
+availability (str
) – filter availability i.e. ‘optional’ or ‘mandatory’
+shuffle (bool
) – filter shuffle
+rate (bool
) – filter shuffle
Returns:
@@ -3645,8 +3645,8 @@ Submodules
Parameters:
Returns:
@@ -3664,7 +3664,7 @@ Submodules
Parameters:
-parent (FTObject
) -- parent object
+parent (FTObject
) – parent object
Returns:
list of link objects
@@ -3732,9 +3732,9 @@ Submodules
Parameters:
Returns:
@@ -3753,10 +3753,10 @@ Submodules
Parameters:
Returns:
@@ -3774,7 +3774,7 @@ Submodules
Parameters:
-dtype (str
) -- h5 writer type type
+dtype (str
) – h5 writer type type
Returns:
nupy type
@@ -3792,9 +3792,9 @@ Submodules
Parameters:
Returns:
@@ -3813,11 +3813,11 @@ Submodules
Parameters:
Returns:
@@ -3835,7 +3835,7 @@ Submodules
Parameters:
-parent (FTObject
) -- parent object
+parent (FTObject
) – parent object
Returns:
dataspace UNLIMITED variable
@@ -3853,8 +3853,8 @@ Submodules
Parameters:
Returns:
@@ -3873,9 +3873,9 @@ Submodules
Parameters:
Returns:
@@ -3900,8 +3900,8 @@ Submodules
Parameters:
@@ -3979,7 +3979,7 @@ Submodules
Parameters:
-o (any
) -- python object
+o (any
) – python object
@@ -3995,8 +3995,8 @@ Submodules
Parameters:
@@ -4007,7 +4007,7 @@ Submodules
Parameters:
-manager (H5PYAttributeManager
) -- attribute manager
+manager (H5PYAttributeManager
) – attribute manager
@@ -4039,10 +4039,10 @@ Submodules
- Parameters:
-
- Returns:
@@ -4111,8 +4111,8 @@ Submodules
- Parameters:
-
@@ -4126,8 +4126,8 @@ Submodules
Parameters:
@@ -4142,8 +4142,8 @@ Submodules
Parameters:
@@ -4188,8 +4188,8 @@ Submodules
Parameters:
@@ -4277,7 +4277,7 @@ Submodules
Parameters:
-o (any
) -- h5 object
+o (any
) – h5 object
@@ -4293,8 +4293,8 @@ Submodules
Parameters:
@@ -4365,9 +4365,9 @@ Submodules
Parameters:
@@ -4398,8 +4398,8 @@ Submodules
Parameters:
@@ -4410,7 +4410,7 @@ Submodules
Parameters:
-group -- group object
+group – group object
@@ -4456,11 +4456,11 @@ Submodules
- Parameters:
-name (str
) -- group name
-type_code (str
) -- nexus field type
-
-
-dfilter (H5PYDataFilter
) -- filter deflater
+name (str
) – group name
+type_code (str
) – nexus field type
+
+
+dfilter (H5PYDataFilter
) – filter deflater
- Returns:
@@ -4479,8 +4479,8 @@ Submodules
- Parameters:
-
- Returns:
@@ -4499,9 +4499,9 @@ Submodules
- Parameters:
-
@@ -4513,7 +4513,7 @@ Submodules
Parameters:
-name (str
) -- child name
+name (str
) – child name
Returns:
existing flag
@@ -4558,7 +4558,7 @@ Submodules
Parameters:
-name (str
) -- element name
+name (str
) – element name
Returns:
file tree object
@@ -4575,7 +4575,7 @@ Submodules
Parameters:
-name (str
) -- element name
+name (str
) – element name
Returns:
file tree object
@@ -4617,8 +4617,8 @@ Submodules
Parameters:
@@ -4634,7 +4634,7 @@ Submodules
Parameters:
-obj (FTObject
) -- h5 node
+obj (FTObject
) – h5 node
Returns:
file name
@@ -4723,8 +4723,8 @@ Submodules
Parameters:
@@ -4745,8 +4745,8 @@ Submodules
Parameters:
@@ -4757,10 +4757,10 @@ Submodules
Parameters:
-key (tuple
) -- slide
-source (H5PYTargetFieldView
) -- target field view
-sourcekey (tuple
) -- slide or selection
-shape (tuple
) -- target shape in the layout
+key (tuple
) – slide
+source (H5PYTargetFieldView
) – target field view
+sourcekey (tuple
) – slide or selection
+shape (tuple
) – target shape in the layout
@@ -4781,9 +4781,9 @@ Submodules
Parameters:
Returns:
@@ -4802,12 +4802,12 @@ Submodules
Parameters:
-filterid (int
) -- hdf5 filter id
-name (str
) -- filter name
-
-availability (str
) -- filter availability i.e. 'optional' or 'mandatory'
-shuffle (bool
) -- filter shuffle
-rate (bool
) -- filter shuffle
+filterid (int
) – hdf5 filter id
+name (str
) – filter name
+
+availability (str
) – filter availability i.e. ‘optional’ or ‘mandatory’
+shuffle (bool
) – filter shuffle
+rate (bool
) – filter shuffle
Returns:
@@ -4826,8 +4826,8 @@ Submodules
Parameters:
Returns:
@@ -4845,7 +4845,7 @@ Submodules
Parameters:
-parent (FTObject
) -- parent object
+parent (FTObject
) – parent object
Returns:
list of link objects
@@ -4941,9 +4941,9 @@ Submodules
Parameters:
Returns:
@@ -4962,10 +4962,10 @@ Submodules
Parameters:
Returns:
@@ -4983,7 +4983,7 @@ Submodules
Parameters:
-dtype (str
) -- h5 writer type type
+dtype (str
) – h5 writer type type
Returns:
nupy type
@@ -5001,9 +5001,9 @@ Submodules
Parameters:
Returns:
@@ -5022,11 +5022,11 @@ Submodules
Parameters:
Returns:
@@ -5044,7 +5044,7 @@ Submodules
Parameters:
-parent (FTObject
) -- parent object
+parent (FTObject
) – parent object
Returns:
dataspace UNLIMITED variable
@@ -5062,8 +5062,8 @@ Submodules
Parameters:
-