opentea.tools package

Submodules

opentea.tools.proxy_h5 module

Module container for class ProxyH5

class opentea.tools.proxy_h5.ProxyH5(h5_filename)

Bases: object

Class container for hdf5 file inspector

h5_filename : Path to hdf5 file

get_field(identifier)

Get a value of a field given its identifier

identifier : the adress of the content to retrieve.

Possible options:
  • String : key of the value to retrieve

(e.g ‘content’)

  • String : A posix-like full address (e.g ‘full/address/to/content’)

  • List : A list of adress stages, complete or not (e.g [‘full’, ‘address’, ‘to’, ‘content’] or,

    [‘content’])

  • A list of lists : a list holding address stages, as it is done for instance in h5py. (e.g [[‘full’], [‘address’], [‘to’], [‘content’]]])

field : array or value of the query field

show(style=None)

Pretty print of the hdf5 content

stylestyle of printing, possible options
  • yaml : for a yaml formatting

  • json : for a yaml formatting

  • None : for a default printing

opentea.tools.schema2md module

Translate a schema nested object into Markdown table.

opentea.tools.schema2md.array2md(nob, path)

Print an array item into markdown

opentea.tools.schema2md.html_colored(str_, color='black')

Represent a string with html color markup.

opentea.tools.schema2md.html_list(list_)

Represent a list with html markup.

opentea.tools.schema2md.md_table_header()

The regular table header

opentea.tools.schema2md.schema2md(schema)

Convert schma type nest objet into Markdown

opentea.tools.schema2md.to_table_line(nob, path)

Reccursive cfn to create tables.

opentea.tools.schema2md.type_color(type_str)

Redirect according to types.

opentea.tools.schema2md.xor2md(nob, path)

Print a eXclusive Or item into markdown

opentea.tools.visit_h5 module

Visit h5py file

This should be removed because it is deprecated

opentea.tools.visit_h5.get_h5_structure(h5_filename)

Show hdf5 file components

h5_filename : path to hdf5 file to inspect

opentea.tools.visit_h5.print_h5_structure(h5_filename)

Show hdf5 file components

h5_filename : path to hdf5 file to inspect