core.options

core.options

Global runtime options for xmris, mirroring :func:xarray.set_options.

Classes¶

Name	Description
set_options	Set global xmris options, either permanently or within a context.

core.options.set_options(**kwargs)

Set global xmris options, either permanently or within a context.

Name	Type	Description	Default
auto_convert	bool	When `True` (the default), domain-decorated operations transform their input into the required physical domain automatically — the funnel (`@ensures_domain`) and domain-preserving (`@computes_in`) contracts. When `False`, xmris runs strict: a domain mismatch raises an actionable error instead of converting, so every Fourier transform in a pipeline is written explicitly. Recommended for quantitative work.	required

Temporarily, as a context manager::

with xmris.set_options(auto_convert=False):
    fid.xmr.autophase()   # raises: convert with .xmr.to_spectrum() first

Or globally::

xmris.set_options(auto_convert=False)