v2025.3.0 (2025-03-27)

Features

  • Added enum MapTypes to create a map type indicator. (#141)

  • Added enum ConType to create a control type indicator. (#141)

  • Created a master mapping template class HDFMapTemplate that all other mapping template classes inherit from. This reduces code duplication for inheriting children. This introduces a class attribute maptype for all mapping classes. (#141)

  • All control device mapping classes now have a class attribute contype to indicate the control device type. (#141)

  • For control device mappings, the configs["shotnum"]["dset paths"] can be None. If so, HDFReadControls will 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, then HDFReadControls will still search for a column with 'configuration' in the name. (#141)

  • Added control device mapper HDFMapControlBMotion. (#154)

Documentation Improvements

Trivial/Internal Changes

  • Renamed bapsflib._hdf.maps.core to bapsflib._hdf.maps.mapper. (#141)

  • Renamed bapsflib.lapd._hdf.lapdmap to bapsflib.lapd._hdf.mapper. (#141)

  • Renamed HDFMap to HDFMapper. (#141)

  • Renamed LaPDMap to LaPDMapper. (#141)

  • Signature of build_shotnum_dset_relation and build_sndr_for_complex_dset are updated to accept arguments shotnum, dset, shotnumkey, n_configs, config_id, and (optional) config_column. This allows for mapped config['state values'] entries to utilize separate datasets and custom configuration columns. (#156)

  • Signature of condition_shotnum is updated to accept arguments shotnum, dset_list, and shotnumkey_list. This allows for mapped config['state values'] entries to utilize separate datasets. (#156)

  • Updated do_shotnum_intersection so shot numbers are retrieved from the dataset associated with each mapped config['state values'], and not the generic config['dset paths']. (#156)

Package Management

  • Added package dependency numpydoc. (#140)

  • Added dependency bapsf_motion. (#154)