From 6cec2d3fcda610115c4e85053b98de1d6c51b63c Mon Sep 17 00:00:00 2001 From: Erik Date: Tue, 31 Mar 2026 21:23:31 -0700 Subject: [PATCH 1/3] generate changelog --- changelog/178.pkg_management.1.rst | 1 - changelog/181.doc.1.rst | 1 - changelog/182.trivial.1.rst | 6 -- changelog/182.trivial.2.rst | 2 - changelog/183.breaking.1.rst | 2 - changelog/183.doc.1.rst | 1 - changelog/183.doc.2.rst | 2 - changelog/183.feature.1.rst | 2 - changelog/184.feature.1.rst | 4 - changelog/184.feature.2.rst | 4 - changelog/184.trivial.1.rst | 3 - changelog/185.feature.1.rst | 4 - changelog/185.feature.2.rst | 7 -- changelog/185.feature.3.rst | 6 -- changelog/185.feature.4.rst | 4 - changelog/185.feature.5.rst | 3 - changelog/185.feature.6.rst | 5 - changelog/186.bugfix.1.rst | 7 -- changelog/186.feature.1.rst | 3 - changelog/186.trivial.1.rst | 11 --- changelog/187.feature.1.rst | 4 - changelog/187.feature.2.rst | 3 - changelog/187.feature.3.rst | 5 - changelog/188.doc.1.rst | 3 - changelog/188.doc.2.rst | 3 - changelog/188.doc.3.rst | 2 - changelog/188.doc.4.rst | 2 - changelog/188.doc.5.rst | 2 - changelog/188.doc.6.rst | 2 - changelog/188.pkg_management.1.rst | 1 - changelog/188.pkg_management.2.rst | 1 - changelog/190.doc.1.rst | 1 - changelog/190.doc.2.rst | 3 - changelog/190.pkg_management.1.rst | 2 - changelog/191.doc.1.rst | 1 - changelog/191.doc.2.rst | 1 - changelog/191.doc.3.rst | 3 - changelog/191.doc.4.rst | 4 - changelog/191.pkg_management.1.rst | 2 - docs/changelog/2026.3.1.rst | 154 +++++++++++++++++++++++++++++ 40 files changed, 154 insertions(+), 123 deletions(-) delete mode 100644 changelog/178.pkg_management.1.rst delete mode 100644 changelog/181.doc.1.rst delete mode 100644 changelog/182.trivial.1.rst delete mode 100644 changelog/182.trivial.2.rst delete mode 100644 changelog/183.breaking.1.rst delete mode 100644 changelog/183.doc.1.rst delete mode 100644 changelog/183.doc.2.rst delete mode 100644 changelog/183.feature.1.rst delete mode 100644 changelog/184.feature.1.rst delete mode 100644 changelog/184.feature.2.rst delete mode 100644 changelog/184.trivial.1.rst delete mode 100644 changelog/185.feature.1.rst delete mode 100644 changelog/185.feature.2.rst delete mode 100644 changelog/185.feature.3.rst delete mode 100644 changelog/185.feature.4.rst delete mode 100644 changelog/185.feature.5.rst delete mode 100644 changelog/185.feature.6.rst delete mode 100644 changelog/186.bugfix.1.rst delete mode 100644 changelog/186.feature.1.rst delete mode 100644 changelog/186.trivial.1.rst delete mode 100644 changelog/187.feature.1.rst delete mode 100644 changelog/187.feature.2.rst delete mode 100644 changelog/187.feature.3.rst delete mode 100644 changelog/188.doc.1.rst delete mode 100644 changelog/188.doc.2.rst delete mode 100644 changelog/188.doc.3.rst delete mode 100644 changelog/188.doc.4.rst delete mode 100644 changelog/188.doc.5.rst delete mode 100644 changelog/188.doc.6.rst delete mode 100644 changelog/188.pkg_management.1.rst delete mode 100644 changelog/188.pkg_management.2.rst delete mode 100644 changelog/190.doc.1.rst delete mode 100644 changelog/190.doc.2.rst delete mode 100644 changelog/190.pkg_management.1.rst delete mode 100644 changelog/191.doc.1.rst delete mode 100644 changelog/191.doc.2.rst delete mode 100644 changelog/191.doc.3.rst delete mode 100644 changelog/191.doc.4.rst delete mode 100644 changelog/191.pkg_management.1.rst create mode 100644 docs/changelog/2026.3.1.rst diff --git a/changelog/178.pkg_management.1.rst b/changelog/178.pkg_management.1.rst deleted file mode 100644 index 50eaac78..00000000 --- a/changelog/178.pkg_management.1.rst +++ /dev/null @@ -1 +0,0 @@ -Bumped `black` version from ``==v24.3.0`` to ``==v26.3.1``. diff --git a/changelog/181.doc.1.rst b/changelog/181.doc.1.rst deleted file mode 100644 index 7cccbd58..00000000 --- a/changelog/181.doc.1.rst +++ /dev/null @@ -1 +0,0 @@ -Created the "Package Features" section in the RTD sidebar. diff --git a/changelog/182.trivial.1.rst b/changelog/182.trivial.1.rst deleted file mode 100644 index 071e1b6e..00000000 --- a/changelog/182.trivial.1.rst +++ /dev/null @@ -1,6 +0,0 @@ -Added return annotations for key `~bapsflib._hdf.utils.file.File` -methods, `~bapsflib._hdf.utils.file.File.overview`, -`~bapsflib._hdf.utils.file.File.read_controls`, -`~bapsflib._hdf.utils.file.File.read_data`, and -`~bapsflib._hdf.utils.file.File.read_msi`. This was done on both -`bapsflib._hdf.utils.file.File` and `bapsflib.lapd._hdf.file.File`. diff --git a/changelog/182.trivial.2.rst b/changelog/182.trivial.2.rst deleted file mode 100644 index 20a3e684..00000000 --- a/changelog/182.trivial.2.rst +++ /dev/null @@ -1,2 +0,0 @@ -Replaced some instances of the ``Union[]`` annotation with the newer -pipe ``|`` notation. diff --git a/changelog/183.breaking.1.rst b/changelog/183.breaking.1.rst deleted file mode 100644 index 450fe899..00000000 --- a/changelog/183.breaking.1.rst +++ /dev/null @@ -1,2 +0,0 @@ -Removed the `bapsflib.plasma` sub-module from the default `bapsflib` -namespace. diff --git a/changelog/183.doc.1.rst b/changelog/183.doc.1.rst deleted file mode 100644 index 4c34258c..00000000 --- a/changelog/183.doc.1.rst +++ /dev/null @@ -1 +0,0 @@ -Created documentation stub files for the `bapsflib.phys180E` sub-module. diff --git a/changelog/183.doc.2.rst b/changelog/183.doc.2.rst deleted file mode 100644 index 39056b39..00000000 --- a/changelog/183.doc.2.rst +++ /dev/null @@ -1,2 +0,0 @@ -Added `bapsflib.phys180E` to the "Package Features" section of the -documentation sidebar. diff --git a/changelog/183.feature.1.rst b/changelog/183.feature.1.rst deleted file mode 100644 index e1ae6403..00000000 --- a/changelog/183.feature.1.rst +++ /dev/null @@ -1,2 +0,0 @@ -Created sub-module `bapsflib.phys180E` and initialized it with the -`~bapsflib.phys180E._hdf.file_.File` class. diff --git a/changelog/184.feature.1.rst b/changelog/184.feature.1.rst deleted file mode 100644 index 20f9d89a..00000000 --- a/changelog/184.feature.1.rst +++ /dev/null @@ -1,4 +0,0 @@ -Added ``__str__`` and ``__repr__`` dunders to -`~bapsflib._hdf.maps.digitizers.map_digis.HDFMapDigitizers` and -`~bapsflib._hdf.maps.controls.map_controls.HDFMapControls` to display -brief table summaries of the mapped devices. diff --git a/changelog/184.feature.2.rst b/changelog/184.feature.2.rst deleted file mode 100644 index ad18ea07..00000000 --- a/changelog/184.feature.2.rst +++ /dev/null @@ -1,4 +0,0 @@ -Created `~bapsflib.utils.TableDisplay` to aid in generating table -summaries for -`~bapsflib._hdf.maps.digitizers.map_digis.HDFMapDigitizers` and -`~bapsflib._hdf.maps.controls.map_controls.HDFMapControls`. diff --git a/changelog/184.trivial.1.rst b/changelog/184.trivial.1.rst deleted file mode 100644 index 366903d9..00000000 --- a/changelog/184.trivial.1.rst +++ /dev/null @@ -1,3 +0,0 @@ -Forced mapped board and channel values for -`~bapsflib._hdf.maps.digitizers.sis3301.HDFMapDigiSIS3301` to be type -`int` instead of `numpy.integer`. diff --git a/changelog/185.feature.1.rst b/changelog/185.feature.1.rst deleted file mode 100644 index dd0e5dfc..00000000 --- a/changelog/185.feature.1.rst +++ /dev/null @@ -1,4 +0,0 @@ -Created digitizer mapper -`~bapsflib._hdf.maps.digitizers.lecroy.HDFMapDigiLeCroy180E` to map the -associated HDF5 data generated by the LeCroy X-Stream oscilloscopes used -in the UCLA Physics 180E lab. diff --git a/changelog/185.feature.2.rst b/changelog/185.feature.2.rst deleted file mode 100644 index e389b984..00000000 --- a/changelog/185.feature.2.rst +++ /dev/null @@ -1,7 +0,0 @@ -Introduced a scheme to allow the ``'shotnum'`` mapping configuration key, -:attr:`~bapsflib._hdf.maps.digitizers.templates.HDFMapDigiTemplate.configs`, -to contain a value of `None` for digitizers that do NOT record shot number -information in their header datasets. This also required updates to -`~bapsflib._hdf.utils.hdfreaddata.HDFReadData`, -`~bapsflib._hdf.utils.helpers.build_shotnum_dset_relation`, and -`~bapsflib._hdf.utils.helpers.condition_shotnum`. diff --git a/changelog/185.feature.3.rst b/changelog/185.feature.3.rst deleted file mode 100644 index d79aca9a..00000000 --- a/changelog/185.feature.3.rst +++ /dev/null @@ -1,6 +0,0 @@ -Introduced a scheme to allow the ``'bit'`` mapping configuration key, -:attr:`~bapsflib._hdf.maps.digitizers.templates.HDFMapDigiTemplate.configs`, -to contain a value of `None` for digitizers that record voltage into -the HDF5 files, instead of bits. This also required an update -`~bapsflib._hdf.utils.hdfreaddata.HDFReadData`, so it would default -to ``keep_bits=True`` without issuing a warning. diff --git a/changelog/185.feature.4.rst b/changelog/185.feature.4.rst deleted file mode 100644 index 067c2aff..00000000 --- a/changelog/185.feature.4.rst +++ /dev/null @@ -1,4 +0,0 @@ -Introduced a scheme to allow the ``'clock rate'`` mapping configuration key, -:attr:`~bapsflib._hdf.maps.digitizers.templates.HDFMapDigiTemplate.configs`, -to contain a value of `None` for digitizers that do NOT record clock or -sample rate information into the HDF5 files. diff --git a/changelog/185.feature.5.rst b/changelog/185.feature.5.rst deleted file mode 100644 index 66db60cd..00000000 --- a/changelog/185.feature.5.rst +++ /dev/null @@ -1,3 +0,0 @@ -Introduced the configuration key ``'channel_labels'``, -:attr:`~bapsflib._hdf.maps.digitizers.templates.HDFMapDigiTemplate.configs`, -to contain store any channel label meta-data recorded in the HDF5 file. diff --git a/changelog/185.feature.6.rst b/changelog/185.feature.6.rst deleted file mode 100644 index 0122e62b..00000000 --- a/changelog/185.feature.6.rst +++ /dev/null @@ -1,5 +0,0 @@ -Introduced the configuration key ``'time_dset_path'``, -:attr:`~bapsflib._hdf.maps.digitizers.templates.HDFMapDigiTemplate.configs`, -to contain store a relative path to a time array dataset associated with -the channel datasets. The relative path is relative to the digitizer -group path. diff --git a/changelog/186.bugfix.1.rst b/changelog/186.bugfix.1.rst deleted file mode 100644 index 6dcbc807..00000000 --- a/changelog/186.bugfix.1.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. py:currentmodule:: bapsflib._hdf - -Fixed bug where the information dictionary returned by -:meth:`~.maps.digitizers.templates.HDFMapDigiTemplate.construct_dataset_name` -could modify the -:attr:`~.maps.digitizers.templates.HDFMapDigiTemplate.configs` dictionary -if the information dictionary were to be modified. diff --git a/changelog/186.feature.1.rst b/changelog/186.feature.1.rst deleted file mode 100644 index 999e2f5d..00000000 --- a/changelog/186.feature.1.rst +++ /dev/null @@ -1,3 +0,0 @@ -Created the method :meth:`~bapsflib._hdf.utils.file.File.get_time_array` -to generate or retrieve the time series data associated with a specified -digitized signal. diff --git a/changelog/186.trivial.1.rst b/changelog/186.trivial.1.rst deleted file mode 100644 index a568a9f0..00000000 --- a/changelog/186.trivial.1.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. py:currentmodule:: bapsflib._hdf - -Updated method :meth:`~.utils.file.File.get_digitizer_specs` to generate -the information dictionary using the -`~.maps.digitizers.templates.HDFMapDigiTemplate` method -:meth:`~.maps.digitizers.templates.HDFMapDigiTemplate.construct_dataset_name` -instead of -:meth:`~.maps.digitizers.templates.HDFMapDigiTemplate.get_adc_info` -to maintain consistency with the -:attr:`~.utils.hdfreaddata.HDFReadData.info` dictionary generated by -`~.utils.hdfreaddata.HDFReadData`. diff --git a/changelog/187.feature.1.rst b/changelog/187.feature.1.rst deleted file mode 100644 index 6535614e..00000000 --- a/changelog/187.feature.1.rst +++ /dev/null @@ -1,4 +0,0 @@ -Created -`~bapsflib._hdf.maps.controls.positions180e.HDFMapControlPositions180E` -to map the ``"Positions"`` control group generated by the Physics 180E -lab. diff --git a/changelog/187.feature.2.rst b/changelog/187.feature.2.rst deleted file mode 100644 index ba5d1374..00000000 --- a/changelog/187.feature.2.rst +++ /dev/null @@ -1,3 +0,0 @@ -Introduced the class attribute -``HDFMapControlTemplate._EXPECTED_GROUP_NAME`` to define the expected / -default group name associated with the control device being mapped. diff --git a/changelog/187.feature.3.rst b/changelog/187.feature.3.rst deleted file mode 100644 index e4134d9b..00000000 --- a/changelog/187.feature.3.rst +++ /dev/null @@ -1,5 +0,0 @@ -Updated the mapping scheme of -`~bapsflib._hdf.maps.controls.map_controls.HDFMapControls` so a group -is identified based on matching the group name to either the identifying -key in ``HDFMapControls._defined_mapping_classes`` or the -``_EXPECTED_GROUP_NAME`` of a mapping class. diff --git a/changelog/188.doc.1.rst b/changelog/188.doc.1.rst deleted file mode 100644 index af25e178..00000000 --- a/changelog/188.doc.1.rst +++ /dev/null @@ -1,3 +0,0 @@ -Removed `sphinx` extension `sphinx-hoverxref`, and replaced with the -`Read the Docs addon "Link previews" -`_\ . diff --git a/changelog/188.doc.2.rst b/changelog/188.doc.2.rst deleted file mode 100644 index 67c96450..00000000 --- a/changelog/188.doc.2.rst +++ /dev/null @@ -1,3 +0,0 @@ -Integrated the `plasmapy_sphinx` extensions and theme: -`plasmapy_sphinx.ext.autodoc`, `plasmapy_sphinx.ext.directives`, and -`plasmapy_sphinx.theme`. diff --git a/changelog/188.doc.3.rst b/changelog/188.doc.3.rst deleted file mode 100644 index 610414ae..00000000 --- a/changelog/188.doc.3.rst +++ /dev/null @@ -1,2 +0,0 @@ -Re-titled the sidebar section names to be **First Steps**, -**Package Features**, **Developer Documentation**, and **All the Rest**. diff --git a/changelog/188.doc.4.rst b/changelog/188.doc.4.rst deleted file mode 100644 index 9795c56a..00000000 --- a/changelog/188.doc.4.rst +++ /dev/null @@ -1,2 +0,0 @@ -Dropped the explicit use of the :rst:role:`py:obj`, :rst:role:`py:mod`, and -:rst:role:`py:class` roles in favor of just using single back-ticks. diff --git a/changelog/188.doc.5.rst b/changelog/188.doc.5.rst deleted file mode 100644 index d477a60b..00000000 --- a/changelog/188.doc.5.rst +++ /dev/null @@ -1,2 +0,0 @@ -Dropped the explicit use of the :rst:role:`code` role in favor of just -using double back-ticks. diff --git a/changelog/188.doc.6.rst b/changelog/188.doc.6.rst deleted file mode 100644 index 680082f9..00000000 --- a/changelog/188.doc.6.rst +++ /dev/null @@ -1,2 +0,0 @@ -Removed documentation stub file -:file:`api_static/bapsflib.lapd.ConType.rst`. diff --git a/changelog/188.pkg_management.1.rst b/changelog/188.pkg_management.1.rst deleted file mode 100644 index 35227f76..00000000 --- a/changelog/188.pkg_management.1.rst +++ /dev/null @@ -1 +0,0 @@ -Removed documentation dependency `sphinx-hoverxref`. diff --git a/changelog/188.pkg_management.2.rst b/changelog/188.pkg_management.2.rst deleted file mode 100644 index 150b1dac..00000000 --- a/changelog/188.pkg_management.2.rst +++ /dev/null @@ -1 +0,0 @@ -Added documentation dependency `plasmapy_sphinx`. diff --git a/changelog/190.doc.1.rst b/changelog/190.doc.1.rst deleted file mode 100644 index b3c31493..00000000 --- a/changelog/190.doc.1.rst +++ /dev/null @@ -1 +0,0 @@ -Added the `nbsphinx` extension to the documentation. diff --git a/changelog/190.doc.2.rst b/changelog/190.doc.2.rst deleted file mode 100644 index 48807735..00000000 --- a/changelog/190.doc.2.rst +++ /dev/null @@ -1,3 +0,0 @@ -Created an example notebook for the `bapsflib.phys180e.File` -functionality, and placed it in the "First Steps" section of the -sidebar. diff --git a/changelog/190.pkg_management.1.rst b/changelog/190.pkg_management.1.rst deleted file mode 100644 index 13183a04..00000000 --- a/changelog/190.pkg_management.1.rst +++ /dev/null @@ -1,2 +0,0 @@ -Made `nbsphinx`, `ipykernel`, and `matplotlib` documentation -dependencies. diff --git a/changelog/191.doc.1.rst b/changelog/191.doc.1.rst deleted file mode 100644 index 00b513df..00000000 --- a/changelog/191.doc.1.rst +++ /dev/null @@ -1 +0,0 @@ -Set the documentation theme to ``plasmapy_theme``. diff --git a/changelog/191.doc.2.rst b/changelog/191.doc.2.rst deleted file mode 100644 index 9e843a78..00000000 --- a/changelog/191.doc.2.rst +++ /dev/null @@ -1 +0,0 @@ -Removed unused documentation templates, ``docs/_templates/*``. diff --git a/changelog/191.doc.3.rst b/changelog/191.doc.3.rst deleted file mode 100644 index c0116b9b..00000000 --- a/changelog/191.doc.3.rst +++ /dev/null @@ -1,3 +0,0 @@ -Moved and renamed the CSS override file, -:file:`docs/_static/rtd_theme_overrides.css` -> -:file:`docs/_static/css/overrides.css`. diff --git a/changelog/191.doc.4.rst b/changelog/191.doc.4.rst deleted file mode 100644 index 25552944..00000000 --- a/changelog/191.doc.4.rst +++ /dev/null @@ -1,4 +0,0 @@ -Moved Sphinx role definitions from the :confval:`rst_prolog` -configuration variable to the ``setup()`` function using the -`~sphinx.application.Sphinx` `~sphinx.application.Sphinx.add_role` -method. diff --git a/changelog/191.pkg_management.1.rst b/changelog/191.pkg_management.1.rst deleted file mode 100644 index 89d96aca..00000000 --- a/changelog/191.pkg_management.1.rst +++ /dev/null @@ -1,2 +0,0 @@ -Update :file:`.readthedocs.yml` so the Read the Docs documentation -builds are done with Python 3.14. diff --git a/docs/changelog/2026.3.1.rst b/docs/changelog/2026.3.1.rst new file mode 100644 index 00000000..436edbf7 --- /dev/null +++ b/docs/changelog/2026.3.1.rst @@ -0,0 +1,154 @@ +v2026.3.1 (2026-03-31) +====================== + +Backwards Incompatible Changes +------------------------------ + +- Removed the `bapsflib.plasma` sub-module from the default `bapsflib` + namespace. (`#183 `_) + + +Features +-------- + +- Created sub-module `bapsflib.phys180E` and initialized it with the + `~bapsflib.phys180E._hdf.file_.File` class. (`#183 `_) +- Added ``__str__`` and ``__repr__`` dunders to + `~bapsflib._hdf.maps.digitizers.map_digis.HDFMapDigitizers` and + `~bapsflib._hdf.maps.controls.map_controls.HDFMapControls` to display + brief table summaries of the mapped devices. (`#184 `_) +- Created `~bapsflib.utils.TableDisplay` to aid in generating table + summaries for + `~bapsflib._hdf.maps.digitizers.map_digis.HDFMapDigitizers` and + `~bapsflib._hdf.maps.controls.map_controls.HDFMapControls`. (`#184 `_) +- Created digitizer mapper + `~bapsflib._hdf.maps.digitizers.lecroy.HDFMapDigiLeCroy180E` to map the + associated HDF5 data generated by the LeCroy X-Stream oscilloscopes used + in the UCLA Physics 180E lab. (`#185 `_) +- Introduced a scheme to allow the ``'shotnum'`` mapping configuration key, + :attr:`~bapsflib._hdf.maps.digitizers.templates.HDFMapDigiTemplate.configs`, + to contain a value of `None` for digitizers that do NOT record shot number + information in their header datasets. This also required updates to + `~bapsflib._hdf.utils.hdfreaddata.HDFReadData`, + `~bapsflib._hdf.utils.helpers.build_shotnum_dset_relation`, and + `~bapsflib._hdf.utils.helpers.condition_shotnum`. (`#185 `_) +- Introduced a scheme to allow the ``'bit'`` mapping configuration key, + :attr:`~bapsflib._hdf.maps.digitizers.templates.HDFMapDigiTemplate.configs`, + to contain a value of `None` for digitizers that record voltage into + the HDF5 files, instead of bits. This also required an update + `~bapsflib._hdf.utils.hdfreaddata.HDFReadData`, so it would default + to ``keep_bits=True`` without issuing a warning. (`#185 `_) +- Introduced a scheme to allow the ``'clock rate'`` mapping configuration key, + :attr:`~bapsflib._hdf.maps.digitizers.templates.HDFMapDigiTemplate.configs`, + to contain a value of `None` for digitizers that do NOT record clock or + sample rate information into the HDF5 files. (`#185 `_) +- Introduced the configuration key ``'channel_labels'``, + :attr:`~bapsflib._hdf.maps.digitizers.templates.HDFMapDigiTemplate.configs`, + to contain store any channel label meta-data recorded in the HDF5 file. (`#185 `_) +- Introduced the configuration key ``'time_dset_path'``, + :attr:`~bapsflib._hdf.maps.digitizers.templates.HDFMapDigiTemplate.configs`, + to contain store a relative path to a time array dataset associated with + the channel datasets. The relative path is relative to the digitizer + group path. (`#185 `_) +- Created the method :meth:`~bapsflib._hdf.utils.file.File.get_time_array` + to generate or retrieve the time series data associated with a specified + digitized signal. (`#186 `_) +- Created + `~bapsflib._hdf.maps.controls.positions180e.HDFMapControlPositions180E` + to map the ``"Positions"`` control group generated by the Physics 180E + lab. (`#187 `_) +- Introduced the class attribute + ``HDFMapControlTemplate._EXPECTED_GROUP_NAME`` to define the expected / + default group name associated with the control device being mapped. (`#187 `_) +- Updated the mapping scheme of + `~bapsflib._hdf.maps.controls.map_controls.HDFMapControls` so a group + is identified based on matching the group name to either the identifying + key in ``HDFMapControls._defined_mapping_classes`` or the + ``_EXPECTED_GROUP_NAME`` of a mapping class. (`#187 `_) + + +Bug Fixes +--------- + +- .. py:currentmodule:: bapsflib._hdf + + Fixed bug where the information dictionary returned by + :meth:`~.maps.digitizers.templates.HDFMapDigiTemplate.construct_dataset_name` + could modify the + :attr:`~.maps.digitizers.templates.HDFMapDigiTemplate.configs` dictionary + if the information dictionary were to be modified. (`#186 `_) + + +Documentation Improvements +-------------------------- + +- Created the "Package Features" section in the RTD sidebar. (`#181 `_) +- Created documentation stub files for the `bapsflib.phys180E` sub-module. (`#183 `_) +- Added `bapsflib.phys180E` to the "Package Features" section of the + documentation sidebar. (`#183 `_) +- Removed `sphinx` extension `sphinx-hoverxref`, and replaced with the + `Read the Docs addon "Link previews" + `_\ . (`#188 `_) +- Integrated the `plasmapy_sphinx` extensions and theme: + `plasmapy_sphinx.ext.autodoc`, `plasmapy_sphinx.ext.directives`, and + `plasmapy_sphinx.theme`. (`#188 `_) +- Re-titled the sidebar section names to be **First Steps**, + **Package Features**, **Developer Documentation**, and **All the Rest**. (`#188 `_) +- Dropped the explicit use of the :rst:role:`py:obj`, :rst:role:`py:mod`, and + :rst:role:`py:class` roles in favor of just using single back-ticks. (`#188 `_) +- Dropped the explicit use of the :rst:role:`code` role in favor of just + using double back-ticks. (`#188 `_) +- Removed documentation stub file + :file:`api_static/bapsflib.lapd.ConType.rst`. (`#188 `_) +- Added the `nbsphinx` extension to the documentation. (`#190 `_) +- Created an example notebook for the `bapsflib.phys180e.File` + functionality, and placed it in the "First Steps" section of the + sidebar. (`#190 `_) +- Set the documentation theme to ``plasmapy_theme``. (`#191 `_) +- Removed unused documentation templates, ``docs/_templates/*``. (`#191 `_) +- Moved and renamed the CSS override file, + :file:`docs/_static/rtd_theme_overrides.css` -> + :file:`docs/_static/css/overrides.css`. (`#191 `_) +- Moved Sphinx role definitions from the :confval:`rst_prolog` + configuration variable to the ``setup()`` function using the + `~sphinx.application.Sphinx` `~sphinx.application.Sphinx.add_role` + method. (`#191 `_) + + +Trivial/Internal Changes +------------------------ + +- Added return annotations for key `~bapsflib._hdf.utils.file.File` + methods, `~bapsflib._hdf.utils.file.File.overview`, + `~bapsflib._hdf.utils.file.File.read_controls`, + `~bapsflib._hdf.utils.file.File.read_data`, and + `~bapsflib._hdf.utils.file.File.read_msi`. This was done on both + `bapsflib._hdf.utils.file.File` and `bapsflib.lapd._hdf.file.File`. (`#182 `_) +- Replaced some instances of the ``Union[]`` annotation with the newer + pipe ``|`` notation. (`#182 `_) +- Forced mapped board and channel values for + `~bapsflib._hdf.maps.digitizers.sis3301.HDFMapDigiSIS3301` to be type + `int` instead of `numpy.integer`. (`#184 `_) +- .. py:currentmodule:: bapsflib._hdf + + Updated method :meth:`~.utils.file.File.get_digitizer_specs` to generate + the information dictionary using the + `~.maps.digitizers.templates.HDFMapDigiTemplate` method + :meth:`~.maps.digitizers.templates.HDFMapDigiTemplate.construct_dataset_name` + instead of + :meth:`~.maps.digitizers.templates.HDFMapDigiTemplate.get_adc_info` + to maintain consistency with the + :attr:`~.utils.hdfreaddata.HDFReadData.info` dictionary generated by + `~.utils.hdfreaddata.HDFReadData`. (`#186 `_) + + +Package Management +------------------ + +- Bumped `black` version from ``==v24.3.0`` to ``==v26.3.1``. (`#178 `_) +- Removed documentation dependency `sphinx-hoverxref`. (`#188 `_) +- Added documentation dependency `plasmapy_sphinx`. (`#188 `_) +- Made `nbsphinx`, `ipykernel`, and `matplotlib` documentation + dependencies. (`#190 `_) +- Update :file:`.readthedocs.yml` so the Read the Docs documentation + builds are done with Python 3.14. (`#191 `_) From 53b11458ee7620bed13e0d29b6216f214d3145dc Mon Sep 17 00:00:00 2001 From: Erik Date: Tue, 31 Mar 2026 21:24:30 -0700 Subject: [PATCH 2/3] add 2026.3.1 change log to the toctree and remove the dev change log --- docs/changelog/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changelog/index.rst b/docs/changelog/index.rst index 0639b7f1..0d444a53 100644 --- a/docs/changelog/index.rst +++ b/docs/changelog/index.rst @@ -9,7 +9,7 @@ This document lists the changes made for each release of `bapsflib`. .. toctree:: :titlesonly: - dev + 2026.3.1 2026.3.0 2025.6.0 2025.3.0 From 5ec018b4239dfdaf4a283d295bd51530577a53e5 Mon Sep 17 00:00:00 2001 From: Erik Date: Tue, 31 Mar 2026 21:31:50 -0700 Subject: [PATCH 3/3] put the dev change log page back in the toctree --- docs/changelog/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/changelog/index.rst b/docs/changelog/index.rst index 0d444a53..9bdf2932 100644 --- a/docs/changelog/index.rst +++ b/docs/changelog/index.rst @@ -9,6 +9,7 @@ This document lists the changes made for each release of `bapsflib`. .. toctree:: :titlesonly: + dev 2026.3.1 2026.3.0 2025.6.0