Skip to content

[Essimaging]: Do not allow nbsphinx errors in docs builds #248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nvaytet merged 3 commits into from
Mar 17, 2026
Merged

[Essimaging]: Do not allow nbsphinx errors in docs builds #248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4ba1ce6
do not allow nbshinx errors in docs builds for essimaging
nvaytet Mar 17, 2026
1ba8bef
add threshold for lut as Inf default in Odin and TBL workflows
nvaytet Mar 17, 2026
ab6c4d7
add missing import for threshold type
nvaytet Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions packages/essimaging/docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,6 @@
except ModuleNotFoundError:
pass

nbsphinx_allow_errors = True

myst_enable_extensions = [
"amsmath",
"colon_fence",
Expand Down
1 change: 1 addition & 0 deletions packages/essimaging/src/ess/imaging/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
PulseStrideOffset = tof_t.PulseStrideOffset
TimeOfFlightLookupTable = tof_t.TimeOfFlightLookupTable
TimeOfFlightLookupTableFilename = tof_t.TimeOfFlightLookupTableFilename
LookupTableRelativeErrorThreshold = tof_t.LookupTableRelativeErrorThreshold

UncertaintyBroadcastMode = _UncertaintyBroadcastMode

Expand Down
8 changes: 8 additions & 0 deletions packages/essimaging/src/ess/odin/workflows.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
BeamMonitor3,
BeamMonitor4,
DarkBackgroundRun,
LookupTableRelativeErrorThreshold,
NeXusMonitorName,
OpenBeamRun,
PulseStrideOffset,
Expand All @@ -29,6 +30,13 @@ def default_parameters() -> dict:
NeXusMonitorName[BeamMonitor3]: "beam_monitor_3",
NeXusMonitorName[BeamMonitor4]: "beam_monitor_4",
PulseStrideOffset: None,
LookupTableRelativeErrorThreshold: {
"event_mode_detectors/timepix3": float('inf'),
"beam_monitor_1": float('inf'),
"beam_monitor_2": float('inf'),
"beam_monitor_3": float('inf'),
"beam_monitor_4": float('inf'),
},
}


Expand Down
8 changes: 8 additions & 0 deletions packages/essimaging/src/ess/tbl/workflow.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
from ..imaging.conversion import providers as conversion_providers
from ..imaging.types import (
BeamMonitor1,
LookupTableRelativeErrorThreshold,
NeXusMonitorName,
PulseStrideOffset,
SampleRun,
Expand All @@ -20,6 +21,13 @@ def default_parameters() -> dict:
return {
NeXusMonitorName[BeamMonitor1]: "monitor_1",
PulseStrideOffset: None,
LookupTableRelativeErrorThreshold: {
"timepix3_detector": float('inf'),
"ngem_detector": float('inf'),
"he3_detector_bank0": float('inf'),
"he3_detector_bank1": float('inf'),
"monitor_1": float('inf'),
},
}


Expand Down
4 changes: 0 additions & 4 deletions packages/essimaging/tests/odin/data_reduction_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@

import pytest
import sciline as sl
from ess.reduce.time_of_flight import LookupTableRelativeErrorThreshold

import ess.odin.data # noqa: F401
from ess import odin
Expand All @@ -30,9 +29,6 @@ def workflow() -> sl.Pipeline:
wf[Filename[OpenBeamRun]] = odin.data.iron_simulation_ob_small()
wf[NeXusDetectorName] = "event_mode_detectors/timepix3"
wf[TimeOfFlightLookupTableFilename] = odin.data.odin_tof_lookup_table()
wf[LookupTableRelativeErrorThreshold] = {
Copy link
Member Author

@nvaytet nvaytet Mar 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are now set as default in the workflow, so it is no longer needed here.

"event_mode_detectors/timepix3": float('inf')
}
# Cache the lookup table
wf[TimeOfFlightLookupTable] = wf.compute(TimeOfFlightLookupTable)
return wf
Expand Down
5 changes: 0 additions & 5 deletions packages/essimaging/tests/tbl/data_reduction_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,6 @@ def workflow() -> sl.Pipeline:
wf = tbl.TblWorkflow()
wf[Filename[SampleRun]] = tbl.data.tutorial_sample_data()
wf[TimeOfFlightLookupTableFilename] = tbl.data.tbl_tof_lookup_table_no_choppers()
wf[time_of_flight.LookupTableRelativeErrorThreshold] = {
"ngem_detector": float('inf'),
"he3_detector_bank0": float('inf'),
"he3_detector_bank1": float('inf'),
}
return wf


Expand Down
Loading