223031012
/
DAMASK_EICMD
mirror of https://github.com/achalhp/DAMASK_EICMD.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

add comments at class level

This commit is contained in:
chen 2016-10-09 17:19:49 -04:00
parent f992edd3e9
commit 52813351be
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
lib/damask/h5table.py
View File

@ -54,21 +54,21 @@ class H5Table(object):
""" """
DESCRIPTION DESCRIPTION
----------- -----------
Interface class for manipulating data in HDF5 with DAMASK Interface/wrapper class for manipulating data in HDF5 with DAMASK
specialized data structure. specialized data structure.
-->Minimal API design.
PARAMETERS PARAMETERS
---------- ----------
h5f_path: str h5f_path: str
Absolute path the HDF5 file Absolute path the HDF5 file
METHOD METHOD
------ ------
del_entry() del_entry() -- Force delete attributes/group/datasets (Dangerous)
get_attr() get_attr() -- Return attributes if possible
add_attr() add_attr() -- Add NEW attributes to dataset/group (please delete old first!)
get_data() get_data() -- Retrieve data in numpy.ndarray
add_data() add_data() -- Add dataset to H5 file
get_cmdlog() get_cmdlog() -- Return the command used to generate the data if possible.
Return the command used to generate the data if possible.
NOTE NOTE
---- ----
1. As an interface class, it uses the lazy evaluation design 1. As an interface class, it uses the lazy evaluation design