nxstools package ¶

scan_getattr(attr)[source]¶

get scan attribute

Parameters:: attr (str) – scan attr
Returns:: scan attr value
Return type:: any

scan_setattr(attr, value)[source]¶

set attribute

Parameters:

attr (str) – scan attr
value (any) – scan attr value

set_channels(value, keys=None)[source]¶

set device parameters

Parameters:

value (any) – device parameter value
keys – device parameter keys

set_devices(value, keys=None)[source]¶

set device parameters

Parameters:

value (any) – device parameter value
keys – device parameter keys

set_scan(scan)[source]¶

scan object

Parameters:

scan – scan object
type – Scan

set_scaninfo(value, keys=None, direct=False)[source]¶

set scan info parameters

Parameters:

value (any) – scan parameter value
keys – scan parameter value

class nxstools.h5rediswriter.H5RedisFile(h5object=None, filename=None, h5imp=None, redisurl=None, session=None)[source]¶

Bases: H5CppFile

file tree file

constructor

Parameters:

h5object (any) – h5 object
filename (str) – file name
h5imp (filewriter.FTFile) – h5 implementation file
redisurl (str) – redis url string
session (str) – redis session

append_devices(value, keys=None)[source]¶

append device info parameters

Parameters:

value (any) – device parameter value
keys – device parameter value

append_scaninfo(value, keys=None, direct=False)[source]¶

append scan info parameters

Parameters:

value (any) – scan parameter value
keys – scan parameter value
direct (any) – scan info direct flag

append_stream(name, stream)[source]¶

scan object

Parameters:

name (str) – stream name
scan (Stream) – stream object

finish()[source]¶: start scan

get_channels(keys=None)[source]¶

get channel info parameters

Parameters:: keys – channel parameter keys
Returns value:: channel parameter value
Rtype value:: any

get_devices(keys=None)[source]¶

get devices info parameters

Parameters:: keys – device parameter keys
Returns value:: device parameter value
Rtype value:: any

get_scaninfo(keys=None, direct=False)[source]¶

get scan info parameters

Parameters:

keys – scan parameter value
direct (any) – scan info direct flag

Returns value:

scan parameter value

Rtype value:

prepare()[source]¶: start scan

reset_scaninfo(entryname)[source]¶

reset scan info

Parameters:: entryname (str) – NXentry group name

root()[source]¶

root object

Returns:: parent object
Return type:: H5RedisGroup

scan_command(command, *args, **kwargs)[source]¶

set scan attribute

Parameters:

command (str) – scan command
args (list <any>) – function list arguments
kwargs (dict <str , any>) – function dict arguments

Returns:

scan command value

Return type:

scan_getattr(attr)[source]¶

get scan attribute

Parameters:: attr (str) – scan attr
Returns:: scan attr value
Return type:: any

scan_setattr(attr, value)[source]¶

set attribute

Parameters:

attr (str) – scan attr
value (any) – scan attr value

set_channels(value, keys=None)[source]¶

set channel info parameters

Parameters:

value (any) – channel parameter value
keys – channel parameter keys

set_devices(value, keys=None)[source]¶

set device info parameters

Parameters:

value (any) – device parameter value
keys – device parameter keys

set_entryname(entryname)[source]¶

set entry name

Parameters:: entryname (str) – entry name

set_insname(insname)[source]¶

set instrument name

Parameters:: insname (str) – instrument name

set_scan(scan)[source]¶

scan object

Parameters:: scan (Scan) – scan object

set_scaninfo(value, keys=None, direct=False)[source]¶

set scan info parameters

Parameters:

value (any) – scan parameter value
keys – scan parameter value
direct (any) – scan info direct flag

start()[source]¶: start scan

class nxstools.h5rediswriter.H5RedisGroup(h5object=None, tparent=None, h5imp=None, nxclass=None)[source]¶

Bases: H5CppGroup

file tree group

constructor

Parameters:

h5object (any) – h5 object
tparent (FTObject) – tree parent
h5imp (filewriter.FTGroup) – h5 implementation group
redis (any) – redis object
nxclass (str) – nxclass

class H5RedisGroupIter(group=None)[source]¶

Bases: object

constructor

Parameters:: group (H5RedisGroup) – group object

next()¶

the next attribute

Returns:: attribute object
Return type:: FTAtribute

append_devices(value, keys=None)[source]¶

append device parameters

Parameters:

value (any) – device value
keys – device parameter keys

append_scaninfo(value, keys=None, direct=False)[source]¶

append scan info parameters

Parameters:

value (any) – scan parameter value
keys – scan parameter keys
direct (any) – scan info direct flag

append_stream(name, stream)[source]¶

scan object

Parameters:

name (str) – stream name
scan (Stream) – stream object

property attributes¶

return the attribute manager

Returns:: attribute manager
Return type:: H5CppAttributeManager

create_field(name, type_code, shape=None, chunk=None, dfilter=None)[source]¶

open a file tree element

Parameters:

n (str) – group name
type_code (str) – nexus field type
shape (list < int >) – shape
chunk (list < int >) – chunk
dfilter (H5CppDataFilter) – filter deflater

Returns:

file tree field

Return type:

H5RedisField

create_group(n, nxclass=None)[source]¶

open a file tree element

Parameters:

n (str) – group name
nxclass (str) – group type

Returns:

file tree group

Return type:

H5RedisGroup

create_virtual_field(name, layout, fillvalue=0)[source]¶

creates a virtual filed tres element

Parameters:

name (str) – field name
layout (H5CppFieldLayout) – virual field layout
fillvalue (int or np.ndarray) – fill value

Returns:

file tree field

Return type:

H5RedisField

get_channels(value, keys=None)[source]¶

get scan info parameters

Parameters:: keys – device parameter keys
Returns value:: device parameter value
Rtype value:: any

get_devices(value, keys=None)[source]¶

get scan info parameters

Parameters:: keys – device parameter keys
Returns value:: device parameter value
Rtype value:: any

get_scaninfo(keys=None, direct=False)[source]¶

get scan info parameters

Parameters:

keys – scan parameter keys
direct (any) – scan info direct flag

Returns value:

scan parameter value

Rtype value:

open(name)[source]¶

open a file tree element

Parameters:: name (str) – element name
Returns:: file tree object
Return type:: H5RedisLink

open_link(name)[source]¶

open a file tree element as link

Parameters:: name (str) – element name
Returns:: file tree object
Return type:: H5RedisLink

reset_scaninfo(entryname)[source]¶

reset scan info

Parameters:: entryname (str) – NXentry group name

scan_command(command, *args, **kwargs)[source]¶

set scan attribute

Parameters:

command (str) – scan command
args (list <any>) – function list arguments
kwargs (dict <str , any>) – function dict arguments

Returns:

scan command value

Return type:

H5RedisVirtualFieldLayout

scan_getattr(attr)[source]¶

get scan attribute

Parameters:: attr (str) – scan attr
Returns:: scan attr value
Return type:: any

scan_setattr(attr, value)[source]¶

set attribute

Parameters:

attr (str) – scan attr
value (any) – scan attr value

set_channels(value, keys=None)[source]¶

set device parameters

Parameters:

value (any) – device parameter value
keys – device parameter keys

set_devices(value, keys=None)[source]¶

set device parameters

Parameters:

value (any) – device parameter value
keys – device parameter keys

set_entryname(entryname)[source]¶

set entry name

Parameters:: entryname (str) – entry name

set_insname(insname)[source]¶

set instrument name

Parameters:: insname (str) – instrument name

set_scan(scan)[source]¶

scan object

Parameters:

scan – scan object
type – Scan

set_scaninfo(value, keys=None, direct=False)[source]¶

set scan info parameters

Parameters:

value (any) – scan parameter value
keys – scan parameter keys
direct (any) – scan info direct flag

class nxstools.h5rediswriter.H5RedisLink(h5object=None, tparent=None, h5imp=None)[source]¶

Bases: H5CppLink

file tree link

constructor

Parameters:

h5object (any) – h5 object
tparent (FTObject) – treee parent

class nxstools.h5rediswriter.H5RedisTargetFieldView(filename=None, fieldpath=None, shape=None, dtype=None, maxshape=None, h5imp=None)[source]¶

Bases: H5CppTargetFieldView

target field for VDS

constructor

Parameters:

filename (str) – file name
fieldpath (str) – nexus field path
shape (list < int >) – shape
dtype (str) – attribute type
maxshape (list < int >) – shape
h5imp (filewriter.FTTargetFieldView) – h5 implementation targetfieldview

class nxstools.h5rediswriter.H5RedisVirtualFieldLayout(h5object=None, shape=None, dtype=None, maxshape=None, h5imp=None)[source]¶

Bases: H5CppVirtualFieldLayout

virtual field layout

constructor

Parameters:

h5object (any) – h5 object
shape (list < int >) – shape
dtype (str) – attribute type
maxshape (list < int >) – shape
h5imp (filewriter.FTVirtualFieldLayout) – h5 implementation virtual field layout

nxstools.h5rediswriter.create_file(filename, overwrite=False, redisurl=None, session=None, **pars)[source]¶

create a new file

Parameters:

filename (str) – file name
overwrite (bool) – overwrite flag
libver (str) – library version: ‘lastest’ or ‘earliest’
redisurl (str) – redis URL
session (str) – redis session

Returns:

file object

Return type:

H5RedisFile

nxstools.h5rediswriter.data_filter(filterid=None, name=None, options=None, availability=None, shuffle=None, rate=None)[source]¶

create data filter

Parameters:

filterid (int) – hdf5 filter id
name (str) – filter name
options (tuple <int>) – filter cd values
availability (str) – filter availability i.e. ‘optional’ or ‘mandatory’
shuffle (bool) – filter shuffle
rate (bool) – filter shuffle

Returns:

data filter object

Return type:

H5RedisDataFilter

nxstools.h5rediswriter.deflate_filter(rate=None, shuffle=None, availability=None)[source]¶

create data filter

Parameters:

rate (bool) – filter shuffle
shuffle (bool) – filter shuffle

Returns:

deflate filter object

Return type:

H5RedisDataFilter

nxstools.h5rediswriter.get_links(parent)[source]¶

get links

Parameters:

parent (FTObject) – parent object

Returns:

list of link objects

Returns:

link object

Return type:

obj:: list <H5RedisLink>

nxstools.h5rediswriter.is_image_file_supported()[source]¶

provides if loading of image files are supported

Retruns:: if loading of image files are supported
Return type:: bool

nxstools.h5rediswriter.is_unlimited_vds_supported()[source]¶

provides if unlimited vds are supported

Retruns:: if unlimited vds are supported
Return type:: bool

nxstools.h5rediswriter.is_vds_supported()[source]¶

provides if vds are supported

Retruns:: if vds are supported
Return type:: bool

nxstools.h5rediswriter.link(target, parent, name)[source]¶

create link

Parameters:

target (str) – nexus path name
parent (FTObject) – parent object
name (str) – link name

Returns:

link object

Return type:

H5RedisLink

nxstools.h5rediswriter.load_file(membuffer, filename=None, readonly=False, **pars)[source]¶

load a file from memory byte buffer

Parameters:

membuffer (bytes or io.BytesIO) – memory buffer
filename (str) – file name
readonly (bool) – readonly flag
pars (dict < str, str>) – parameters

Returns:

file object

Return type:

H5RedisFile

nxstools.h5rediswriter.nptype(dtype)[source]¶

converts to numpy types

Parameters:: dtype (str) – h5 writer type type
Returns:: nupy type
Return type:: str

nxstools.h5rediswriter.open_file(filename, readonly=False, redisurl=None, session=None, **pars)[source]¶

open the new file

Parameters:

filename (str) – file name
readonly (bool) – readonly flag
redisurl (str) – redis URL
session (str) – redis session
libver (str) – library version: ‘lastest’ or ‘earliest’

Returns:

file object

Return type:

H5RedisFile

nxstools.h5rediswriter.splitstr(text)[source]¶

split string separated by space

Parameters:

text (list <str>) – text to split
text – split text

nxstools.h5rediswriter.target_field_view(filename, fieldpath, shape, dtype=None, maxshape=None)[source]¶

create target field view for VDS

Parameters:

filename (str) – file name
fieldpath (str) – nexus field path
shape (list < int >) – shape
dtype (str) – attribute type
maxshape (list < int >) – shape

Returns:

target field view object

Return type:

H5RedisTargetFieldView

nxstools.h5rediswriter.unlimited(parent=None)[source]¶

return dataspace UNLIMITED variable for the current writer module

Parameters:: parent (FTObject) – parent object
Returns:: dataspace UNLIMITED variable
Return type:: h5cpp.dataspace.UNLIMITED

nxstools.h5rediswriter.unlimited_selection(sel, shape)[source]¶

checks if hyperslab is unlimited

Parameters:

sel (filewriter.FTHyperslab) – hyperslab selection
shape (list) – give shape

Returns:

if hyperslab is unlimited list

Return type:

list <bool>

nxstools.h5rediswriter.virtual_field_layout(shape, dtype, maxshape=None)[source]¶

creates a virtual field layout for a VDS file

Parameters:

shape (list < int >) – shape
dtype (str) – attribute type
maxshape (list < int >) – shape

Returns:

virtual layout

Return type:

nxstools.nxsargparser module¶

NeXus tool argumen parser

exception nxstools.nxsargparser.ErrorException[source]¶

Bases: Exception

error parser exception

class nxstools.nxsargparser.NXSArgParser(**kwargs)[source]¶

Bases: ArgumentParser

Argument parser with error exception

constructor

Parameters:: kwargs – argparse.ArgumentParser parameter dictionary

createSubParsers()[source]¶

creates command-line parameters parser

Returns:: command runner
Return type:: Runner

error(message)[source]¶

error handler

Parameters:: message (str) – error message

class nxstools.nxsargparser.Runner(parser)[source]¶

Bases: object

abstract runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: parser creator

description = 'abstract runner'¶: (str) command description

epilog = None¶: (str) command epilog

postauto()[source]¶: parser creator after autocomplete run

run(options)[source]¶

run commandthe main program function

Parameters:: options (argparse.Namespace) – parser options

nxstools.nxscollect module¶

Command-line tool to merge images of external file-formats into the master NeXus file

class nxstools.nxscollect.Collector(nexusfilename, compression=2, skipmissing=False, storeold=False, testmode=False, writer=None)[source]¶

Bases: object

Collector merge images of external file-formats into the master NeXus file

The constructor creates the collector object

Parameters:

nexusfilename (str) – the nexus file name
compression (int) – compression rate
skipmissing (bool) – if skip missing images
storeold (bool) – if backup the input file
testmode (bool) – if run in a test mode
writer (str) – the writer module

collect(path=None, inputfiles=None, datatype=None, shape=None)[source]¶

creates a temporary file, collects the all image files defined by hdf5 postrun fields of NXcollection groups and renames the temporary file to the origin one if the action was successful or appends specific data if path and inputfiles are given

Parameters:

path (str) – nexus path of the data field
inputfiles (list <str>) – a list of file strings
datatype (str) – field data type
shape (list <int >) – field shape

class nxstools.nxscollect.Execute(parser)[source]¶

Bases: Runner

Execute runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'append images to the master file'¶: (str) command description

epilog = " examples:\n nxscollect append -c1 /tmp/gpfs/raw/scan_234.nxs \n\n nxscollect append -c32008:0,2 /ramdisk/scan_123.nxs \n\n nxscollect append --test /tmp/gpfs/raw/scan_234.nxs \n\n nxscollect append scan_234.nxs --path /scan/instrument/pilatus/data --input-files 'scan_%05d.tif:0:100' \n"¶: (str) command epilog

postauto()[source]¶: creates parser

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options

class nxstools.nxscollect.LayoutField(target, hyperslab=None)[source]¶

Bases: object

constructor

Parameters:

hyperslab (filewriter.FTHyperslab) – target field object
hyperslab – field hyperslab or slices

hyperslab¶: filewriter.FTHyperslab layout hyperslab or slices

shape¶: tuple vds shape in layout

slices¶: list <slice>

target¶: TargetFieldView target field object

class nxstools.nxscollect.Link(parser)[source]¶

Bases: Runner

Execute runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'create an external or internal link in the master file'¶: (str) command description

epilog = ' examples:\n nxscollect link scan_234.nxs://entry/instrument/lambda --name data --target scan_234/lambda.nxs://entry/data/data \n\nscan_234.nxs://entry/instrument/eiger:NXdetector --target scan_234/eiger.nxs://entry/data/data \n\n\n'¶: (str) command epilog

postauto()[source]¶: creates parser

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options

class nxstools.nxscollect.Linker(nexusfilepath, target, name=None, storeold=False, testmode=False, writer=None)[source]¶

Bases: object

Create external and internal links of NeXus files

The constructor creates the collector object

Parameters:

nexusfilepath (str) – the nexus file name and nexus path
target (str) – the nexus file name and nexus path
storeold (bool) – if backup the input file
testmode (bool) – if run in a test mode
writer (str) – the writer module

link()[source]¶: creates NeXus link

class nxstools.nxscollect.TargetFieldView(filename, path, shape=None, hyperslab=None, maxshape=None)[source]¶

Bases: object

target field map

constructor

Parameters:

filename (str) – file name
path (str) – nexus field path with its name
shape (list <int>) – field shape
hyperslab (filewriter.FTHyperslab) – field hyperslab or slices
maxshape (list <int>) – maximal field shape

filename¶: str file name

hyperslab¶: filewriter.FTHyperslab field hyperslab or slices

maxshape¶: list <int> field maximal shape

path¶: str nexus field path with its name

shape¶: list <int> field shape

slices¶: list <slice>

class nxstools.nxscollect.TargetFieldsLayout(exfieldpaths='', exfieldshapes='', shapes=None, separator=',')[source]¶

Bases: list

constructor

Parameters:

exfieldpaths (str) – target field paths
exfieldshapes (str) – target field shapes
shapes (list`<:obj:`tuple`<:obj:`int> >) – target field shapes
exfieldpaths – separator of field path strings

add_layout_hyperslabs(offsets, blocks, counts, strides)[source]¶

add layout hyperslabs

Parameters:

offsets (str) – layout offsets
blocks (str) – layout blocks
counts (str) – layout counts
strides (str) – layout strides

add_layout_slices(slices)[source]¶

add layout slices

Parameters:: slices (str) – layout slices

add_target_hyperslabs(offsets, blocks, counts, strides)[source]¶

add target hyperslabs

Parameters:

offsets (str) – target offsets
blocks (str) – target blocks
counts (str) – target counts
strides (str) – target strides

add_target_slices(slices)[source]¶

add taget slices

Parameters:: slices (str) – target slices

class nxstools.nxscollect.VDS(parser)[source]¶

Bases: Runner

Execute runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'create a virual dataset in the master file'¶: (str) command description

epilog = " examples:\n\n nxscollect vds scan_234.nxs://entry/instrument/eiger/data --shape '1000,2048,1024' --dtype uint32 --target-fields 'eiger_%05d.nxs://entry/data/data:1:10' --shapes '100,,:100,,:100,,:100,,:100,,:100,,:100,,:100,,:100,,:100,,' --offsets '0,,:100,,:200,,:300,,:400,,:500,,:600,,:700,,:800,,:900,,' \n\n\n - creates VDS (shape [1000,2048,1024]) of ten nexus files (shape [100,2048,1024]) merged in their first dimension\n\n\n\n nxscollect vds scan_234.nxs://entry/instrument/lambda/data --shape '100,300,762' --dtype uint32 --target-fields 'lambda_%05d.nxs://entry/data/data:0:2' --shapes ',,250:,,250:,,250' --offsets ',,:,,256:,,512' --counts 'U,,:U,,:U,,' -f 1 \n\n\n - creates VDS (shape [100,300,762]) of three nexus files (shape [100,300,250]) merged in their third dimension,\n separated with a 6 pixel gap of 1 values and unlimited first dimension\n\n\n\n nxscollect vds scan_234.nxs://entry/instrument/percival/data --shape '4000,1600,2000' --dtype int16 --target-fields 'percival_%05d.nxs://entry/data/data:1:4' --shapes '1000,,:1000,,:1000,,:1000,,' --offsets '0,,:1,,:2,,:3,,' --counts 'U,,:U,,:U,,:U,,' --strides '4,,:4,,:4,,:4,,' \n\n\n - creates VDS (shape [1000,1600,2000]) of three nexus files (shape [1000,1600,2000])\n merged in their the first dimension with interlaying frames\n and unlimited first dimension\n\n\n\n"¶: (str) command epilog

postauto()[source]¶: creates parser

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options

class nxstools.nxscollect.VirtualDataset(nexusfilepath, options, writer=None)[source]¶

Bases: object

Create virtual dataset in the master NeXus files

The constructor creates the collector object

Parameters:

nexusfilepath (str) – the nexus file name and nexus path
options (argparse.Namespace) – parser options
writer (str) – the writer module

create()[source]¶: creates VDS

nxstools.nxscollect.crdtoint(crd)[source]¶

convert coorinate to int or None or Unlimited

Parameters:: crd (cordinate as string) – cordinate as string
Returns:: converted coordinate
Return type:: int

nxstools.nxscollect.filegenerator(filestr, pattern=None)[source]¶

provides file name generator from file string

Parameters:: filestr – file string
Type:: filestr: str
Returns:: file name generator or a list of file names
Return type:: methodinstance

nxstools.nxscollect.getcompression(compression)[source]¶

converts compression string to a deflate level parameter: or list with [filterid, opt1, opt2, …]

Parameters:: compression (str) – compression string
Returns:: deflate level parameter or list with [filterid, opt1, opt2, …]
Return type:: int or list < int > or None

nxstools.nxscollect.main()[source]¶: the main program function

nxstools.nxscollect.splitcoords(crdstr)[source]¶

splits coordinate string

Parameters:: crdstr (cordinate string) – cordinate string
Returns:: a list ofr coordinates in tuples
Return type:: list <tuple < int >>

nxstools.nxscollect.splitslices(crdstr)[source]¶

splits coordinate string

Parameters:: crdstr (cordinate string) – cordinate string
Returns:: a list ofr coordinates in tuples
Return type:: list <tuple < int >>

nxstools.nxsconfig module¶

Command-line tool for ascess to the nexdatas configuration server

class nxstools.nxsconfig.Components(parser)[source]¶

Bases: Runner

Components runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'get a list of dependent components'¶: (str) command description

epilog = ' examples:\n nxsconfig components dcm\n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

class nxstools.nxsconfig.ConfigServer(device, nonewline=False)[source]¶

Bases: object

configuration server adapter

constructor

Parameters:

device (str) – device name of the configuration server
nonewline (bool) – if the output should not be separated by the new line character

char¶: (str) spliting character

componentsCmd(components)[source]¶

lists components of the components

Parameters:: components (list <str>) – given components
Returns:: list of component names
Return type:: list <str>

dataCmd(args)[source]¶

provides varaible values

Parameters:: args (list <str>) – list of item names
Returns:: JSON with variables
Return type:: str

deleteCmd(ds, args, ask=True, profiles=False)[source]¶

delete the DB items

Parameters:

ds (bool) – flag set True for datasources
args (list <str>) – list of item names
ask (bool) – ask flag
profiles (bool) – flag set True for profiles

Returns:

list of XML items

Return type:

describeCmd(ds, args, md, pr, headers=None, filters=None)[source]¶

provides description of configuration elements

Parameters:

ds (bool) – flag set True for datasources
args (list <str>) – list of item names
md (bool) – flag set True for mandatory components
pr (str) – flag set True for private components
pr – column headers
filters (str) – filters for first column names separated by comma

Returns:

list with description

Return type:

geometryCmd(args, md, pr)[source]¶

provides geometry info for given elements

Parameters:

args (list <str>) – list of item names
md (bool) – flag set True for mandatory components
pr (bool) – flag set True for private components

Returns:

list with description

Return type:

getCmd(args)[source]¶

provides final configuration

Parameters:: args (list <str>) – list of item names
Returns:: XML configuration string
Return type:: str

infoCmd(ds, args, md, pr, profiles)[source]¶

Provides info for given elements

Parameters:

ds (bool) – flag set True for datasources
args (list <str>) – list of item names
md (bool) – flag set True for mandatory components
pr (bool) – flag set True for private components
profiles (bool) – flag set True for profiles

Returns:

list with description

Return type:

listCmd(ds, mandatory=False, private=False, profiles=False)[source]¶

lists the DB item names

Parameters:

ds (bool) – flag set True for datasources
mandatory (bool) – flag set True for mandatory components
private (bool) – flag set True for components starting with ‘__’
profiles (bool) – flag set True for profiles

Returns:

list op item names

Return type:

mergeCmd(args)[source]¶

provides merged components

Parameters:: args (list <str>) – list of item names
Returns:: XML configuration string with merged components
Return type:: str

recordCmd(ds, name)[source]¶

lists datasources of the component

Parameters:

ds (bool) – flag set True for datasources
name (str) – given component or datasource

Returns:

list of record names

Return type:

showCmd(ds, args, mandatory=False, profiles=False, directory=None)[source]¶

shows the DB items

Parameters:

ds (bool) – flag set True for datasources
args (list <str>) – list of item names
mandatory (bool) – flag set True for mandatory components
profiles (bool) – flag set True for profiles
directory (str) – output file directory

Returns:

list of XML items

Return type:

sourcesCmd(components, mandatory=False)[source]¶

lists datasources of the components

Parameters:: components (list <str>) – given components
Returns:: list of datasource names
Return type:: list <str>

uploadCmd(ds, args, force=False, profiles=False, directory='.', mandatory=False, external=None)[source]¶

upload the DB items from files

Parameters:

ds (bool) – flag set True for datasources
args (list <str>) – list of item names
force (bool) – force flag
profiles (bool) – flag set True for profiles
directory (str) – input file directory
mandatory (bool) – mandatory flag
external (str) – external import type

Returns:

list of XML items

Return type:

variablesCmd(components, mandatory=False)[source]¶

lists variable of the components

Parameters:: components (list <str>) – given components
Returns:: list of datasource names
Return type:: list <str>

class nxstools.nxsconfig.Data(parser)[source]¶

Bases: Runner

Data runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'get/set values of component variables'¶: (str) command description

epilog = ' examples:\n nxsconfig data \n nxsconfig data \'{"sample_name":"H2O"}\'\n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

class nxstools.nxsconfig.Delete(parser)[source]¶

Bases: Runner

Show runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'delete components, datasources or profiles with given names from ConfigServer'¶: (str) command description

epilog = ' examples:\n nxsconfig delete pilatus1a\n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

class nxstools.nxsconfig.Describe(parser)[source]¶

Bases: Runner

Describe runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'show all parameters of given components or datasources'¶: (str) command description

epilog = ' examples:\n nxsconfig describe pilatus\n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

class nxstools.nxsconfig.Geometry(parser)[source]¶

Bases: Runner

List runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'show transformation parameters of given components or datasources'¶: (str) command description

epilog = ' examples:\n nxsconfig geometry dcm\n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

class nxstools.nxsconfig.Get(parser)[source]¶

Bases: Runner

Get runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'get full configuration of components'¶: (str) command description

epilog = ' examples:\n nxsconfig get dcm source slit1 slit2\n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

class nxstools.nxsconfig.Info(parser)[source]¶

Bases: Runner

List runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'show general parameters of given components, datasources or profile'¶: (str) command description

epilog = ' examples:\n nxsconfig info slit1\n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

class nxstools.nxsconfig.List(parser)[source]¶

Bases: Runner

List runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'list names of available components, datasources or profiles'¶: (str) command description

epilog = ' examples:\n nxsconfig list\n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

class nxstools.nxsconfig.Merge(parser)[source]¶

Bases: Runner

Merge runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'get merged configuration of components or datasources'¶: (str) command description

epilog = ' examples:\n nxsconfig merge slit1 dcm \n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

class nxstools.nxsconfig.Record(parser)[source]¶

Bases: Runner

Record runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'get a list of datasource record names for components or datasources'¶: (str) command description

epilog = ' examples:\n nxsconfig record -d exp_mot01 \n nxsconfig record dcm \n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

class nxstools.nxsconfig.Servers(parser)[source]¶

Bases: Runner

Servers runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'get a list of configuration servers from the current tango host'¶: (str) command description

epilog = ' examples:\n nxsconfig servers\n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

class nxstools.nxsconfig.Show(parser)[source]¶

Bases: Runner

Show runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'show (or write to files) components, datasources or profiles with given names'¶: (str) command description

epilog = ' examples:\n nxsconfig show dcm\n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

class nxstools.nxsconfig.Sources(parser)[source]¶

Bases: Runner

Sources runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'get a list of component datasources'¶: (str) command description

epilog = ' examples:\n nxsconfig sources slit1\n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

class nxstools.nxsconfig.Upload(parser)[source]¶

Bases: Runner

Store runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'upload components, datasources or profiles with given names from locale filesystem into ConfigServer'¶: (str) command description

epilog = ' examples:\n nxsconfig upload exp_c01 exp_c02\n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

class nxstools.nxsconfig.Variables(parser)[source]¶

Bases: Runner

Variables runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'get a list of component variables'¶: (str) command description

epilog = ' examples:\n nxsconfig variables dcm\n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

nxstools.nxsconfig.main()[source]¶: the main program function

nxstools.nxscreate module¶

Command-line tool for creating NXSConfigServer configuration of Nexus Files

class nxstools.nxscreate.ClientDS(parser)[source]¶

Bases: Runner

clientds runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: parser creator

description = 'create client datasources'¶: (str) command description

epilog = "\n * with -b: datasources are created in Configuration Server database\n * without -b: datasources are created on the local filesystem in -d <directory> \n * default: <directory> is '.' \n <server> is taken from Tango DB\n\n examples:\n\n nxscreate clientds starttime -b \n\n - create the 'starttime' datasource of the 'CLIENT' type with the 'starttime' record name\n and upload them to the NXSConfigServer database \n\n nxscreate clientds title -d /home/user/xmldir \n\n - create the 'title' datasource of the 'CLIENT' type with the 'title' record name\n in the '/home/user/xmldir' directory\n\n nxscreate clientds -v exp_c -f1 -l4 -b \n\n - create the 'exp_c01', 'exp_c02', 'exp_c03', 'exp_c04' datasources of the 'CLIENT' type\n with the corresponding 'exp_c0? record names\n and upload them to the NXSConfigServer database \n where '?' is 1, 2, 3, 4 respectively \n\n nxscreate clientds -v hasppXX:10000/expchan/vfcadc_exp/ -f5 -l8 -m -b -s exp_vfc\n\n - create the 'exp_vfc05', 'exp_vfc06', 'exp_vfc07', 'exp_vfc08' datasources of the 'CLIENT' type\n with the corresponding 'hasppXX:10000/expchan/vfcadc_exp/?' record names\n and upload them to the NXSConfigServer database \n where '?' is 5, 6, 7, 8 respectively \n\n"¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options

class nxstools.nxscreate.Comp(parser)[source]¶

Bases: Runner

comp runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'create simple components'¶: (str) command description

epilog = ' * with -b: components are created (without datasources) in Configuration Server database\n * without -b: components are created (without datasources) on the local filesystem in -d <directory> \n * default: <directory> is \'.\' \n <server> is taken from Tango DB\n <strategy> is step\n <type> is NX_FLOAT\n <chunk> is SCALAR\n <nexuspath> is "/\\$var.entryname#\'scan\'\\$var.serialno:NXentry/instrument/collection/"\n\n examples:\n\n nxscreate comp counter \n\n - create the \'counter\' component in the local directory \n which sets fetching data in the \'STEP\' mode from a \'counter\' datasource to \n \'/\\$var.entryname#\'scan\'\\$var.serialno:NXentry/instrument:NXinstrument/collection:NXcollection/counter\' \n\n nxscreate comp -f5 -l7 -v exp_c -b \n\n - create the \'exp_c05\', \'exp_c06\' \'exp_c07\' components in the NXSConfigServer database \n which set fetching data in the \'STEP\' mode from corresponding \'exp_c0?\' datasources to corresponding\n \'/\\$var.entryname#\'scan\'\\$var.serialno:NXentry/instrument:NXinstrument/collection:NXcollection/exp_c0?\'\n where \'?\' is 5, 6, 7 respectively \n\n nxscreate comp lambda -d /home/user/xmldir/ \n\n - create the \'lambda\' component in the \'/home/user/xmldir/\' directory \n which sets fetching data in the \'STEP\' mode from a \'lambda\' datasource to \n \'/\\$var.entryname#\'scan\'\\$var.serialno:NXentry/instrument:NXinstrument/collection:NXcollection/lambda\' \n\n nxscreate comp -n "/\\$var.entryname#\'scan\'\\$var.serialno:NXentry/instrument/sis3302:NXdetector/collection:NXcollection/" -v sis3302_1_roi -f1 -l3 -g FINAL -t NX_FLOAT64 -k -b -m \n\n - create the \'sis3302_1_roi1\', sis3302_1_roi2\', sis3302_1_roi3\' components in the NXSConfigServer database \n which set fetching data in the \'FINAL\' mode from corresponding \'sis3302_1_roi?\' datasources to corresponding\n \'/\\$var.entryname#\'scan\'\\$var.serialno:NXentry/instrument:NXinstrument/sis3302:NXdetector/collection:NXcollection/sis3302_1_roi?\'\n float64 fields and creates corresponding\n \'/\\$var.entryname#\'scan\'\\$var.serialno:NXentry/data:NXdata/sis3302_1_roi?\' links\n where \'?\' is 1, 2, 3 respectively \n\n nxscreate comp -n "/\\$var.entryname#\'scan\'\\$var.serialno:NXentry/instrument/eh1_mca01:NXdetector/data" eh1_mca01 -g STEP -t NX_FLOAT64 -i -b -c SPECTRUM\n\n - create the \'eh1_mca01\' component in the NXSConfigServer database \n which set fetching STECTRUM data in the \'STEP\' mode from a \'eh1_mca01\' datasource to \n \'/\\$var.entryname#\'scan\'\\$var.serialno:NXentry/instrument:NXinstrument/eh1_mca01:NXdetector/data\n float64 fields and creates \n \'/\\$var.entryname#\'scan\'\\$var.serialno:NXentry/data:NXdata/eh1_mca01\' links\n\n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options

class nxstools.nxscreate.Compare(parser)[source]¶

Bases: Runner

compare runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'compare two online.xml files'¶: (str) command description

epilog = " * default: second file <online_file> is '/online_dir/online.xml' \n if only file is given\n\n examples:\n\n nxscreate compare online.xml \n\n - compare 'online.xml' to '/online_dir/online.xml\n' \n nxscreate compare /online_dir/online_040.xml online.xml \n\n - compare '/online_dir/online_040.xml' to 'online.xml'\n"¶: (str) command epilog

postauto()[source]¶: creates parser

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options

class nxstools.nxscreate.DeviceDS(parser)[source]¶

Bases: Runner

deviceds runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'create datasources for all device attributes'¶: (str) command description

epilog = " * without <dv_attr1>: datasources for all attributes are created\n * with -b: datasources are created in Configuration Server database\n * without -b: datasources are created on the local filesystem in -d <directory> \n * default: <directory> is '.' \n <server> is taken from Tango DB\n <datasource> is 'exp_mot' \n <host>, <port> are taken from <server>\n\n examples:\n\n nxscreate deviceds -v p09/pilatus/haso228k \n\n - create datasources of the 'TANGO' type\n for all attribute of 'p09/pilatus/haso228k' tango device\n in the local file directory database \n\n nxscreate deviceds -v p09/lambda2m/haso228k -uhaslambda -b \n\n - create datasources of the 'TANGO' type\n for all attribute of 'p09/lambda2m/haso228k' tango device\n with their hostname 'haslambda' \n and upload them to the NXSConfigServer database \n\n nxscreate deviceds -v p09/pilatus300k/haso228k -b -s pilatus300k_ RoI Energy ExposureTime\n\n - create datasources of the 'TANGO' type\n for RoI Energy ExposureTime attribute of 'p09/lambda2m/haso228k' tango device\n with the 'pilatus300k_' datasource prefix \n and upload them to the NXSConfigServer database \n\n"¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options

class nxstools.nxscreate.OnlineCP(parser)[source]¶

Bases: Runner

onlinecp runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'create component from online.xml file'¶: (str) command description

epilog = " * without '-c <component>': show a list of possible components\n * with -b: datasources are created in Configuration Server database\n * without -b: datasources are created on the local filesystem in -d <directory> \n * default: <directory> is '.' \n * default: <inputFile> is '/online_dir/online.xml' \n <server> is taken from Tango DB\n\n examples:\n\n nxscreate onlinecp \n\n - list possible components which can be created from online.xml \n\n nxscreate onlinecp -c pilatus -b \n\n - create the 'pilatus' component and its datasources\n in the NXSConfigServer database\n\n nxscreate onlinecp -c lambda -d /home/user/xmldir/ \n\n - create the 'lambda' component and its datasources\n in the '/home/user/xmldir/' directory\n\n nxscreate onlinecp -c lmbd -t lambda -b \n\n - create the 'lmbd' component of 'lambda' type and its datasources\n in the NXSConfigServer database\n\n\n nxscreate onlinecp -c lmbd -t lambda -v p00/lmbd/1 -u haso000 -w 10000 -b \n\n - create the 'lmbd' component of 'lambda' type and its datasources without online.xml\n in the NXSConfigServer database\n\n"¶: (str) command epilog

postauto()[source]¶: creates parser

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options

class nxstools.nxscreate.OnlineDS(parser)[source]¶

Bases: Runner

onlineds runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'create datasources from online.xml file'¶: (str) command description

epilog = " * with -b: datasources are created in Configuration Server database\n * with -d <directory>: datasources are created on the local filesystem\n * without -b or -d <directory>: run in the test mode\n * default: <inputFile> is '/online_dir/online.xml' \n <server> is taken from Tango DB\n\n `onlineds` overwrites existing datasources\n\n examples:\n\n nxscreate onlineds -b \n\n - create datasources from online.xml file \n and upload them to the NXSConfigServer database \n\n nxscreate onlineds -b -t \n\n - like above but set motor tango datasources to \n be no __CLIENT__ like\n\n nxscreate onlineds -d /home/user/xmldir \n\n - create datasources from online.xml file \n and save them in the '/home/user/xmldir' directory \n\n nxscreate onlineds \n\n - run the command in test mode without creating datasources \n"¶: (str) command epilog

postauto()[source]¶: creates parser

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options

nxstools.nxscreate.PYTANGO = True¶: (bool) True if PyTango available

class nxstools.nxscreate.PoolDS(parser)[source]¶

Bases: Runner

poolds runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'create datasources from sardana pool device'¶: (str) command description

epilog = " * with -b: datasources are created in Configuration Server database\n * with -d <directory>: datasources are created on the local filesystem\n * without -b or -d <directory>: run in the test mode\n * default: <channel> is 'ALL' \n <server> is taken from Tango DB\n\n <pool> is taken from Tango DB\n\n `poolds` overwrites existing datasources\n\n examples:\n\n nxscreate poolds -b \n\n - create all datasources defined in the local Pool \n and upload them to the NXSConfigServer database \n\n nxscreate poolds -b -t \n\n - like above but set motor tango datasources to \n be no __CLIENT__ like\n\n nxscreate poolds -d . -p p09/pool/haso228 \n\n - create all datasources defined in the 'p09/pool/haso228' Pool \n and save them in the local directory \n\n nxscreate poolds -b Motor CTExpChannel \n\n - create datasources of 'Motor' and CTExpChannel classes \n defined in the local Pool \n and upload them to the NXSConfigServer database \n\n nxscreate poolds -b mot01 mot03 \n\n - create 'mot01' and 'mot03' datasources\n defined in the local Pool \n and upload them to the NXSConfigServer database \n\n nxscreate poolds \n\n - run the command in test mode without creating datasources \n"¶: (str) command epilog

postauto()[source]¶: creates parser

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options

class nxstools.nxscreate.SECoPCP(parser)[source]¶

Bases: Runner

secop component runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'create secop components'¶: (str) command description

epilog = " * with -b: components are created (without datasources) in Configuration Server database\n * without -b: components are created (without datasources) on the local filesystem in -d <directory> \n * default: <directory> is '.' \n <port> is 5001\n\n examples:\n\n nxscreate secopcp \n nxscreate secopcp -l \n\n - list all modules of the given node \n\n nxscreate secopcp -c temp_node -d . -j secopn_node.json \n\n - create the all secop components in the local directory for the node configured with the json file \n\n nxscreate secopcp T -t 5001 -b \n\n - create the component for the T secop module in the NXSConfigServer database for the node on the port 5000 \n\n nxscreate secopcp -d /home/user/xmldir/ \n\n - create the all secop components in the given directory\n\n"¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options

class nxstools.nxscreate.StdComp(parser)[source]¶

Bases: Runner

stdcomp runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'create component from the standard templates'¶: (str) command description

epilog = " * without '-t <type>': show a list of possible component types\n * with '-t <type> and without -c <component>: show a list of component variables for the given component type\n * with -b: datasources are created in Configuration Server database\n * without -b: datasources are created on the local filesystem in -d <directory> \n * default: <directory> is '.' \n * [name1 value1 [name2 value2] ...] sequence defines component variable values \n\n examples:\n\n nxscreate stdcomp \n\n - list possible component types\n from the 'nxstools.xmltemplates' package\n\n nxscreate stdcomp -p nxsextrasp00 \n\n - list possible component types from the 'nxsextrasp00' package\n\n nxscreate stdcomp -t source \n\n - list a description of 'source' component variables\n\n nxscreate stdcomp -t default -c default -m -b\n\n - create 'default' component of the 'default' type\n in the NXSConfigServer database and set it as mandatory\n\n nxscreate stdcomp -t slit -c front_slit1 xgap slt1x ygap slt1y\n\n - create 'front_slit1' component of the 'slit' type\n where variables xgap='slt1x' and ygap='slt1and' in the local directory \n\n nxscreate stdcomp -p nxsextrasp08 -t analyzer -c analyzer1 v anav roll anaroll -b\n\n - create 'analyzer1' component of the 'analyzer type'\n where variables v='anav' and roll='amaroll' in the NXSConfigServer database\n"¶: (str) command epilog

postauto()[source]¶: creates parser

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options

class nxstools.nxscreate.TangoDS(parser)[source]¶

Bases: Runner

tangods runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'create tango datasources'¶: (str) command description

epilog = " * with -b: datasources are created in Configuration Server database\n * without -b: datasources are created on the local filesystem in -d <directory> \n * default: <directory> is '.' \n <server> is taken from Tango DB\n <datasource> is 'exp_mot' \n <host>, <port> are taken from <server>\n\n examples:\n\n nxscreate tangods -f1 -l2 -v p09/motor/exp. -s exp_mot \n\n - create the 'exp_mot01' and 'exp_mot02' datasources of the 'TANGO' type\n with the corresponding 'p09/motor/exp.0?' device names\n and 'Position' tango attribute names in the local directory\n where '?' is 1, 2 respectively \n\n nxscreate tangods -f1 -l32 -v p02/motor/eh1a. -s exp_mot -b \n\n - create the 'exp_mot01', ... ,'exp_mot32' datasources of the 'TANGO' type\n with the corresponding 'p09/motor/eh1a.??' device names\n while their attribute name is 'Position' and upload them to the NXSConfigServer database\n where '??' is 01, 02, ... ,32 respectively \n\n nxscreate tangods -v petra/globals/keyword -s source_current -u haso228 -t 10000 \\ \n -a BeamCurrent -b -r p09/nxsconfigserver/haso228 -o -g __CLIENT__\n\n - create the a 'source_current' datasource of the 'TANGO' type belonging to the '__CLIENT__' group \n with the 'petra/globals/keyword' device name\n while their attribute name is 'BeamCurrent', \n their hostname is 'haso228', their tango port is '10000'\n and upload them to the NXSConfigServer 'p09/nxsconfigserver/haso228' database\n\n nxscreate tangods -f1 -l8 -v pXX/slt/exp. -s slt_exp_ -u hasppXX.desy.de -b \n\n - create the 'slt_exp_01', ... ,'slt_exp_08' datasources of the 'TANGO' type\n with the corresponding 'pXX/slt/exp.0?' device names\n while their attribute name is 'Position', \n their hostname is 'hasppXX.desy.de' and upload them to the NXSConfigServer database\n where '??' is 1, 2, ... ,8 respectively \n\n"¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options

nxstools.nxscreate.main()[source]¶: the main program function

nxstools.nxscreator module¶

Command-line tool for creating to the nexdatas configuration server

class nxstools.nxscreator.CPCreator(options, args, printouts=True)[source]¶

Bases: Creator

component creator of all online.xml complex devices

constructor

Parameters:

options (optparse.Values) – command options
args (list <str >) – command arguments
printouts (bool) – if printout is enable

components¶: (dict <str, str >) component xml dictionary

create()[source]¶: creates components of all online.xml complex devices

createXMLs()[source]¶: creates component xmls of all online.xml complex devices abstract method

datasources¶: (dict <str, str >) datasource xml dictionary

xmlpackage¶: (str) xml template component package

xmltemplatepath¶: (str) xml template component package path

exception nxstools.nxscreator.CPExistsException[source]¶

Bases: Exception

Component already exists exception

class nxstools.nxscreator.ClientDSCreator(options, args, printouts=True)[source]¶

Bases: Creator

client datasource creator

constructor

Parameters:

options (optparse.Values) – command options
args (list < str >) – command arguments
printouts (bool) – if printout is enable

create()[source]¶: creates a client datasource xml and stores it in DB or filesytem

class nxstools.nxscreator.CompareOnlineDS(options, args, printouts=True)[source]¶

Bases: object

comparing tool for online.xml files

constructor

Parameters:

options (optparse.Values) – command options
args (list < str >) – command arguments
printouts (bool) – if printout is enable

args¶: (list < str >) creator arguments

compare()[source]¶

options¶: (optparse.Values) creator options

class nxstools.nxscreator.ComponentCreator(options, args, printouts=True)[source]¶

Bases: Creator

component creator

constructor

Parameters:

options (optparse.Values) – command options
args (list < str >) – command arguments
printouts (bool) – if printout is enable

create()[source]¶: creates a component xml and stores it in DB or filesytem

class nxstools.nxscreator.Creator(options, args, printouts=True)[source]¶

Bases: object

configuration server adapter

constructor

Parameters:

options (optparse.Values) – command options
args (list < str >) – command arguments
printouts (bool) – if printout is enable

args¶: (list < str >) creator arguments

options¶: (optparse.Values) creator options

exception nxstools.nxscreator.DSExistsException[source]¶

Bases: Exception

DataSource already exists exception

class nxstools.nxscreator.Device[source]¶

Bases: object

device from online.xml

attribute¶: (str) attribute name

compare(dv)[source]¶

dtype¶: (str) device type

findAttribute(tangohost, clientlike=False)[source]¶

sets attribute and datasource group of online.xml device

Parameters:

tangohost (str) – tango host
clientlike (bool) – tango motors to be client like

findDevice(tangohost)[source]¶

sets sardana device name and sardana host/port of online.xml device

Parameters:: tangohost (str) – tango host

group¶: (str) datasource tango group

host¶: (str) host without port

hostname¶: (str) host name with port

module¶: (str) device module

name¶: (str) device name

port¶: (str) port

sardanahostname¶: (str) sardana host name

sardananame¶: (str) sardana name with port

sdevice¶: (str) sardana device name

setSardanaName(tolower)[source]¶

sets sardana name

Parameters:: tolower (bool) – If True name in lowercase

shost¶: (str) sardana host without port

splitHostPort()[source]¶: spilts host name from port

sport¶: (str) sardana tango port

tdevice¶: (str) tango device name

thost¶: (str) tango host without port

tolower()[source]¶: converts name, module, tdevice, hostname into lower case

tport¶: (str) tango port

class nxstools.nxscreator.DeviceDSCreator(options, args, printouts=True)[source]¶

Bases: Creator

device datasource creator

constructor

Parameters:

options (optparse.Values) – command options
args (list < str >) – command arguments
printouts (bool) – if printout is enable

create()[source]¶: creates a tango datasources xml of given device and stores it in DB or filesytem

class nxstools.nxscreator.OnlineCPCreator(options, args, printouts=True)[source]¶

Bases: CPCreator

component creator of online components

constructor

Parameters:

options (optparse.Values) – command options
args (list < str >) – command arguments
printouts (bool) – if printout is enable

createXMLs()[source]¶: creates component xmls of all online.xml complex devices

listcomponents()[source]¶

provides a list of components with xml templates

Returns:: list of components with xml templates
Return type:: list <str >

listcomponenttypes()[source]¶

provides a list of standard component types

Returns:: list of standard component types
Return type:: list <str>

class nxstools.nxscreator.OnlineDSCreator(options, args, printouts=True)[source]¶

Bases: Creator

datasource creator of all online.xml simple devices

constructor

Parameters:

options (optparse.Values) – command options
args (list <str >) – command arguments
printouts (bool) – if printout is enable

create()[source]¶: creates datasources of all online.xml simple devices

createXMLs()[source]¶: creates datasource xmls of all online.xml simple devices

datasources¶: (dict <str, str >) datasource xml dictionary

xmlpackage¶: (str) xml template component package

xmltemplatepath¶: (str) xml template component package path

nxstools.nxscreator.PYTANGO = True¶: (bool) True if PyTango available

class nxstools.nxscreator.PoolDSCreator(options, args, printouts=True)[source]¶

Bases: Creator

datasource creator of all sardana pool acquisition channels

constructor

Parameters:

options (optparse.Values) – command options
args (list <str >) – command arguments
printouts (bool) – if printout is enable

create()[source]¶: creates datasources of all online.xml simple devices

createXMLs()[source]¶: creates datasource xmls of all online.xml simple devices

datasources¶: (dict <str, str >) datasource xml dictionary

class nxstools.nxscreator.SECoPCPCreator(options, args, printouts=True)[source]¶

Bases: CPCreator

component creator of secop components

constructor

Parameters:

options (optparse.Values) – command options
args (list < str >) – command arguments
printouts (bool) – if printout is enable

create()[source]¶: creates components of all online.xml complex devices

createSECoPDS(dsname, message, group=None, access=None, host=None, port=None, timeout=None)[source]¶

create SECoP datasource

Parameters:

dsname (str) – datasource name
message (str) – secop command
group (str) – secop group name
access (str) – secop attribute access list
host (str) – secop host name
port (str or float) – secop port name
port – minimum timeout

createSECoPLinkDS(entryname, samplename, sampleenvname, meanings, environments)[source]¶

create SECoP datasource

Parameters:

entryname (str) – secop entry name
samplename (str) – secop sample name
sampleenvname (str) – secop sample name
meanings (str) – secop meanings list
environments (str) – secop environments list

createXMLs()[source]¶: creates component xmls of all online.xml complex devices

listmodules()[source]¶

provides a list of modules for the secop node

Returns:: list of modules for the secop node
Return type:: list <str >

class nxstools.nxscreator.StandardCPCreator(options, args, printouts=True)[source]¶

Bases: CPCreator

component creator of standard templates

constructor

Parameters:

options (optparse.Values) – command options
args (list < str >) – command arguments
printouts (bool) – if printout is enable

createXMLs()[source]¶: creates component xmls of all online.xml complex devices

listcomponenttypes()[source]¶

provides a list of standard component types

Returns:: list of standard component types
Return type:: list <str>

listcomponentvariables()[source]¶

provides a list of standard component types

Returns:: list of standard component types
Return type:: list <str>

class nxstools.nxscreator.TangoDSCreator(options, args, printouts=True)[source]¶

Bases: Creator

tango datasource creator

constructor

Parameters:

options (optparse.Values) – command options
args (list < str >) – command arguments
printouts (bool) – if printout is enable

create()[source]¶: creates a tango datasource xml and stores it in DB or filesytem

exception nxstools.nxscreator.WrongParameterError[source]¶

Bases: Exception

wrong parameter exception

nxstools.nxsdata module¶

Command-line tool to ascess to Tango Data Server

class nxstools.nxsdata.CloseEntry(parser)[source]¶

Bases: Runner

CloseEntry runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'close the current entry'¶: (str) command description

epilog = ' examples:\n nxsdata closeentry \n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

class nxstools.nxsdata.CloseFile(parser)[source]¶

Bases: Runner

CloseFile runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'close the current file'¶: (str) command description

epilog = ' examples:\n nxsdata closefile \n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

class nxstools.nxsdata.NexusServer(device)[source]¶

Bases: object

configuration server adapter

constructor

Parameters:: device (str) – device name of configuration server

closeEntry()[source]¶: closes the entry

closeFile()[source]¶: closes the file

openEntry(xmlconfig)[source]¶

opens an entry

Parameters:: xmlconfig (str) – xml configuration string

openFile(filename)[source]¶

opens the h5 file

Parameters:: filename (str) – h5 file name

record(jsondata)[source]¶

records one step

Parameters:: jsondata (str) – step JSON data

setData(jsondata)[source]¶

sets the global JSON data

Parameters:: jsondata (str) – global JSON data

tdwServer¶: (PyTango.DeviceProxy) NeXus writer device proxy

class nxstools.nxsdata.OpenEntry(parser)[source]¶

Bases: Runner

OpenEntry runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'create new entry'¶: (str) command description

epilog = ' examples:\n nxsdata openentry ... \n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

class nxstools.nxsdata.OpenFile(parser)[source]¶

Bases: Runner

OpenFile runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'open a new H5 file'¶: (str) command description

epilog = ' examples:\n nxsdata openfile /tmp/watertest.nxs \n nxsdata openfile -s p02/tangodataserver/exp.01 /user/data/myfile.h5\n\n'¶: (str) command epilog

postauto()[source]¶: parser creator after autocomplete run

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

class nxstools.nxsdata.Record(parser)[source]¶

Bases: Runner

Record runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'record one step with step JSON data'¶: (str) command description

epilog = ' examples:\n nxsdata record ... \n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

class nxstools.nxsdata.Servers(parser)[source]¶

Bases: Runner

Servers runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'get lists of tango data servers from the current tango host'¶: (str) command description

epilog = ' examples:\n nxsdata servers \n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

class nxstools.nxsdata.SetData(parser)[source]¶

Bases: Runner

SetData runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'assign global JSON data'¶: (str) command description

epilog = ' examples:\n nxsdata setdata ... \n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options
Returns:: output information
Return type:: str

nxstools.nxsdata.main()[source]¶: the main program function

nxstools.nxsdevicetools module¶

NDTS TANGO device tools

nxstools.nxsdevicetools.PYTANGO = True¶: (bool) True if tango available

class nxstools.nxsdevicetools.PackageHandler(packagename='nxstools.xmltemplates')[source]¶

Bases: object

xml templates package loader

constructor

Parameters:: packagename (str) – full package name

loadXMLTemplates(packagename)[source]¶

load xml template module variables

Parameters:: packagename (str) – full package name

nxstools.nxsdevicetools.checkServer(name='NXSConfigServer')[source]¶

provides server device name if only one or error in the other case

Parameters:: name (str) – server name
Returns:: server device name or empty string if error appears
Return type:: str

nxstools.nxsdevicetools.ctModules = ['mca8715roi', 'onedroi', 'sis3820', 'sis3302roi', 'xmcd', 'vfcadc', 'mythenroi', 'mhzdaqp01', 'dgg2', 'tangoattributectctrl']¶: (list <str>) counter/timer modules

nxstools.nxsdevicetools.findClassName(server, name)[source]¶

finds class name

Parameters:: name (str) – device name
Returns:: class name
Return type:: str

nxstools.nxsdevicetools.generateDeviceNames(prefix, first, last, minimal=False)[source]¶

generates device names

Parameters:

prefix (str) – device name prefix
first (int) – first device index
last (int) – last device index

Returns:

device names

Return type:

nxstools.nxsdevicetools.getAttributes(device, host=None, port=10000)[source]¶

provides a list of device attributes

Parameters:

device (str) – tango device name
host (str) – device host
port (int) – device port

Returns:

list of device attributes

Return type:

nxstools.nxsdevicetools.getClassName(devicename)[source]¶

provides device class name

Parameters:: devicename (str) – device name
Returns:: class name
Return type:: str

nxstools.nxsdevicetools.getDataSourceComponents(server, verbose=False)[source]¶

gets datasource components

Parameters:

server (str) – configuration server
verbose (bool) – additional printouts

Returns:

dictionary with datasource components

Return type:

dict <str, list <str>>

nxstools.nxsdevicetools.getServerTangoHost(server)[source]¶

fetches the server tango_host:tango_port

Parameters:: server (str) – tango server
Returns:: tango host
Return type:: str

nxstools.nxsdevicetools.getServers(name='NXSConfigServer')[source]¶

provides server device names

Parameters:: name (str) – server instance name
Returns:: list of the server device names
Return type:: list <str>

nxstools.nxsdevicetools.ioRegModules = ['sis3610']¶: (list <str>) IO register modules

nxstools.nxsdevicetools.listServers(server, name='NXSConfigServer')[source]¶

finds server names

Parameters:: name (str) – server instance name
Returns:: server list
Return type:: list <str>

nxstools.nxsdevicetools.moduleMultiAttributes = {'cobold': ['BinSize', 'ExposureTime'], 'dalsa': ['FileDir', 'FilePostfix', 'FilePrefix', 'FileSaving', 'FileStartNum', 'TriggerMode', 'Width', 'Height', 'ExtendedExposure', 'BinComment', 'FramesProcessed', 'Image16', 'Image8', 'ImageRaw', 'FramesReceived', 'FrameRate', 'FramesPerNXFile', 'NXFileCompression', 'TurboMode', 'ImageEnc', 'ViewingMode', 'ThrashedBuffers', 'FramesToAcquire', 'AcquisitionFrameCount', 'AcquisitionMode', 'AcquisitionFrameMode', 'LinearityEqualizer', 'NrExposedFrames', 'NrOffsetFrames', 'Offset', 'PixelFormat', 'ReadOutMode', 'Standby', 'SumScheme'], 'dalsavds': ['FileDir', 'FilePostfix', 'FilePrefix', 'FileSaving', 'FileStartNum', 'TriggerMode', 'Width', 'Height', 'ExtendedExposure', 'BinComment', 'FramesProcessed', 'Image16', 'Image8', 'ImageRaw', 'FramesReceived', 'FrameRate', 'FramesPerNXFile', 'NXFileCompression', 'TurboMode', 'ImageEnc', 'ViewingMode', 'ThrashedBuffers', 'FramesToAcquire', 'AcquisitionFrameCount', 'AcquisitionMode', 'AcquisitionFrameMode', 'LinearityEqualizer', 'NrExposedFrames', 'NrOffsetFrames', 'Offset', 'PixelFormat', 'ReadOutMode', 'Standby', 'SumScheme'], 'eiger1m16vds': ['TriggerMode', 'NbTriggers', 'Description', 'NbImages', 'BitDepth', 'ReadoutTime', 'CountTime', 'EnergyThreshold', 'FrameTime', 'RateCorrectionEnabled', 'FlatFieldEnabled', 'Temperature', 'AutoSummationEnabled', 'Humidity', 'PhotonEnergy', 'Wavelength'], 'eiger1m32vds': ['TriggerMode', 'NbTriggers', 'Description', 'NbImages', 'BitDepth', 'ReadoutTime', 'CountTime', 'EnergyThreshold', 'FrameTime', 'RateCorrectionEnabled', 'FlatFieldEnabled', 'Temperature', 'AutoSummationEnabled', 'Humidity', 'PhotonEnergy', 'Wavelength'], 'eiger4m16vds': ['TriggerMode', 'NbTriggers', 'Description', 'NbImages', 'BitDepth', 'ReadoutTime', 'CountTime', 'EnergyThreshold', 'FrameTime', 'RateCorrectionEnabled', 'FlatFieldEnabled', 'Temperature', 'AutoSummationEnabled', 'Humidity', 'PhotonEnergy', 'Wavelength'], 'eiger4m32vds': ['TriggerMode', 'NbTriggers', 'Description', 'NbImages', 'BitDepth', 'ReadoutTime', 'CountTime', 'EnergyThreshold', 'FrameTime', 'RateCorrectionEnabled', 'FlatFieldEnabled', 'Temperature', 'AutoSummationEnabled', 'Humidity', 'PhotonEnergy', 'Wavelength'], 'eiger9m16vds': ['TriggerMode', 'NbTriggers', 'Description', 'NbImages', 'BitDepth', 'ReadoutTime', 'CountTime', 'EnergyThreshold', 'FrameTime', 'RateCorrectionEnabled', 'FlatFieldEnabled', 'Temperature', 'AutoSummationEnabled', 'Humidity', 'PhotonEnergy', 'Wavelength'], 'eiger9m32vds': ['TriggerMode', 'NbTriggers', 'Description', 'NbImages', 'BitDepth', 'ReadoutTime', 'CountTime', 'EnergyThreshold', 'FrameTime', 'RateCorrectionEnabled', 'FlatFieldEnabled', 'Temperature', 'AutoSummationEnabled', 'Humidity', 'PhotonEnergy', 'Wavelength'], 'eigerdectris': ['TriggerMode', 'NbTriggers', 'Description', 'NbImages', 'BitDepth', 'ReadoutTime', 'CountTime', 'EnergyThreshold', 'FrameTime', 'RateCorrectionEnabled', 'FlatFieldEnabled', 'Temperature', 'AutoSummationEnabled', 'Humidity', 'PhotonEnergy', 'Wavelength'], 'eigerdectrismesh': ['TriggerMode', 'NbTriggers', 'Description', 'NbImages', 'BitDepth', 'ReadoutTime', 'CountTime', 'EnergyThreshold', 'FrameTime', 'RateCorrectionEnabled', 'FlatFieldEnabled', 'Temperature', 'AutoSummationEnabled', 'Humidity', 'PhotonEnergy', 'Wavelength'], 'lambda': ['TriggerMode', 'ShutterTime', 'DelayTime', 'FrameNumbers', 'ThreadNo', 'EnergyThreshold', 'OperatingMode', 'ConfigFilePath', 'SaveAllImages', 'FilePrefix', 'FileStartNum', 'FilePreExt', 'FilePostfix', 'SaveFilePath', 'SaveFileName', 'LatestImageNumber', 'LiveMode', 'TotalLossFrames', 'CompressorShuffle', 'CompressionRate', 'CompressionEnabled', 'Layout', 'ShutterTimeMax', 'ShutterTimeMin', 'Width', 'Height', 'Depth', 'LiveFrameNo', 'DistortionCorrection', 'LiveLastImageData', 'FramesPerFile', 'OpMode', 'Translations'], 'lambda2m': ['TriggerMode', 'ShutterTime', 'DelayTime', 'FrameNumbers', 'ThreadNo', 'EnergyThreshold', 'OperatingMode', 'ConfigFilePath', 'SaveAllImages', 'FilePrefix', 'FileStartNum', 'FilePreExt', 'FilePostfix', 'SaveFilePath', 'SaveFileName', 'LatestImageNumber', 'LiveMode', 'TotalLossFrames', 'CompressorShuffle', 'CompressionRate', 'CompressionEnabled', 'Layout', 'ShutterTimeMax', 'ShutterTimeMin', 'Width', 'Height', 'Depth', 'LiveFrameNo', 'DistortionCorrection', 'LiveLastImageData', 'OpMode', 'Translations'], 'lambdavds': ['TriggerMode', 'ShutterTime', 'DelayTime', 'FrameNumbers', 'ThreadNo', 'EnergyThreshold', 'OperatingMode', 'ConfigFilePath', 'SaveAllImages', 'FilePrefix', 'FileStartNum', 'FilePreExt', 'FilePostfix', 'SaveFilePath', 'SaveFileName', 'LatestImageNumber', 'LiveMode', 'TotalLossFrames', 'CompressorShuffle', 'CompressionRate', 'CompressionEnabled', 'Layout', 'ShutterTimeMax', 'ShutterTimeMin', 'Width', 'Height', 'Depth', 'LiveFrameNo', 'DistortionCorrection', 'LiveLastImageData', 'FramesPerFile', 'OpMode', 'Translations'], 'lambdavdsnm': ['TriggerMode', 'ShutterTime', 'DelayTime', 'FrameNumbers', 'ThreadNo', 'EnergyThreshold', 'OperatingMode', 'ConfigFilePath', 'SaveAllImages', 'FilePrefix', 'FileStartNum', 'FilePreExt', 'FilePostfix', 'SaveFilePath', 'SaveFileName', 'LatestImageNumber', 'LiveMode', 'TotalLossFrames', 'CompressorShuffle', 'CompressionRate', 'CompressionEnabled', 'Layout', 'ShutterTimeMax', 'ShutterTimeMin', 'Width', 'Height', 'Depth', 'LiveFrameNo', 'DistortionCorrection', 'LiveLastImageData', 'FramesPerFile', 'OpMode', 'Translations'], 'limaccd': ['camera_type', 'camera_pixelsize', 'camera_model', 'acq_mode', 'acq_nb_frames', 'acq_trigger_mode', 'last_image_saved', 'latency_time', 'acc_max_expo_time', 'acc_expo_time', 'acc_time_mode', 'acc_dead_time', 'acc_live_time', 'saving_mode', 'saving_directory', 'saving_prefix', 'saving_suffix', 'saving_next_number', 'saving_format', 'saving_frame_per_file', 'image_type', 'image_width', 'image_height', 'image_sizes', 'image_roi', 'image_bin', 'image_flip', 'image_rotation', 'shutter_mode', 'shutter_open_time'], 'limaccds': ['camera_type', 'camera_pixelsize', 'camera_model', 'acq_mode', 'acq_nb_frames', 'acq_trigger_mode', 'last_image_saved', 'latency_time', 'acc_max_expo_time', 'acc_expo_time', 'acc_time_mode', 'acc_dead_time', 'acc_live_time', 'saving_mode', 'saving_directory', 'saving_prefix', 'saving_suffix', 'saving_next_number', 'saving_format', 'saving_frame_per_file', 'image_type', 'image_width', 'image_height', 'image_sizes', 'image_roi', 'image_bin', 'image_flip', 'image_rotation', 'shutter_mode', 'shutter_open_time'], 'maiadimension': ['Name', 'PositionSource', 'PixelPitch', 'PixelOrigin', 'PixelHysteresis', 'PositionUnit', 'PixelCoordExtent'], 'maiaflux': ['FluxCoeff', 'FluxName', 'FluxUnit', 'FluxSource'], 'maiainterlock': ['BiasPeltierInterlock', 'BiasPeltierInterlockUptime', 'Pressure'], 'maialogger': ['RunNumber'], 'maiaprocessing': ['GaintrimEnable', 'LineariseEnable', 'PhotonEnable', 'PileupRejectEnable', 'PixelEnable', 'ThrottleEnable'], 'maiasensor': ['BiasVoltage', 'LeakageCurrent', 'PeltierCurrent', 'WaterTemperature', 'DetectorTemperature', 'MosfetTemperature', 'Identity'], 'marccd': ['FrameShift', 'SavingDirectory', 'SavingPostfix', 'SavingPrefix'], 'mca_xia': ['ICR', 'OCR'], 'mca_xia@pool': ['CountsRoI', 'RoIEnd', 'RoIStart'], 'mythen': ['Counts1', 'Counts2', 'CountsMax', 'CountsTotal', 'ExposureTime', 'FileDir', 'FileIndex', 'FilePrefix', 'Data', 'RoI1', 'RoI2'], 'mythen2': ['Counts1', 'Counts2', 'CountsMax', 'CountsTotal', 'ExposureTime', 'FileDir', 'FileIndex', 'FilePrefix', 'Data', 'Energy', 'NbFrames', 'RoI1End', 'RoI2End', 'RoI1Start', 'RoI2Start', 'Threshold'], 'pco': ['DelayTime', 'ExposureTime', 'NbFrames', 'TriggerMode', 'FileDir', 'FilePostfix', 'FilePrefix', 'FileStartNum', 'Binning_x', 'Binning_y', 'ROI_x_min', 'ROI_x_max', 'ROI_y_min', 'ROI_y_max', 'Pixelrate', 'ADCs', 'CoolingTemp', 'CoolingTempSet', 'ImageTimeStamp', 'RecorderMode'], 'pco4000': ['DelayTime', 'ExposureTime', 'NbFrames', 'TriggerMode', 'FileDir', 'FilePostfix', 'FilePrefix', 'FileStartNum', 'Binning_x', 'Binning_y', 'ROI_x_min', 'ROI_x_max', 'ROI_y_min', 'ROI_y_max', 'Pixelrate', 'ADCs', 'CoolingTemp', 'CoolingTempSet', 'ImageTimeStamp', 'RecorderMode'], 'pcoedge': ['DelayTime', 'ExposureTime', 'NbFrames', 'TriggerMode', 'FileDir', 'FilePostfix', 'FilePrefix', 'FileStartNum', 'Binning_x', 'Binning_y', 'ROI_x_min', 'ROI_x_max', 'ROI_y_min', 'ROI_y_max', 'Pixelrate', 'ADCs', 'CoolingTemp', 'CoolingTempSet', 'ImageTimeStamp', 'RecorderMode'], 'pedetector': ['BinningMode', 'FileIndex', 'ExposureTime', 'SkippedAtStart', 'SummedSaveImages', 'SkippedBetweenSaved', 'FilesAfterTrigger', 'FilesBeforeTrigger', 'SummedDarkImages', 'OutputDirectory', 'FilePattern', 'FileName', 'LogFile', 'UserComment1', 'CameraGain', 'UserComment2', 'UserComment3', 'UserComment4', 'SaveRawImages', 'SaveDarkImages', 'PerformIntegration', 'SaveIntegratedData', 'SaveSubtracted', 'PerformDarkSubtraction'], 'perkinelmer': ['BinningMode', 'FileIndex', 'ExposureTime', 'SkippedAtStart', 'SummedSaveImages', 'SkippedBetweenSaved', 'FilesAfterTrigger', 'FilesBeforeTrigger', 'SummedDarkImages', 'OutputDirectory', 'FilePattern', 'FileName', 'LogFile', 'UserComment1', 'CameraGain', 'UserComment2', 'UserComment3', 'UserComment4', 'SaveRawImages', 'SaveDarkImages', 'PerformIntegration', 'SaveIntegratedData', 'SaveSubtracted', 'PerformDarkSubtraction'], 'perkinelmerdetector': ['BinningMode', 'FileIndex', 'ExposureTime', 'SkippedAtStart', 'SummedSaveImages', 'SkippedBetweenSaved', 'FilesAfterTrigger', 'FilesBeforeTrigger', 'SummedDarkImages', 'OutputDirectory', 'FilePattern', 'FileName', 'LogFile', 'UserComment1', 'CameraGain', 'UserComment2', 'UserComment3', 'UserComment4', 'SaveRawImages', 'SaveDarkImages', 'PerformIntegration', 'SaveIntegratedData', 'SaveSubtracted', 'PerformDarkSubtraction'], 'pilatus': ['DelayTime', 'ExposurePeriod', 'ExposureTime', 'FileDir', 'FilePostfix', 'FilePrefix', 'FileStartNum', 'LastImageTaken', 'NbExposures', 'NbFrames', 'MXparameters'], 'pilatus100k': ['DelayTime', 'ExposurePeriod', 'ExposureTime', 'FileDir', 'FilePostfix', 'FilePrefix', 'FileStartNum', 'LastImageTaken', 'NbExposures', 'NbFrames', 'MXparameters'], 'pilatus1m': ['DelayTime', 'ExposurePeriod', 'ExposureTime', 'FileDir', 'FilePostfix', 'FilePrefix', 'FileStartNum', 'LastImageTaken', 'NbExposures', 'NbFrames', 'MXparameters'], 'pilatus2m': ['DelayTime', 'ExposurePeriod', 'ExposureTime', 'FileDir', 'FilePostfix', 'FilePrefix', 'FileStartNum', 'LastImageTaken', 'NbExposures', 'NbFrames', 'MXparameters'], 'pilatus300k': ['DelayTime', 'ExposurePeriod', 'ExposureTime', 'FileDir', 'FilePostfix', 'FilePrefix', 'FileStartNum', 'LastImageTaken', 'NbExposures', 'NbFrames', 'MXparameters'], 'pilatus6m': ['DelayTime', 'ExposurePeriod', 'ExposureTime', 'FileDir', 'FilePostfix', 'FilePrefix', 'FileStartNum', 'LastImageTaken', 'NbExposures', 'NbFrames', 'MXparameters'], 'pilc': ['PositionTriggerStart', 'PositionTriggerStepSize', 'PositionTriggerStop', 'NbTriggers', 'TriggerPulseLength', 'Arm', 'TriggerMode', 'TimeTriggerStart', 'TimeTriggerStepSize', 'FilePrefix', 'FileDir', 'FileName', 'TriggerCounter', 'EncoderTrigger', 'RemainingTriggers', 'EncoderTriggering', 'BufferLoad', 'Position1Conversion', 'Position2Conversion', 'Position3Conversion', 'Position4Conversion', 'Position5Conversion', 'CurrentPosition1', 'CurrentPosition2', 'CurrentPosition3', 'CurrentPosition4', 'CurrentPosition5', 'MaskDataToWrite', 'Metadata1', 'Metadata2', 'Metadata3', 'Metadata4', 'Metadata5', 'TriggersPerFile', 'SoftwareInhibit', 'HardwareInhibit', 'CounterConfig'], 'pilctimeid': ['PositionTriggerStart', 'PositionTriggerStepSize', 'PositionTriggerStop', 'NbTriggers', 'TriggerPulseLength', 'Arm', 'TriggerMode', 'TimeTriggerStart', 'TimeTriggerStepSize', 'FilePrefix', 'FileDir', 'FileName', 'TriggerCounter', 'EncoderTrigger', 'RemainingTriggers', 'EncoderTriggering', 'BufferLoad', 'Position1Conversion', 'Position2Conversion', 'Position3Conversion', 'Position4Conversion', 'Position5Conversion', 'CurrentPosition1', 'CurrentPosition2', 'CurrentPosition3', 'CurrentPosition4', 'CurrentPosition5', 'MaskDataToWrite', 'Metadata1', 'Metadata2', 'Metadata3', 'Metadata4', 'Metadata5', 'TriggersPerFile', 'SoftwareInhibit', 'HardwareInhibit', 'CounterConfig'], 'tangovimba': ['Width', 'WidthMax', 'TriggerSource', 'PixelFormat', 'OffsetY', 'OffsetX', 'HeightMax', 'Height', 'GainRaw', 'ExposureTimeAbs', 'AcquisitionFrameRateAbs', 'AcquisitionFrameRateLimit', 'StreamBytesPerSecond', 'BinComment', 'FileDir', 'FilePostfix', 'FilePrefix', 'FileSaving', 'FileStartNum', 'FramesProcessed', 'Image16', 'Image8', 'ImageRaw', 'MaxLoad', 'ReadMode', 'TuneMode', 'ViewingMode']}¶: (dict <str , list <str> >) important attributes of modules

nxstools.nxsdevicetools.moduleTemplateFiles = {'cobold': ['cobold.xml'], 'dalsa': ['dalsa.xml', 'dalsa_nxdata.ds.xml', 'dalsa_external_data.ds.xml'], 'dalsavds': ['dalsavds.xml', 'dalsavds_nxdata.ds.xml', 'dalsavds_triggermode_cb.ds.xml', 'dalsavds_filestartnum_cb.ds.xml', 'dalsavds_nrexposedframes_cb.ds.xml'], 'eiger1m16vds': ['eiger1m16vds.xml', 'eiger1m16vds_stepindex.ds.xml', 'eiger1m16vds_nbimages_cb.ds.xml', 'eiger1m16vds_description_cb.ds.xml', 'eiger1m16vds_triggermode_cb.ds.xml'], 'eiger1m32vds': ['eiger1m32vds.xml', 'eiger1m32vds_stepindex.ds.xml', 'eiger1m32vds_nbimages_cb.ds.xml', 'eiger1m32vds_description_cb.ds.xml', 'eiger1m32vds_triggermode_cb.ds.xml'], 'eiger4m16vds': ['eiger4m16vds.xml', 'eiger4m16vds_stepindex.ds.xml', 'eiger4m16vds_nbimages_cb.ds.xml', 'eiger4m16vds_description_cb.ds.xml', 'eiger4m16vds_triggermode_cb.ds.xml'], 'eiger4m32vds': ['eiger4m32vds.xml', 'eiger4m32vds_stepindex.ds.xml', 'eiger4m32vds_nbimages_cb.ds.xml', 'eiger4m32vds_description_cb.ds.xml', 'eiger4m32vds_triggermode_cb.ds.xml'], 'eiger9m16vds': ['eiger9m16vds.xml', 'eiger9m16vds_stepindex.ds.xml', 'eiger9m16vds_nbimages_cb.ds.xml', 'eiger9m16vds_description_cb.ds.xml', 'eiger9m16vds_triggermode_cb.ds.xml'], 'eiger9m32vds': ['eiger9m32vds.xml', 'eiger9m32vds_stepindex.ds.xml', 'eiger9m32vds_nbimages_cb.ds.xml', 'eiger9m32vds_description_cb.ds.xml', 'eiger9m32vds_triggermode_cb.ds.xml'], 'eigerdectris': ['eigerdectris.xml', 'eigerdectris_stepindex.ds.xml', 'eigerdectris_nbimages_cb.ds.xml', 'eigerdectris_description_cb.ds.xml', 'eigerdectris_triggermode_cb.ds.xml'], 'eigerdectrismesh': ['eigerdectrismesh.xml', 'eigerdectrismesh_stepindex.ds.xml', 'eigerdectrismesh_nbimages_cb.ds.xml', 'eigerdectrismesh_description_cb.ds.xml', 'eigerdectrismesh_triggermode_cb.ds.xml'], 'lambda': ['lambda.xml', 'lambda_nxdata.ds.xml', 'lambda_external_data.ds.xml'], 'lambda2m': ['lambda2m.xml', 'lambda2m_m1_nxdata.ds.xml', 'lambda2m_m2_nxdata.ds.xml', 'lambda2m_m3_nxdata.ds.xml', 'lambda2m_m1_external_data.ds.xml', 'lambda2m_m2_external_data.ds.xml', 'lambda2m_m3_external_data.ds.xml'], 'lambdavds': ['lambdavds.xml', 'lambdavds_nxdata.ds.xml', 'lambdavds_description.ds.xml', 'lambdavds_triggermode_cb.ds.xml', 'lambdavds_framenumbers_cb.ds.xml', 'lambdavds_savefilename_cb.ds.xml'], 'lambdavdsnm': ['lambdavdsnm.xml', 'lambdavdsnm_triggermode_cb.ds.xml', 'lambdavdsnm_nxdata.ds.xml'], 'limaccd': ['limaccd.xml', 'limaccd_postrun.ds.xml', 'limaccd_xpixelsize.ds.xml', 'limaccd_ypixelsize.ds.xml', 'limaccd_description.ds.xml', 'limaccd_filestartnum_cb.ds.xml'], 'limaccds': ['limaccd.xml', 'limaccd_postrun.ds.xml', 'limaccd_xpixelsize.ds.xml', 'limaccd_ypixelsize.ds.xml', 'limaccd_description.ds.xml', 'limaccd_filestartnum_cb.ds.xml'], 'marccd': ['marccd.xml', 'marccd_postrun.ds.xml'], 'mca_xia': ['mcaxia.xml'], 'mythen': ['mythen.xml', 'mythen_postrun.ds.xml', 'mythen_filestartnumber.ds.xml'], 'mythen2': ['mythen2.xml'], 'pco': ['pco.xml', 'pco_postrun.ds.xml', 'pco_description.ds.xml', 'pco_filestartnum_cb.ds.xml'], 'pco4000': ['pco.xml', 'pco_postrun.ds.xml', 'pco_description.ds.xml', 'pco_filestartnum_cb.ds.xml'], 'pcoedge': ['pco.xml', 'pco_postrun.ds.xml', 'pco_description.ds.xml', 'pco_filestartnum_cb.ds.xml'], 'pedetector': ['perkinelmerdetector.xml', 'perkinelmerdetector_postrun.ds.xml', 'perkinelmerdetector_description.ds.xml', 'perkinelmerdetector_fileindex_cb.ds.xml'], 'perkinelmer': ['perkinelmerdetector.xml', 'perkinelmerdetector_postrun.ds.xml', 'perkinelmerdetector_description.ds.xml', 'perkinelmerdetector_fileindex_cb.ds.xml'], 'perkinelmerdetector': ['perkinelmerdetector.xml', 'perkinelmerdetector_postrun.ds.xml', 'perkinelmerdetector_description.ds.xml', 'perkinelmerdetector_fileindex_cb.ds.xml'], 'pilatus': ['pilatus.xml', 'pilatus_postrun.ds.xml', 'pilatus_description.ds.xml', 'pilatus_mxparameters_cb.ds.xml', 'pilatus_filestartnum_cb.ds.xml'], 'pilatus100k': ['pilatus.xml', 'pilatus_postrun.ds.xml', 'pilatus100k_description.ds.xml', 'pilatus_mxparameters_cb.ds.xml', 'pilatus_filestartnum_cb.ds.xml'], 'pilatus1m': ['pilatus.xml', 'pilatus_postrun.ds.xml', 'pilatus1m_description.ds.xml', 'pilatus_mxparameters_cb.ds.xml', 'pilatus_filestartnum_cb.ds.xml'], 'pilatus2m': ['pilatus.xml', 'pilatus_postrun.ds.xml', 'pilatus6m_description.ds.xml', 'pilatus_mxparameters_cb.ds.xml', 'pilatus_filestartnum_cb.ds.xml'], 'pilatus300k': ['pilatus.xml', 'pilatus_postrun.ds.xml', 'pilatus300k_description.ds.xml', 'pilatus_mxparameters_cb.ds.xml', 'pilatus_filestartnum_cb.ds.xml'], 'pilatus6m': ['pilatus.xml', 'pilatus_postrun.ds.xml', 'pilatus_mxparameters_cb.ds.xml', 'pilatus6m_description.ds.xml', 'pilatus_filestartnum_cb.ds.xml'], 'pilc': ['pilc.xml', 'pilc_triggermode_cb.ds.xml'], 'pilctimeid': ['pilctimeid.xml', 'pilctimeid_triggermode_cb.ds.xml'], 'tangovimba': ['tangovimba.xml', 'tangovimba_nxdata.ds.xml', 'tangovimba_external_data.ds.xml']}¶: (dict <str , list <str> >) xml template files of modules

nxstools.nxsdevicetools.motorModules = ['absbox', 'motor_tango', 'kohzu', 'smchydra', 'lom', 'oms58', 'e6c', 'omsmaxv', 'spk', 'pie710', 'pie712', 'e6c_p09_eh2', 'smaract']¶: (list <str>) modules of motors

nxstools.nxsdevicetools.oneDModules = ['mca_xia']¶: (list <str>) modules of 1D detectors

nxstools.nxsdevicetools.openServer(device)[source]¶

opens connection to the configuration server

Parameters:: configuration (str) – server device name
Returns:: configuration server proxy
Return type:: tango.DeviceProxy

nxstools.nxsdevicetools.standardComponentTemplateFiles = {'absorber': ['absorber_foil.ds.xml', 'absorber_thickness.ds.xml', 'absorber.xml'], 'beamstop': ['beamstop.xml'], 'beamtimefname': ['beamtimefname.xml', 'beamtimefname.ds.xml', 'start_time.ds.xml'], 'beamtimeid': ['beamtimeid.xml', 'beamtimeid.ds.xml', 'start_time.ds.xml'], 'chcut': ['chcut.xml', 'chcut_unitcalibration.ds.xml', 'chcut_crystal.ds.xml'], 'coboldhisto': ['coboldhisto.xml', 'coboldhisto_timeofflight.ds.xml'], 'collect2': ['collect2.xml'], 'collect3': ['collect3.xml'], 'collect4': ['collect4.xml'], 'collect5': ['collect5.xml'], 'collect6': ['collect6.xml'], 'common2': ['common2_common.ds.xml'], 'common3': ['common3_common.ds.xml'], 'dataaxessignal': ['dataaxessignal.xml', 'defaultsignal.ds.xml', 'defaultaxes.ds.xml', 'signal_name.ds.xml', 'signalname.ds.xml', 'sardanaenvironment.ds.xml'], 'datasignal': ['datasignal.xml', 'defaultsignal.ds.xml', 'signal_name.ds.xml', 'signalname.ds.xml', 'signal_axes.ds.xml', 'sardanaenvironment.ds.xml'], 'dcm': ['dcm.xml', 'dcm_reflection.ds.xml', 'dcm_unitcalibration.ds.xml', 'dcm_crystal.ds.xml'], 'default': ['default.xml', 'defaultsample.xml', 'defaultinstrument.xml', 'sample_name.ds.xml', 'chemical_formula.ds.xml', 'beamtime_id.ds.xml', 'beamtime_filename.ds.xml', 'start_time.ds.xml', 'end_time.ds.xml', 'nexdatas_version.ds.xml', 'nexdatas_configuration.ds.xml', 'title.ds.xml'], 'defaultinstrument': ['defaultinstrument.xml', 'beamtime_id.ds.xml', 'beamtime_filename.ds.xml', 'start_time.ds.xml', 'end_time.ds.xml', 'nexdatas_version.ds.xml', 'nexdatas_configuration.ds.xml', 'title.ds.xml'], 'defaultsample': ['defaultsample.xml', 'sample_name.ds.xml', 'chemical_formula.ds.xml'], 'description': ['description.xml', 'experiment_description.ds.xml'], 'descriptiontext': ['descriptiontext.xml'], 'detectorlive': ['detectorlive.xml'], 'empty': ['empty.xml'], 'groupsecop': ['groupsecop.ds.xml', 'groupsecop_time.ds.xml', 'client_start_time.ds.xml', 'sample_env_links.ds.xml', 'sample_log_links.ds.xml'], 'keithley': ['keithley.xml'], 'maia': ['maia.xml', 'empty.xml'], 'maiadimension': ['maiadimension.xml'], 'maiaflux': ['maiaflux.xml'], 'msnsar': ['msnsar_env.ds.xml', 'sardanaenvironment.ds.xml'], 'mssar': ['mssar_env.ds.xml', 'sardanaenvironment.ds.xml'], 'parametercopymap': ['parametercopymap.xml'], 'pinhole': ['pinhole.xml'], 'pointdet': ['pointdet.xml'], 'qbpm': ['qbpm_foil.ds.xml', 'qbpm.xml'], 'sampledescription': ['sampledescription.xml', 'sample_description.ds.xml'], 'sampledescriptiontext': ['sampledescriptiontext.xml'], 'samplehkl': ['samplehkl.xml'], 'secop': ['secop.ds.xml', 'secop_time.ds.xml', 'client_start_time.ds.xml', 'sample_env_links.ds.xml', 'sample_log_links.ds.xml'], 'secoplinks': ['sample_env_links.ds.xml', 'sample_log_links.ds.xml', 'sample_nxdata.ds.xml', 'sampleenv_nxdata.ds.xml'], 'singlesecop': ['singlesecop.ds.xml', 'singlesecop_time.ds.xml', 'client_start_time.ds.xml', 'sample_env_links.ds.xml', 'sample_log_links.ds.xml'], 'slit': ['slit.xml'], 'source': ['source.xml'], 'starttime': ['starttime.xml', 'starttime.ds.xml', 'start_timestamp.ds.xml', 'client_start_time.ds.xml'], 'tango': ['tango.ds.xml'], 'undulator': ['undulator.xml']}¶: (dict <str , list <str> >) xml template files of modules

nxstools.nxsdevicetools.standardComponentVariables = {'absorber': {'attenfactor': {'default': None, 'doc': 'attenuation factor (datasource)'}, 'dependstop': {'default': None, 'doc': 'the first transformation, e.g. distance (string)'}, 'distance': {'default': None, 'doc': 'distance for the sample in m, e.g. 0 (string)'}, 'distancename': {'default': 'distance', 'doc': 'distance name for the sample in m, e.g. 0 (string)'}, 'distanceoffset': {'default': None, 'doc': '3-vector distance offset in m, e.g. sample-source offset if the distance is taken from the source (string)'}, 'foil': {'default': None, 'doc': 'foil type, i.e. standard <cpname>_foil (datasource)'}, 'foillist': {'default': '["Ag", "Ag", "Ag", "Ag", "", "Al", "Al", "Al", "Al"]', 'doc': 'foil_type position json dictionary (string)'}, 'position': {'default': None, 'doc': 'which sliders are in [bitarray] MANDATORY (datasource)'}, 'thickness': {'default': None, 'doc': 'foil thickness, i.e. standard <cpname>_thickness (datasource)'}, 'thicknesslist': {'default': '[0.5, 0.05, 0.025, 0.0125, 0, 0.1, 0.3, 0.5, 1.0]', 'doc': 'foil_type position json dictionary (string)'}, 'transformations': {'default': None, 'doc': "transformations group name i.e. 'transformations'. If it is not set it is not created (string)"}, 'y': {'default': None, 'doc': 'vertical position (datasource)'}, 'yname': {'default': 'y', 'doc': 'vertical position name (string)'}}, 'beamstop': {'description': {'default': 'circular', 'doc': ' circular or rectangular (string)'}, 'x': {'default': None, 'doc': 'horizontal position (datasource)'}, 'xname': {'default': 'x', 'doc': 'horizontal position name (string)'}, 'xsign': {'default': '', 'doc': "horizontal position sign, e.g. '-' (string)"}, 'y': {'default': None, 'doc': 'vertical position (datasource)'}, 'yname': {'default': 'y', 'doc': 'vertical position name (string)'}, 'z': {'default': None, 'doc': 'vertical position (datasource)'}, 'zname': {'default': 'z', 'doc': 'along the beam position name (string)'}}, 'beamtimefname': {'commissiondir': {'default': '/gpfs/commissioning', 'doc': 'commission file directory (string)'}, 'commissionpostfix': {'default': '.json', 'doc': 'commission file postfix (string)'}, 'commissionprefix': {'default': 'commissioning-metadata-', 'doc': 'commission file prefix (string)'}, 'currentdir': {'default': '/gpfs/current', 'doc': 'beamtime file directory (string)'}, 'currentpostfix': {'default': '.json', 'doc': 'beamtime file postfix (string)'}, 'currentprefix': {'default': 'beamtime-metadata-', 'doc': 'beamtime file prefix (string)'}, 'localdir': {'default': '/gpfs/local', 'doc': 'local file directory (string)'}, 'shortname': {'default': 'P09', 'doc': 'beamline short name (string)'}}, 'beamtimeid': {'commissiondir': {'default': '/gpfs/commissioning', 'doc': 'commission file directory (string)'}, 'commissionpostfix': {'default': '.json', 'doc': 'commission file postfix (string)'}, 'commissionprefix': {'default': 'commissioning-metadata-', 'doc': 'commission file prefix (string)'}, 'currentdir': {'default': '/gpfs/current', 'doc': 'beamtime file directory (string)'}, 'currentpostfix': {'default': '.json', 'doc': 'beamtime file postfix (string)'}, 'currentprefix': {'default': 'beamtime-metadata-', 'doc': 'beamtime file prefix (string)'}, 'localdir': {'default': '/gpfs/local', 'doc': 'local file directory (string)'}, 'shortname': {'default': 'P09', 'doc': 'beamline short name (string)'}}, 'chcut': {'braggangle': {'default': None, 'doc': 'bragg angle (datasource)'}, 'bragganglename': {'default': 'bragg', 'doc': 'bragg angle name (string)'}, 'chcutdevice': {'default': None, 'doc': 'FMBOxfDCMEnergy tango device name (string)'}, 'crystal': {'default': None, 'doc': ' type of crystal i.e. 0->Si111,1->Si311,2->Si111 ChannelCut (datasource)'}, 'energy': {'default': None, 'doc': 'synchronized monochromator energy (datasource)'}, 'energyfmb': {'default': None, 'doc': 'monochromator energy (datasource)'}, 'jack1': {'default': None, 'doc': 'first vertical jack of table (datasource)'}, 'jack1name': {'default': 'jack1', 'doc': 'first vertical jack name of table (string)'}, 'jack2': {'default': None, 'doc': 'second vertical jack of table (datasource)'}, 'jack2name': {'default': 'jack2', 'doc': 'second vertical jack name of table (string)'}, 'jack3': {'default': None, 'doc': 'third vertical jack of table (datasource)'}, 'jack3name': {'default': 'jack3', 'doc': 'third vertical jack name of table (string)'}, 'lat': {'default': None, 'doc': 'horizontal lattice translation of the first cristal (datasource)'}, 'latname': {'default': 'lat', 'doc': 'horizontal lattice translation name of the first cristal (string)'}, 'oxfordhorizontal': {'default': None, 'doc': ' horizontal translation (datasource)'}, 'para': {'default': None, 'doc': 'distance between the crystals (string)'}, 'paraname': {'default': 'para', 'doc': 'beam parallel translation name of the second cristal (string)'}, 'reflection': {'default': None, 'doc': 'reflection from string (datasource)'}, 'table': {'default': None, 'doc': 'vertical position of table (datasource)'}, 'tablename': {'default': 'table', 'doc': 'vertical position name of table (string)'}, 'theta': {'default': None, 'doc': 'theta angle (datasource)'}, 'thetaname': {'default': 'theta', 'doc': 'theta angle name (string)'}, 'unitcalibration': {'default': None, 'doc': ' unit calibration from dcmmotor (datasource)'}, 'usage': {'default': 'Bragg', 'doc': 'the crystall usage, e.g. Laue (string)'}, 'yaw': {'default': None, 'doc': 'phi rotation of the first cristal (datasource)'}, 'yawname': {'default': 'phi', 'doc': 'phi rotation name of the first cristal (string)'}}, 'coboldhisto': {'binsize': {'default': None, 'doc': 'bin size of histogram data (datasource)'}, 'exposuretime': {'default': None, 'doc': 'exposure time for histogram data (datasource)'}, 'histogram': {'default': None, 'doc': 'histogram data (datasource)'}}, 'collect2': {'first': {'default': None, 'doc': 'name of the first component to collect MANDATORY (datasource)'}, 'second': {'default': None, 'doc': 'name of the second component to collect MANDATORY (datasource)'}}, 'collect3': {'first': {'default': None, 'doc': 'name of the first component to collect MANDATORY (datasource)'}, 'second': {'default': None, 'doc': 'name of the second component to collect MANDATORY (datasource)'}, 'third': {'default': None, 'doc': 'name of the third component to collect MANDATORY (datasource)'}}, 'collect4': {'first': {'default': None, 'doc': 'name of the first component to collect MANDATORY (datasource)'}, 'fourth': {'default': None, 'doc': 'name of the fourth component to collect MANDATORY (datasource)'}, 'second': {'default': None, 'doc': 'name of the second component to collect MANDATORY (datasource)'}, 'third': {'default': None, 'doc': 'name of the third component to collect MANDATORY (datasource)'}}, 'collect5': {'fifth': {'default': None, 'doc': 'name of the fifth component to collect MANDATORY (datasource)'}, 'first': {'default': None, 'doc': 'name of the first component to collect MANDATORY (datasource)'}, 'fourth': {'default': None, 'doc': 'name of the fourth component to collect MANDATORY (datasource)'}, 'second': {'default': None, 'doc': 'name of the second component to collect MANDATORY (datasource)'}, 'third': {'default': None, 'doc': 'name of the third component to collect MANDATORY (datasource)'}}, 'collect6': {'fifth': {'default': None, 'doc': 'name of the fifth component to collect MANDATORY (datasource)'}, 'first': {'default': None, 'doc': 'name of the first component to collect MANDATORY (datasource)'}, 'fourth': {'default': None, 'doc': 'name of the fourth component to collect MANDATORY (datasource)'}, 'second': {'default': None, 'doc': 'name of the second component to collect MANDATORY (datasource)'}, 'sixth': {'default': None, 'doc': 'name of the sixth component to collect MANDATORY (datasource)'}, 'third': {'default': None, 'doc': 'name of the third component to collect MANDATORY (datasource)'}}, 'common2': {'dds': {'default': None, 'doc': 'default read datasource name MANDATORY (datasource)'}, 'ods': {'default': None, 'doc': 'optional detasource name MANDATORY (datasource)'}}, 'common3': {'dds': {'default': None, 'doc': 'default read datasource name MANDATORY (datasource)'}, 'ods1': {'default': None, 'doc': 'fist optional detasource name MANDATORY (datasource)'}, 'ods2': {'default': None, 'doc': 'second optional detasource name MANDATORY (datasource)'}}, 'dataaxessignal': {'__tangohost__': {'default': 'localhost', 'doc': 'tango host (string)'}, '__tangoport__': {'default': '10000', 'doc': 'tango port (string)'}, 'axes': {'default': 'defaultaxes', 'doc': 'list of data axes field names (datasource)'}, 'defaultattrs': {'default': 'False', 'doc': 'add default attributes (string)'}, 'msenv': {'default': None, 'doc': 'sardana environment (datasource)'}, 'mssardanadevice': {'default': None, 'doc': 'macroserver sardana device name MANDATORY (string)'}, 'nchannelstoskip': {'default': '0', 'doc': 'number of mg channels to skip (string)'}, 'sardanasignal': {'default': 'SignalCounter', 'doc': 'signal sardana variable name (string)'}, 'signal': {'default': 'defaultsignal', 'doc': 'data signal field name (datasource)'}}, 'datasignal': {'__tangohost__': {'default': 'localhost', 'doc': 'tango host (string)'}, '__tangoport__': {'default': '10000', 'doc': 'tango port (string)'}, 'axes': {'default': None, 'doc': 'data axes field name(s) (datasource)'}, 'msenv': {'default': None, 'doc': 'sardana environment (datasource)'}, 'mssardanadevice': {'default': None, 'doc': 'macroserver sardana device name MANDATORY (string)'}, 'nchannelstoskip': {'default': '0', 'doc': 'number of mg channels to skip (string)'}, 'sardanasignal': {'default': 'SignalCounter', 'doc': 'signal sardana variable name (string)'}, 'signal': {'default': 'defaultsignal', 'doc': 'data signal field name (datasource)'}}, 'dcm': {'bend1': {'default': None, 'doc': 'bending of the first cristal (datasource)'}, 'bend2': {'default': None, 'doc': 'bending of the second cristal (datasource)'}, 'braggangle': {'default': None, 'doc': 'bragg angle (datasource)'}, 'bragganglename': {'default': 'bragg', 'doc': 'bragg angle name (string)'}, 'chi2dependson': {'default': 'theta', 'doc': 'the depends_on field of the second cristal chi, e.g. phi (string)'}, 'crystal': {'default': None, 'doc': 'type of crystal i.e. 0->Si111,1->Si311,2->Si111 ChannelCut (datasource)'}, 'dcmdevice': {'default': None, 'doc': 'FMBOxfDCMEnergy tango device (string)'}, 'energy': {'default': None, 'doc': 'synchronized monochromator energy (datasource)'}, 'energyfmb': {'default': None, 'doc': 'monochromator energy (datasource)'}, 'exitoffset': {'default': None, 'doc': ' exit offset (datasource)'}, 'jack1': {'default': None, 'doc': 'first vertical jack of table (datasource)'}, 'jack1name': {'default': 'jack1', 'doc': 'first vertical jack name of table (string)'}, 'jack2': {'default': None, 'doc': 'second vertical jack of table (datasource)'}, 'jack2name': {'default': 'jack2', 'doc': 'second vertical jack name of table (string)'}, 'jack3': {'default': None, 'doc': 'third vertical jack of table (datasource)'}, 'jack3name': {'default': 'jack3', 'doc': 'third vertical jack name of table (string)'}, 'lat': {'default': None, 'doc': 'horizontal lattice translation of the first cristal (datasource)'}, 'lat2': {'default': None, 'doc': 'horizontal lattice translation of the second cristal (datasource)'}, 'lat2name': {'default': 'lat', 'doc': 'horizontal lattice translation name of the second cristal (string)'}, 'latname': {'default': 'lat', 'doc': 'horizontal lattice translation name of the first cristal (string)'}, 'oxfordhorizontal': {'default': None, 'doc': ' horizontal translation (datasource)'}, 'par2': {'default': None, 'doc': 'beam parallel translation of the second cristal (datasource)'}, 'par2name': {'default': 'para', 'doc': 'beam parallel translation name of the second cristal (string)'}, 'perp2': {'default': None, 'doc': 'vertical translation of the second cristal (datasource)'}, 'perp2name': {'default': 'perp', 'doc': 'vertical translation name of the second cristal (string)'}, 'phi1dependson': {'default': '../../transformations/bragg', 'doc': 'the depends_on field of the first cristal phi, e.g. theta (string)'}, 'pitch1': {'default': None, 'doc': 'theta rotation of the first cristal (datasource)'}, 'pitch1name': {'default': 'theta', 'doc': 'theta rotation name of the first cristal (string)'}, 'pitch2': {'default': None, 'doc': 'theta rotation of the second cristal (datasource)'}, 'pitch2name': {'default': 'theta', 'doc': 'theta rotation name of the second cristal (string)'}, 'roll1': {'default': None, 'doc': 'chi rotation of the first cristal (datasource)'}, 'roll1name': {'default': 'chi', 'doc': 'chi rotation name of the first cristal (string)'}, 'roll2': {'default': None, 'doc': 'chi rotation of the second cristal (datasource)'}, 'roll2name': {'default': 'chi', 'doc': 'chi rotation name of the second cristal (string)'}, 'table': {'default': None, 'doc': 'vertical position of table (datasource)'}, 'tablename': {'default': 'table', 'doc': 'vertical position name of table (string)'}, 'theta': {'default': None, 'doc': 'theta angle (datasource)'}, 'thetaname': {'default': 'theta', 'doc': 'theta angle name (string)'}, 'topdependson2': {'default': 'chi', 'doc': 'the first transformation of the second crystal, e.g. lat (string)'}, 'unitcalibration': {'default': None, 'doc': 'unit calibration from dcmmotor (datasource)'}, 'usage': {'default': 'Bragg', 'doc': 'the crystall usage, e.g. Laue (string)'}, 'yaw': {'default': None, 'doc': 'phi rotation of the first cristal (datasource)'}, 'yaw2': {'default': None, 'doc': 'phi rotation of the second cristal (datasource)'}, 'yaw2name': {'default': 'phi', 'doc': 'phi rotation name of the second cristal (string)'}, 'yawname': {'default': 'phi', 'doc': 'phi rotation name of the first cristal (string)'}}, 'default': {'__configdevice__': {'default': 'nxs/configserver/localhost', 'doc': 'configuration server device name (string)'}, '__tangohost__': {'default': 'localhost', 'doc': 'tango host (string)'}, '__tangoport__': {'default': '10000', 'doc': 'tango port (string)'}, 'control': {'default': None, 'doc': 'group name of the monitor (string)'}, 'longname': {'default': 'P09 Resonant Scattering and Diffraction beamline', 'doc': 'beamline long name (string)'}, 'shortname': {'default': 'P09', 'doc': 'beamline short name (string)'}, 'sourcename': {'default': 'PETRA III', 'doc': 'source name (string)'}, 'srcname': {'default': 'source', 'doc': 'source group name (string)'}}, 'defaultinstrument': {'__configdevice__': {'default': 'nxs/configserver/localhost', 'doc': 'configuration server device name (string)'}, '__tangohost__': {'default': 'localhost', 'doc': 'tango host (string)'}, '__tangoport__': {'default': '10000', 'doc': 'tango port (string)'}, 'control': {'default': None, 'doc': 'group name of the monitor (string)'}, 'longname': {'default': 'P09 Resonant Scattering and Diffraction beamline', 'doc': 'beamline long name (string)'}, 'shortname': {'default': 'P09', 'doc': 'beamline short name (string)'}, 'sourcename': {'default': 'PETRA III', 'doc': 'source name (string)'}, 'srcname': {'default': 'source', 'doc': 'source group name (string)'}}, 'defaultsample': {}, 'description': {}, 'descriptiontext': {'description': {'default': 'scan', 'doc': 'scan technique (string)'}}, 'detectorlive': {'datatype': {'default': 'NX_UINT32', 'doc': 'list of devices (string)'}, 'detectordata': {'default': None, 'doc': 'detector live data (datasource)'}, 'detname': {'default': 'detector', 'doc': 'list of devices (string)'}}, 'empty': {}, 'groupsecop': {'access': {'default': None, 'doc': 'secop access list (string)'}, 'group': {'default': None, 'doc': 'secop group name (string)'}, 'host': {'default': None, 'doc': 'secop host name (string)'}, 'message': {'default': None, 'doc': 'secop command MANDATORY (string)'}, 'port': {'default': '5000', 'doc': 'secop port name (string)'}, 'timeout': {'default': '0.0001', 'doc': 'secop timeout (string)'}}, 'keithley': {'current': {'default': None, 'doc': 'current in A (datasource)'}, 'gain': {'default': None, 'doc': 'gain in V/A (datasource)'}, 'risetime': {'default': None, 'doc': 'rise time (datasource)'}, 'sourvoltlevel': {'default': None, 'doc': 'source voltage level in V (datasource)'}, 'voltage': {'default': None, 'doc': 'voltage in V (datasource)'}}, 'maia': {'chillersetpoint': {'default': None, 'doc': 'chiller set point temperature in Celsus (datasource)'}, 'chiptemperature': {'default': None, 'doc': 'detector chip temperature sensor for maia in Celsus (datasource)'}, 'gaintrimenable': {'default': None, 'doc': 'gaintrim enable status for maia (datasource)'}, 'identity': {'default': None, 'doc': 'sensor identity for maia (datasource)'}, 'interlockpressure': {'default': None, 'doc': 'interlock pressure for maia in mbar (datasource)'}, 'leakagecurrent': {'default': None, 'doc': 'leakage current sensor for maia in A (datasource)'}, 'lineariseenable': {'default': None, 'doc': 'linearise enable status for maia (datasource)'}, 'maiadimensions': {'default': 'empty', 'doc': 'maia dimensions component name (component)'}, 'maiafluxes': {'default': 'empty', 'doc': 'maia fluxes component name (component)'}, 'maiastage': {'default': 'empty', 'doc': 'maia stage component name (component)'}, 'mosfettemperature': {'default': None, 'doc': 'mosfet temperature sensor for maia in Celsus (datasource)'}, 'peltiercurrent': {'default': None, 'doc': 'peltier current sensor for maia in A (datasource)'}, 'photonenable': {'default': None, 'doc': 'photon enable status for maia (datasource)'}, 'pileuprejectionenable': {'default': None, 'doc': 'pileup rejection enable status for maia (datasource)'}, 'pixelenable': {'default': None, 'doc': 'pixel enable status for maia (datasource)'}, 'pressure': {'default': None, 'doc': 'gas pressure in mbar (datasource)'}, 'runnumber': {'default': None, 'doc': 'run number of maia (datasource)'}, 'status': {'default': None, 'doc': 'interlock status for maia (datasource)'}, 'throttleenable': {'default': None, 'doc': 'throttle enable status for maia (datasource)'}, 'uptime': {'default': None, 'doc': 'interlock uptime for maia (datasource)'}, 'voltagesetpoint': {'default': None, 'doc': 'voltage set point temperature in Celsus (datasource)'}, 'watertemperature': {'default': None, 'doc': 'water temperature sensor for maia in Celsus (datasource)'}}, 'maiadimension': {'detname': {'default': 'maia', 'doc': 'detector (alias) name (string)'}, 'dimname': {'default': None, 'doc': 'dimension name for maia (datasource)'}, 'dname': {'default': 'dimension', 'doc': 'dimension name group (string)'}, 'hysteresis': {'default': None, 'doc': 'pixel hysteresis of dimension for maia (datasource)'}, 'numberofpixels': {'default': None, 'doc': 'number of pixels of dimension for maia (datasource)'}, 'origin': {'default': None, 'doc': 'pixel origin of dimension for maia (datasource)'}, 'pixelpitch': {'default': None, 'doc': 'pixel pitch of dimension for maia (datasource)'}, 'positionsource': {'default': None, 'doc': 'position source of dimension for maia (datasource)'}, 'unit': {'default': None, 'doc': 'position units of dimension for maia (datasource)'}}, 'maiaflux': {'coefficient': {'default': None, 'doc': 'flux coefficient for maia (datasource)'}, 'detname': {'default': 'maia', 'doc': 'detector (alias) name (string)'}, 'fluxname': {'default': None, 'doc': 'flux name for maia (datasource)'}, 'fname': {'default': 'fluxdevice', 'doc': 'flux name group (string)'}, 'keithleydevice': {'default': 'keithley', 'doc': 'keithley device name (string)'}, 'source': {'default': None, 'doc': 'flux source for maia (datasource)'}, 'unit': {'default': None, 'doc': 'flux unit for maia (datasource)'}, 'vfcfactor': {'default': None, 'doc': 'vfc conversion factor (datasource)'}}, 'msnsar': {'__tangohost__': {'default': 'localhost', 'doc': 'tango host (string)'}, '__tangoport__': {'default': '10000', 'doc': 'tango port (string)'}, 'msenv': {'default': None, 'doc': 'sardana environment (datasource)'}, 'mssardanadevice': {'default': None, 'doc': 'sardana device name MANDATORY (string)'}, 'varname': {'default': None, 'doc': 'nested sardana environment variable name MANDATORY (string)'}}, 'mssar': {'__tangohost__': {'default': 'localhost', 'doc': 'tango host (string)'}, '__tangoport__': {'default': '10000', 'doc': 'tango port (string)'}, 'msenv': {'default': None, 'doc': 'sardana environment (datasource)'}, 'mssardanadevice': {'default': None, 'doc': 'macroserver sardana device name MANDATORY (string)'}, 'varname': {'default': None, 'doc': 'sardana environment variable name MANDATORY (string)'}}, 'parametercopymap': {'copymap': {'default': None, 'doc': 'yaml dictionary with {output: input} copy map (string)'}, 'parameter': {'default': 'copymap', 'doc': 'parameter name of copymap (string)'}, 'program': {'default': 'nxsfileinfo_parameters', 'doc': 'group name of NXparameters (string)'}}, 'pinhole': {'diameter': {'default': None, 'doc': 'pinhole diameter (datasource)'}, 'x': {'default': None, 'doc': 'horizontal position (datasource)'}, 'xname': {'default': 'x', 'doc': 'horizontal position name (string)'}, 'xsign': {'default': '', 'doc': "horizontal position sign, e.g. '-' (string)"}, 'y': {'default': None, 'doc': 'vertical position (datasource)'}, 'yname': {'default': 'y', 'doc': 'vertical position name (string)'}, 'z': {'default': None, 'doc': 'along the beam position (datasource)'}, 'zname': {'default': 'z', 'doc': 'along the beam position name (string)'}}, 'pointdet': {'data': {'default': None, 'doc': 'diode data (datasource)'}, 'detname': {'default': 'detector', 'doc': 'detector group name (string)'}}, 'qbpm': {'dependsony': {'default': '', 'doc': 'the depends_on y field value, e.g. distance (string)'}, 'dependstop': {'default': 'x', 'doc': 'the first transformation, e.g. distance (string)'}, 'distance': {'default': None, 'doc': 'distance for the sample in m, e.g. 0 (string)'}, 'distancename': {'default': 'distance', 'doc': 'distance name for the sample in m, e.g. 0 (string)'}, 'distanceoffset': {'default': None, 'doc': '3-vector distance offset in m, e.g. sample-source offset if the distance is taken from the source (string)'}, 'foil': {'default': None, 'doc': 'foil type, i.e. standard <cpname>_foil (datasource)'}, 'foilpos': {'default': None, 'doc': 'foil position MANDATORY (datasource)'}, 'foilposdict': {'default': '{"Ti": 43, "Ni": 23, "Out": 3}', 'doc': 'foil_type position json dictionary (string)'}, 'x': {'default': None, 'doc': 'horizontal position (datasource)'}, 'xname': {'default': 'x', 'doc': 'horizontal position name (string)'}, 'y': {'default': None, 'doc': 'vertical position (datasource)'}, 'yname': {'default': 'y', 'doc': 'vertical position name (string)'}}, 'sampledescription': {'sname': {'default': 'sample', 'doc': 'sample group name (string)'}}, 'sampledescriptiontext': {'description': {'default': '', 'doc': 'sample description or sampleId (string)'}, 'sname': {'default': 'sample', 'doc': 'sample group name (string)'}}, 'samplehkl': {'h': {'default': None, 'doc': 'h position in hkl space (datasource)'}, 'k': {'default': None, 'doc': 'k position in hkl space (datasource)'}, 'l': {'default': None, 'doc': 'l position in hkl space (datasource)'}, 'psi': {'default': None, 'doc': 'psi angle position of analyzer (datasource)'}, 'sname': {'default': 'sample', 'doc': 'sample group name (string)'}}, 'secop': {'host': {'default': None, 'doc': 'secop host name (string)'}, 'message': {'default': None, 'doc': 'secop command MANDATORY (string)'}, 'port': {'default': '5000', 'doc': 'secop port name (string)'}, 'timeout': {'default': '0.0001', 'doc': 'secop timeout (string)'}}, 'secoplinks': {'environments': {'default': 'temperature,magnetic_field', 'doc': 'secop environment link lists MANDATORY (string)'}, 'meanings': {'default': 'temperature,magnetic_field,electric_field,stress_field,pressure', 'doc': 'secop meanings link lists MANDATORY (string)'}, 'sampleenvname': {'default': 'sample_environment', 'doc': 'sample environment group name (string)'}, 'samplename': {'default': 'sample', 'doc': 'sample group name (string)'}}, 'singlesecop': {'host': {'default': None, 'doc': 'secop host name (string)'}, 'message': {'default': None, 'doc': 'secop command MANDATORY (string)'}, 'port': {'default': '5000', 'doc': 'secop port name (string)'}, 'timeout': {'default': '0.0001', 'doc': 'secop timeout (string)'}}, 'slit': {'bottom': {'default': None, 'doc': 'bottom blade position (datasource)'}, 'bottomclosed': {'default': None, 'doc': 'bottom blade closed position (datasource)'}, 'dependstop': {'default': None, 'doc': 'the first transformation, e.g. distance (string)'}, 'distance': {'default': None, 'doc': 'distance for the sample in m, e.g. 0 (string)'}, 'distancename': {'default': 'distance', 'doc': 'distance name for the sample in m, e.g. 0 (string)'}, 'distanceoffset': {'default': None, 'doc': '3-vector distance offset in m, e.g. sample-source offset if the distance is taken from the source (string)'}, 'left': {'default': None, 'doc': 'left blade position (datasource)'}, 'leftclosed': {'default': None, 'doc': 'left blade closed position (datasource)'}, 'right': {'default': None, 'doc': 'right blade position (datasource)'}, 'rightclosed': {'default': None, 'doc': 'right blade closed position (datasource)'}, 'top': {'default': None, 'doc': 'top blade position (datasource)'}, 'topclosed': {'default': None, 'doc': 'top blade closed position (datasource)'}, 'transformations': {'default': None, 'doc': "transformations group name i.e. 'transformations'. If it is not set it is not created (string)"}, 'xgap': {'default': None, 'doc': 'horizontal gap (datasource)'}, 'xoffdependson': {'default': 'y_offset', 'doc': 'the first transformation, e.g. distance (string)'}, 'xoffset': {'default': None, 'doc': 'horizontal offset (datasource)'}, 'xoffsetcalibration': {'default': None, 'doc': 'horizontal offset calibration (datasource)'}, 'xoffsetcalibrationname': {'default': 'x_offset_calibration', 'doc': 'horizontal offset calibration name (string)'}, 'xoffsetname': {'default': 'x_offset', 'doc': 'horizontal offset name (string)'}, 'ygap': {'default': None, 'doc': 'vertical gap (datasource)'}, 'yoffdependson': {'default': 'distance', 'doc': 'the first transformation, e.g. distance (string)'}, 'yoffset': {'default': None, 'doc': 'vertiacal offset (datasource)'}, 'yoffsetcalibration': {'default': None, 'doc': 'vertiacal offset calibration (datasource)'}, 'yoffsetcalibrationname': {'default': 'y_offset_calibration', 'doc': 'vertiacal offset calibration name (string)'}, 'yoffsetname': {'default': 'y_offset', 'doc': 'vertiacal offset name (string)'}}, 'source': {'beamcurrent': {'default': None, 'doc': 'ring beam current (datasource)'}, 'bunchmode': {'default': 'Multi Bunch', 'doc': 'bunch mode (string)'}, 'numberofbunches': {'default': None, 'doc': 'number of source bunches (datasource)'}, 'sourceenergy': {'default': None, 'doc': 'ring beam energy (datasource)'}, 'srcname': {'default': 'source', 'doc': 'source group name (string)'}}, 'starttime': {}, 'tango': {'attribute': {'default': 'Position', 'doc': 'tango device attribute (string)'}, 'device': {'default': None, 'doc': 'tango device MANDATORY (string)'}}, 'undulator': {'dependstop': {'default': None, 'doc': 'the first transformation, e.g. distance (string)'}, 'distance': {'default': None, 'doc': 'distance from the sample in m, e.g. 0 (string)'}, 'distancename': {'default': 'distance', 'doc': 'distance name from the sample in m, e.g. 0 (string)'}, 'distanceoffset': {'default': None, 'doc': '3-vector distance offset in m, e.g. sample-source offset if the distance is taken from the source (string)'}, 'energy': {'default': None, 'doc': 'undulator energy (datasource)'}, 'gap': {'default': None, 'doc': 'separation between opposing pairs of magnetic pole (datasource)'}, 'gapunits': {'default': 'mm', 'doc': 'gap units (string)'}, 'harmonic': {'default': None, 'doc': 'undulator harmonic (datasource)'}, 'length': {'default': '2', 'doc': 'length of insertion device in meters (string)'}, 'shift': {'default': None, 'doc': 'undulator shift (datasource)'}, 'shiftunits': {'default': 'mm', 'doc': 'shift units (string)'}, 'speed': {'default': None, 'doc': 'undulator speed (datasource)'}, 'speedunits': {'default': '', 'doc': 'speed units (string)'}, 'taper': {'default': None, 'doc': 'gap difference between upstream and downstream ends of the insertion device (datasource)'}, 'taperunits': {'default': 'mm', 'doc': 'gap units (string)'}, 'transformations': {'default': None, 'doc': "transformations group name i.e. 'transformations'. If it is not set it is not created (string)"}, 'type': {'default': 'undulator', 'doc': 'undulator or wiggler (string)'}, 'uname': {'default': 'insertion_device', 'doc': 'insertion_device group name (string)'}}}¶: (dict <str , dict <str , str > >) standard component template variables and its [default value, doc string]

nxstools.nxsdevicetools.storeComponent(name, xml, server, mandatory=False)[source]¶

stores components in Configuration Server

Parameters:

name (str) – component name
xml (str) – component xml string
server (str) – configuration server
mandatory (bool) – set component as mandatory

nxstools.nxsdevicetools.storeDataSource(name, xml, server)[source]¶

stores datasources in Configuration Server

Parameters:

name (str) – datasource name
xml (str) – datasource xml string
server (str) – configuration server

nxstools.nxsdevicetools.twoDModules = ['pilatus100k', 'pilatus300k', 'pilatus1m', 'pilatus2m', 'pilatus6m', 'pco4000', 'perkinelmerdetector', 'lambda', 'pedetector', 'perkinelmer', 'pco', 'pcoedge', 'marccd', 'perkinelmer', 'lcxcamera', 'limaccd', 'eigerpsi', 'eigerdectris']¶: (list <str>) modules of 2d detectors

nxstools.nxsdevicetools.xmlPackageHandler = <nxstools.nxsdevicetools.PackageHandler object>¶: (PackageHandler) xml template package handler

nxstools.nxsdevicetools.zeroDModules = ['tip830']¶: (list <str>) modules of 0D detectors

nxstools.nxsetup module¶

Set Up NeXus Tango Servers

class nxstools.nxsetup.AddRecorderPath(parser)[source]¶

Bases: Runner

add-recorder-path runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'add-recorder-path into MacroServer(s) property'¶: (str) command description

epilog = ' examples:\n nxsetup add-recorder-path /usr/share/pyshared/sardananxsrecorder\n nxsetup add-recorder-path -t /usr/share/pyshared/sardananxsrecorder\n nxsetup add-recorder-path /usr/share/pyshared/sardananxsrecorder -i haso\n\n'¶: (str) command epilog

postauto()[source]¶: creates parser

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options

class nxstools.nxsetup.ChangeProp(parser)[source]¶

Bases: Runner

change-prop runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'change property value'¶: (str) command description

epilog = ' examples:\n nxsetup change-prop -n ClientRecordKeys -t -w "[\\"phoibos_scan_command\\",\\"phoibos_scan_comment\\"]" NXSRecSelector/r228\n nxsetup change-prop -n DefaultPreselectedComponents -w "[\\"pinhole1\\",\\"slit2\\"]" NXSRecSelector/r228\n nxsetup change-prop -n StartDsPath -w "[\\"/usr/bin\\",\\"/usr/lib/tango\\"]" Starter\n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options

class nxstools.nxsetup.MoveProp(parser)[source]¶

Bases: Runner

move-prop runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'change property name'¶: (str) command description

epilog = ' examples:\n nxsetup move-prop -n DefaultPreselectedComponents -o DefaultAutomaticComponents NXSRecSelector\n nxsetup move-prop -t -n DefaultPreselectedComponents -o DefaultAutomaticComponents NXSRecSelector\n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options

class nxstools.nxsetup.Restart(parser)[source]¶

Bases: Runner

restart runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'restart tango server'¶: (str) command description

epilog = ' examples:\n nxsetup restart Pool/haso228 -l 2\n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options

class nxstools.nxsetup.Set(parser)[source]¶

Bases: Runner

set runner

parser creator

Parameters:: parser (NXSFileInfoArgParser) – option parser

create()[source]¶: creates parser

description = 'set up NXSConfigServer NXSDataWriter and NXSRecSelector servers'¶: (str) command description

epilog = ' examples:\n nxsetup set\n nxsetup set -b p09 -m haso228 -u p09user -d nxsconfig NXSConfigServer\n nxsetup set NexusWriter/haso228 -k NexusWriter -y \'{"p00/bliss_nexuswriter/test_session":{"session":"test_session","beacon_host":"haso228:25000"}}\' -t\n\n'¶: (str) command epilog

run(options)[source]¶

the main program function

Parameters:: options (argparse.Namespace) – parser options

class nxstools.nxsetup.SetUp[source]¶

Bases: object

setup NXSDataWriter, NXSConfigServer and NXSRecSelector Tango servers

constructor

changePropertyName(server, oldname, newname, sclass=None)[source]¶

changes property name

Parameters:

server (str) – server name
oldname (str) – old property name
newname (str) – new property name
sclass (str) – server class name

Returns:

True if property name was changed

Return type:

changePropertyValue(server, newname, newvalue, sclass=None)[source]¶

changes/sets property value

Parameters:

server (str) – server name
newvalue (str) – new property value
newname (str) – new property name
sclass (str) – server class name

Returns:

True if property name was changed

Return type:

changeRecorderPath(path, instance=None)[source]¶

adds a new recorder path

Parameters:

path (str) – new recorder path
instance (str) – MacroServer instance name

Returns:

True if record path was added

Return type:

createConfigServer(beamline, masterhost, jsonsettings=None, hostname=None, postpone=False)[source]¶

creates configuration server

Parameters:

beamline (str) – beamline name
masterhost (str) – master host of data writer
jsonsettings (str) – connection settings to DB in json
hostname (str) – host to run the config server
postpone (bool) – postpone starting flag

Returns:

True if server was created

Return type:

createDataWriter(beamline, masterhost, postpone=False)[source]¶

creates data writer

Parameters:

beamline (str) – beamline name
masterhost (str) – master host of data writer
postpone (bool) – postpone starting flag

Returns:

True if server was created

Return type:

createSelector(beamline, masterhost, writer=None, cserver=None, postpone=False)[source]¶

creates selector server

Parameters:

beamline (str) – beamline name
masterhost (str) – master host of data writer
writer (str) – writer device name
cserver (str) – configuration server device name
postpone (bool) – postpone starting flag

Returns:

True if server was created

Return type:

createServer(server_name, beamline, masterhost, hostname=None, class_name=None, jsondeviceproperties=None, postpone=False)[source]¶

creates tango server in DB

Parameters:

server_name (str) – server name
beamline (str) – beamline name
masterhost (str) – master host of data writer
hostname (str) – host to run the config server
class_name – class name
jsondeviceproperties (str) – json device properties
postpone (bool) – postpone starting flag

Returns:

True if server was created

Return type:

cserver_name¶: (str) NeXus config server device name

db¶: (tango.Database) tango database server

getStarterName(host)[source]¶

restarts server

Parameters:: host (str) – server host name
Returns:: starter device name
Return type:: str

killServer(server)[source]¶

restartServer(name, host=None, level=None, restart=True, stopstart=True, wait=True, timeout=None)[source]¶

restarts server

Parameters:

name (str) – server name
host (str) – server host name
level (int) – start up level
restart (bool) – if server should be restarted
stopstart (bool) – if server should be stopped and started
wait (bool) – script should wait for the server
timeout (float) – timeout for start

stopServer(name, host=None)[source]¶

restarts server

Parameters:

name (str) – server name
host (str) – server host name

waitServerNotRunning(server=None, device=None, adminproxy=None, maxcnt=10000, verbose=True, waitforproc=True)[source]¶

wait until device is exported and server is running

Parameters:

server (str) – server name, check if running when not None
device (str) – device name, check if exported when not None
adminproxy (tango.DeviceProxy) – Starter device proxy
maxcnt (int) – maximal waiting time in 10ms
verbose (bool) – verbose mode
waitforproc – wait for process list update

Returns:

True if server is running

Return type:

waitServerRunning(server=None, device=None, adminproxy=None, maxcnt=10000, verbose=True, waitforproc=True)[source]¶

wait until device is exported and server is running

Parameters:

server (str) – server name, check if running when not None
device (str) – device name, check if exported when not None
adminproxy (tango.DeviceProxy) – Starter device proxy
maxcnt (int) – maximal waiting time in 10ms
verbose (bool) – verbose mode
waitforproc – wait for process list update

Returns:

True if server is running

Return type: