x01dcandClaude Sonnet 5
3eb6e0355f
Diagnosed against a real scan (S06313): grouping raw interf_st_fzp_x/_y samples by frame_counter + gate_detector_active reproduces rt_positions' trusted average_x_st_fzp/_y to R² > 0.9999, confirming that method -- but one point (167) was off by ~116 nm because PandA's COUNTER1.OUT is not cleared by Arm(). The first raw samples of an acquisition can briefly carry a stale frame_counter value left over from the previous acquisition's tail (observed: 36 samples reading a stale 167 before dropping to 0), which silently contaminates whichever real point later in the same scan happens to share that counter value. PandaBoxOMNY now drops raw rows captured before it observes frame_counter == 0 for the first time in each acquisition -- on every arm, including on_pre_scan retries, since each Arm() reopens the same stale-value window -- and drops leftover buffered rows from an abandoned attempt at the same point. Verified against S06313: point 167's residual drops from ~116 nm to ~0.1 nm after the fix, in line with the rest of the scan. Write-up, including the diagnostic method and a possible PandA-layout-level alternative fix, in docs/developer/panda_box_free_running_setup.md. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NPZ9gzN2rt3wgiMnTKyrug
Getting Started with Testing using pytest
BEC is using the pytest framework. It can be installed via
pip install pytest
in your python environment.
We note that pytest is part of the optional-dependencies [dev] of the plugin package.
Introduction
Tests in this package should be stored in the tests directory.
We suggest to sort tests of different submodules, i.e. scans or devices in the respective folder structure, and to folow a naming convention of <test_module_name.py>.
It is mandatory for test files to begin with test_ for pytest to discover them.
To run all tests, navigate to the directory of the plugin from the command line, and run the command
pytest -v --random-order ./tests
Note, the python environment needs to be active.
The additional arg -v allows pytest to run in verbose mode which provides more detailed information about the tests being run.
The argument --random-order instructs pytest to run the tests in random order, which is the default in the CI pipelines.
Test examples
Writing tests can be quite specific for the given function. We recommend writing tests as isolated as possible, i.e. try to test single functions instead of full classes. A very useful class to enable isolated testing is MagicMock. In addition, we also recommend to take a look at the How-to guides from pytest.