Skip to content

Add example jupyter notebook for bapsflib.phys180e#190

Merged
rocco8773 merged 47 commits intoBaPSF:masterfrom
rocco8773:docs_phys180e
Apr 1, 2026
Merged

Add example jupyter notebook for bapsflib.phys180e#190
rocco8773 merged 47 commits intoBaPSF:masterfrom
rocco8773:docs_phys180e

Conversation

@rocco8773
Copy link
Copy Markdown
Member

@rocco8773 rocco8773 commented Mar 31, 2026

The PR adds an example jupyter notebook for the bapsflib.phys180e.File functionality. In doing so nbsphinx was add as a documentation dependency.


  • Added example jupyter notebook for the bapsflib.phys180e.File functionality. The notebook is added to the "First Steps" section of the documentation sidebar.
  • Added nbsphinx as a documentation dependency, and configured nbspinx for documentation builds.
  • Added documentation dependencies ipykernel and matplotlib.

…icitly import from bapsflib._hdf.maps.tests instead
# Conflicts:
#	bapsflib/_hdf/maps/controls/bmotion.py
#	bapsflib/_hdf/maps/controls/tests/common.py
#	bapsflib/_hdf/maps/controls/tests/test_map_controls.py
#	bapsflib/_hdf/maps/controls/tests/test_templates.py
#	bapsflib/_hdf/maps/digitizers/tests/common.py
#	bapsflib/_hdf/maps/digitizers/tests/test_map_digis.py
#	bapsflib/_hdf/maps/digitizers/tests/test_templates.py
#	bapsflib/_hdf/maps/msi/tests/common.py
#	bapsflib/_hdf/maps/msi/tests/test_map_msi.py
#	bapsflib/_hdf/maps/msi/tests/test_templates.py
#	bapsflib/_hdf/maps/tests/test_templates.py
#	bapsflib/_hdf/utils/hdfreaddata.py
#	docs/hdfmap/mapping.inc.rst
#	docs/using_lapd/file_afteropen.inc.rst
#	docs/using_lapd/file_mappings.inc.rst
#	docs/using_lapd/file_openfile.inc.rst
#	docs/using_lapd/file_overview.inc.rst
#	docs/using_lapd/read_from_digi.inc.rst
#	docs/using_lapd/read_from_msi.inc.rst
@rocco8773 rocco8773 added the documentation things to add to documentation label Mar 31, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 31, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.86%. Comparing base (f951589) to head (bcbb31f).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #190   +/-   ##
=======================================
  Coverage   98.86%   98.86%           
=======================================
  Files          54       54           
  Lines        3772     3772           
  Branches      727      727           
=======================================
  Hits         3729     3729           
  Misses         39       39           
  Partials        4        4           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@rocco8773 rocco8773 merged commit 10d9cd2 into BaPSF:master Apr 1, 2026
24 checks passed
@rocco8773 rocco8773 deleted the docs_phys180e branch April 1, 2026 04:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation things to add to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant