v2025.3.0 (2025-03-27)ο
Featuresο
Added
enumConTypeto create a control type indicator. (#141)Created a master mapping template class
HDFMapTemplatethat all other mapping template classes inherit from. This reduces code duplication for inheriting children. This introduces a class attributemaptypefor all mapping classes. (#141)All control device mapping classes now have a class attribute
contypeto indicate the control device type. (#141)For control device mappings, the
configs["shotnum"]["dset paths"]can beNone. If so,HDFReadControlswill assume the'dset paths'defined in each'state values'entry. (#141)For control device mappings, added the option field
configs["state values"][<key>]["config column"]so the dataset configuration column can be named. If omitted, thenHDFReadControlswill still search for a column with'configuration'in the name. (#141)Added control device mapper
HDFMapControlBMotion. (#154)
Documentation Improvementsο
Added Sphinx extension sphinx-hoverxref. (#139)
Converted all docstrings to the numpydoc style. (#140)
Trivial/Internal Changesο
Renamed
bapsflib._hdf.maps.coretobapsflib._hdf.maps.mapper. (#141)Renamed
bapsflib.lapd._hdf.lapdmaptobapsflib.lapd._hdf.mapper. (#141)Renamed
LaPDMaptoLaPDMapper. (#141)Signature of
build_shotnum_dset_relationandbuild_sndr_for_complex_dsetare updated to accept argumentsshotnum,dset,shotnumkey,n_configs,config_id, and (optional)config_column. This allows for mappedconfig['state values']entries to utilize separate datasets and custom configuration columns. (#156)Signature of
condition_shotnumis updated to accept argumentsshotnum,dset_list, andshotnumkey_list. This allows for mappedconfig['state values']entries to utilize separate datasets. (#156)Updated
do_shotnum_intersectionso shot numbers are retrieved from the dataset associated with each mappedconfig['state values'], and not the genericconfig['dset paths']. (#156)