Ctrl+K

Options (options)

Options (options)#

Classes:

Options

Options.

OptionsReq

Options with required parameters.

Validators

Validators.

set_options(**kwargs)

Set options for xarray in a controlled context.
class lnpy.options.Options[source]#

Bases: TypedDict

Options.

class lnpy.options.OptionsReq[source]#

Bases: TypedDict

Options with required parameters.

class lnpy.options.Validators[source]#

Bases: TypedDict

Validators.

class lnpy.options.set_options(**kwargs)[source]#

Bases: object

Set options for xarray in a controlled context. Currently supported options:

  • tqdm_use : if True, use progress bar where appropriate

  • tqdm_len_calc : min length for using bar in calculations of properties

  • tqdm_len_build : min length for building Collection objects

  • tqdm_leave : if True, leave bar after execution. Default=False

  • joblib_use : if True, use joblib

  • joblib_n_jobs : number of processors to use, default=all processors

  • joblib_backend : backend to use. Default=’multiprocessing’.

  • joblib_kws : dictionary of arguments to joblib.Parallel.

  • joblib_len_calc : min length to use parallel in calculations

  • joblib_len_build : min length to use parallel in build

Examples

You can use set_options either as a context manager:

>>> import lnpy
>>> with lnpy.set_options(use_tqdm=True, tqdm_min_len_calc=50):  
...     c.xge.betaOmega()

Or to set global options:

>>> _ = lnpy.set_options(tqdm_len_calc=50)
Contents