xarray.set_options
xarray.set_options¶
-
class
xarray.
set_options
(**kwargs)[source]¶ Set options for xarray in a controlled context.
- Parameters
arithmetic_join (
{"inner", "outer", "left", "right", "exact"}
, default:"inner"
) – DataArray/Dataset alignment in binary operations.cmap_divergent (
str
ormatplotlib.colors.Colormap
, default:"RdBu_r"
) – Colormap to use for divergent data plots. If string, must be matplotlib built-in colormap. Can also be a Colormap object (e.g. mpl.cm.magma)cmap_sequential (
str
ormatplotlib.colors.Colormap
, default:"viridis"
) – Colormap to use for nondivergent data plots. If string, must be matplotlib built-in colormap. Can also be a Colormap object (e.g. mpl.cm.magma)display_expand_attrs (
{"default", True, False}
:
) – Whether to expand the attributes section for display ofDataArray
orDataset
objects. Can beTrue
: to always expand attrsFalse
: to always collapse attrsdefault
: to expand unless over a pre-defined limit
display_expand_coords (
{"default", True, False}
:
) – Whether to expand the coordinates section for display ofDataArray
orDataset
objects. Can beTrue
: to always expand coordinatesFalse
: to always collapse coordinatesdefault
: to expand unless over a pre-defined limit
display_expand_data (
{"default", True, False}
:
) – Whether to expand the data section for display ofDataArray
objects. Can beTrue
: to always expand dataFalse
: to always collapse datadefault
: to expand unless over a pre-defined limit
display_expand_data_vars (
{"default", True, False}
:
) – Whether to expand the data variables section for display ofDataset
objects. Can beTrue
: to always expand data variablesFalse
: to always collapse data variablesdefault
: to expand unless over a pre-defined limit
display_max_rows (
int
, default:12
) – Maximum display rows.display_style (
{"text", "html"}
, default:"html"
) – Display style to use in jupyter for xarray objects.display_width (
int
, default:80
) – Maximum display width forrepr
on xarray objects.file_cache_maxsize (
int
, default:128
) – Maximum number of open files to hold in xarray’s global least-recently-usage cached. This should be smaller than your system’s per-process file descriptor limit, e.g.,ulimit -n
on Linux.keep_attrs (
{"default", True, False}
) – Whether to keep attributes on xarray Datasets/dataarrays after operations. Can beTrue
: to always keep attrsFalse
: to always discard attrsdefault
: to use original logic that attrs should only be kept in unambiguous circumstances
use_bottleneck (
bool
, default:True
) – Whether to usebottleneck
to accelerate 1D reductions and 1D rolling reduction operations.warn_for_unclosed_files (
bool
, default:False
) – Whether or not to issue a warning when unclosed files are deallocated. This is mostly useful for debugging.
Examples
It is possible to use
set_options
either as a context manager:>>> ds = xr.Dataset({"x": np.arange(1000)}) >>> with xr.set_options(display_width=40): ... print(ds) ... <xarray.Dataset> Dimensions: (x: 1000) Coordinates: * x (x) int64 0 1 2 ... 998 999 Data variables: *empty*
Or to set global options:
>>> xr.set_options(display_width=80) <xarray.core.options.set_options object at 0x...>
Methods
__init__
(**kwargs)Initialize self.