# Release Notes¶

## v0.11.0 (unreleased)¶

### Features¶

### Breaking changes¶

### Bugfixes¶

### Deprecations¶

### Stability, Maintainability, and Testing¶

### Contributors¶

Simon Heybrock ^{a},
Neil Vaytet ^{a},
Tom Willemsen ^{b, c},
and Jan-Lukas Wynen ^{a}

## v0.10.0 (December 2021)¶

### Features¶

### Bugfixes¶

Fix kernel crash or poor performance when using

`bin`

or`da.bins.concat`

along an inner dimension in the presence of a long outer dimension #2278.Improved the rendering of cut slices in 3d plots where some strange artifacts could appear depending on the order in which the pixels were being drawn #2287.

### Deprecations¶

The deprecated

`events`

property has been removed.

### Stability, Maintainability, and Testing¶

### Contributors¶

Simon Heybrock ^{a},
Neil Vaytet ^{a},
Tom Willemsen ^{b, c},
and Jan-Lukas Wynen ^{a}

## v0.9.0 (November 2021)¶

### Features¶

Added

`erf`

and`erfc`

functions #2195.Reduction operations such as

`sum`

,`nansum`

, and`cumsum`

of single precision (float32) data now use double precision (float64) internally to reduce rounding errors #2218.Added

`bins_like`

for broadcasting dense variables to binned variables, e.g., for converting bin coordinates into event coordinates #2225.`groupby`

now also supports grouping by attributes instead of just by coordinates #2227.Added

`concat`

to replace`concatenate`

. In contrast to the now deprecated`concatenate`

,`concat`

supports concatenation of lists of objects instead of just two objects #2232.Added

`dim`

property to`Variable`

and`DataArray`

#2251.Added preconfigured logging support including a widget for output to notebooks #2255, #2267.

Added

`reduce`

for setting up reductions across a list of inputs #2267.Added toggle buttons for hiding/showing the 3d axes and outline box in 3d plots #2265.

### Breaking changes¶

### Bugfixes¶

Fix bugs in

`rebin`

if data and/or edges had strides other than 1 along rebinned dimension, typically only occuring with multi-dimensional (ragged) coordinates #2211.Fix exception that was thrown when importing empty datasets from HDF5 files using

`open_hdf5`

#2216.Fix exception in

`astype`

when called with binned data that does not require conversion #2222.Fix bug in

`concatenate`

that could lead to masks being shared with input rather than being copied #2232.Fix exception in

`bin`

when binning in a new dimension but with an existing bin coord #2237.Fix exception when plotting data with masks in presence of multi-dimensional coords #2269.

### Deprecations¶

`concatenate`

and`groupby(..).concatenate`

are deprecated. Use`concat`

and`groupby(..).concat`

instead.

### Stability, Maintainability, and Testing¶

More thorough unit testing for low-level code underlying most operations on dense as well as binned data #1900, by Jan-Lukas Wynen.

Switch to Jupyter Book theme for documentation, avoiding a number of issues with the RTD theme #2233, by Neil Vaytet.

Added benchmark suite to allow for identification of performance regressions, by Samuel Jones.

Added code coverage tooling to allow for identification of dark spots in our test coverage, by Simon Heybrock.

### Contributors¶

Owen Arnold ^{b, c},
Simon Heybrock ^{a},
Samuel Jones ^{b},
Neil Vaytet ^{a},
Tom Willemsen ^{b, c},
and Jan-Lukas Wynen ^{a}

## v0.8.3 (September 2021)¶

## v0.8.0 (September 2021)¶

### Features¶

Added

`sizes`

argument to`zeros`

,`ones`

, and`empty`

variable creation functions #1951.Slicing syntax now supports ellipsis, e.g.,

`da.data[...] = var`

#1961.Added bound method equivalents to many free functions which take a single Variable or DataArray #1969.

Variables can now be constructed directly from multi dimensional lists and tuples #1977.

Plotting 1-D event data is now supported #2018.

Add

`transform_coords`

for (multi-step) transformations based on existing coords, with support of event coords #2058.Add

`from_pandas`

and`from_xarray`

for conversion of pandas dataframes, xarray data arrays and dataset to scipp objects #2054.Added

`full`

and`full_like`

variable creation functions #2069.`islinspace`

can now take multi-dimensional variables aslong as you pass the dimension to be checked #2094.Added a power function and support for the

`**`

operator #2083.Binned data now has a

`mean`

method as well as`sum`

, which returns the mean of each element within a bin.Add

`scipp.constants`

module for physical constants #2101.Add

`scipp.spatial.transform`

module providing`from_rotvec`

and`as_rotvec`

#2102.Add

`cross`

function to complementing existing`dot`

function #2109.The

`fields`

property of structured variables (vector and matrix dtypes) can now be iterated and provides dict-like access #2116.Add

`where`

function.Unary operations such as

`sin`

are now available for datasets as well #2112.Add rounding functions

`floor`

,`ceil`

, and`round`

that performs similarly to numpy equivelants #2147.

### Breaking changes¶

Changed names of arithmetic functions to match numpy’s names:

`plus`

→`scipp.add()`

,`minus`

→`scipp.subtract()`

,`times`

→`scipp.multiply()`

#1999.Changed Variable init method, all arguments are keyword-only, special overloads which default-initialize data were removed #1994.

The

`axes`

keyword arg of`plot`

has been removed. Use`labels`

to define labels and`transpose`

to transpose instead #2018.The

`redraw`

method of plots does not support replacing data variables of data arrays any more, but only updates of data values #2018.Made most arguments of

`DataArray`

and`Dataset`

constructors keyword-only #2008.Made arguments of many functions keyword-only, e.g. constructors of

`DataArray`

and`Dataset`

,`bin`

, and`atan2`

#1983, #2008, #2012.`astype`

and`to_unit`

now copy the input by default even when no transformation is required, use the new`copy`

argument to avoid #2016.`rename_dims`

does not rename dimension-coords any more, only dims will be renamed #2058.`rename_dims`

does not modify the input anymore but returns a new object with renamed dims #2058.`issorted`

and`islinspace`

return a variable of type boolean instead of a boolean #2094.Multi-dimensional coordinates are no longer associated with their inner dimension, which affects the behavior when slicing: Such coords will no longer be turned into attributes during a slice operation on the inner dimension #2098.

`buckets.map(histogram, da.data, 'time')`

has been replaced by`lookup(histogram, 'time')[da.bins.coords['time']]`

#2112.`rebin`

and`histogram`

now support any unit.`plot()`

guesses which resampling mode to use and provides a button to toggle this #2180.

### Bugfixes¶

### Deprecations¶

The

`events`

property is deprecated and is scheduled for removal with v0.9.

### Contributors¶

Owen Arnold ^{b, c},
Simon Heybrock ^{a},
Samuel Jones ^{b},
Greg Tucker ^{a},
Neil Vaytet ^{a},
Tom Willemsen ^{b, c},
and Jan-Lukas Wynen ^{a}

## v0.7.2 (September 2021)¶

## v0.7.0 (June 2021)¶

### Features¶

Licence changed from GPLv3 to BSD-3-Clause.

Can now control the position and visibility of the legend in 1d plots with

`plot(da, legend={"show": True, "loc": 4})`

#1790.Added

`zeros_like`

,`ones_like`

and`empty_like`

functions #1864.`sort`

is now considerably faster for data with more rows #1872.Added numpy-like

`linspace`

,`logspace`

,`geomspace`

, and`arange`

variable creation functions #1871.`to_unit`

now supports binned data #1841.`broadcast`

now returns a view instead of copying #1861.`fold`

now returns a view instead of copying #1861.`fold`

now works for binned data #1861.`flatten`

now returns a view of the input buffer if the input data is contiguous #1861.Add

`redraw`

method to plot which enables an easy update on a figure when the underlying data has been modified #1907.Several improvements for work with (3-D position) vectors and (3-D rotation) matrices #1905:

Add creation functions

`vector`

,`vectors`

,`matrix`

,`matrices`

.Direct creation and initialization of 2-D (or higher) arrays of matrices and vectors is now possible from numpy arrays.

Fix extremely slow initialization of array of vectors or matrices from numpy arrays.

The

`values`

property now returns a numpy array with`ndim+1`

(vectors) or`ndim+2``

(matrices) axes, with the inner 1 (vectors) or 2 (matrices) axes corresponding o the vector or matrix axes.Vector or matrix element can now be accessed and modified directly using the new

`fields`

property of`Variable`

. The`fields`

property provides properties`x`

,`y`

,`z`

(for variables containing vectors) or`xx`

,`xy`

, …,`zz`

(for matrices) that can be read as well as set.

Reduction operations such as

`sum`

and`mean`

are now also multi-threaded and thus considerably faster #1923.

### Bugfixes¶

Profile plots are no longer disabled for binned data with only a single bin in the 3rd dimension #1936.

### Breaking changes¶

Scipp’s data structures now behave mostly like normal nested Python objects, i.e., copies are shallow by default #1823.

`filter`

and`split`

removed. Identical functionality can be achieved using`groupby`

and/or slicing.`reshape`

has been removed. Use`fold`

and`flatten`

instead #1861.`geometry.x`

,`geometry.y`

, and`geometry.z`

have been removed. Use the`Variable.fields`

property instead #1925.

### Contributors¶

Owen Arnold ^{b, c},
Simon Heybrock ^{a},
Matthew D. Jones ^{b, c},
Neil Vaytet ^{a},
and Jan-Lukas Wynen ^{a}

## v0.6.1 (April 2021)¶

### Bugfixes¶

`map`

and`scale`

operations as well as`histogram`

for binned data now also work with`datetime64`

#1834.`bin`

now works on previously binned data with 2-D edges, even if the outer dimensions(s) are not rebinned #1836.`bin`

and`histogram`

now work with`int32`

-valued coordinates and support binning with`int64`

- or`int32`

-valued bin edges.

## v0.6.0 (March 2021)¶

### Features¶

Add

`sizes`

properties, an ordered`dict`

to lookup the size of a specific dimension #1636.Add access to data, coords, attrs, and masks of bins via the

`bins`

property, e.g.,`obj.bins.coords['x']`

#1752.Add more functions for data arrays that were previously available only for variables #1638 #1660.

Add named versions of operators such as

`logical_and`

#1660.Add

`to_unit`

to converter variables, e.g., between`m`

and`mm`

#1756.Add modulo operations #1660.

Add scaling operations for Variables of type

`vector_3_float64`

.`sum`

and`mean`

implemented for Variables of type`vector_3_float64`

.Add

`fold`

and`flatten`

which allow to reshape dimensions of a Variable or DataArray #1676.It is now possible to reshape a Variable also with

`sc.reshape(var, sizes={'x': 2, 'y': 3})`

, in addition to`sc.reshape(var, dims=['x', 'y'], shape=(2, 3))`

.Add

`ones`

and`empty`

creation functions, similar to what is known from numpy #1732.`scipp.neutron`

has been removed and is replaced by scippneutron`scipp.neutron`

(now`scippneutron`

)`isclose`

added (`is_approx`

removed). Fuzzy data comparison`isclose`

is an analogue to numpy’s`isclose`

`stddevs`

added #1762.Support for datetime

### Breaking changes¶

The

`plot`

module has been renamed to`plotting`

, and plotting is now achieved via`sc.plot(data)`

. Wrapper functions`superplot`

,`image`

, and`scatter3d`

have been dropped #1696.Properties

`dim`

,`begin`

,`end`

, and`data`

of the`bins`

property of and object are now accessible as a dict via`obj.bins.constituents`

.`scipp.neutron`

has been removed and is replaced by scippneutron`scipp.neutron`

(now`scippneutron`

)`is_equal`

renamed`identical`

`is_linspace`

renamed`islinspace`

`is_sorted`

renamed`issorted`

`is_approx`

superseded by`isclose`

.`is_approx`

removed.Removed support for facility-specific

`convert_with_calibration`

and`load_calibration`

### Contributors¶

Matthew Andrew, Owen Arnold, Simon Heybrock, Matthew D. Jones, Andrew McCluskey, Neil Vaytet, and Jan-Lukas Wynen

## v0.5.0 (January 2021)¶

### Features¶

New

`profile`

plotting functionality where one of the slider dimensions can be displayed as a profile in a subplot (1-D and 2-D projections only).Sliders have a thickness slider associated with them and can be used to show slices of arbitrary thickness.

Can hide/show individual masks on plots.

Can toggle log scale of axes and colorbar with buttons in figure toolbar.

Add binned data support, replacing “event list” dtypes as well as “realign” support.

Plotting of event data (binned data) with dynamic resampling with “infinite zoom” functionality.

Value-based slicing support.

Possibility to plot Scipp objects using

`my_data_array.plot()`

in addition to the classical`plot()`

free function.Support for saving and loading scipp data structures to HDF5.

More functions such as

`nanmean`

for better handling of special values such as`INF`

and`NaN`

.TBB (multi-threading) support for MacOS.

`scipp.neutron`

Improved instrument view, e.g., with buttons to align camera with an axis.

Experiment logs (previously using Mantid’s

`Run`

) are now represented as native scipp objects, e.g., as scalar attributes holding a data array representing a time-series such as a temperature log.Support conversion of

`mantid.MaskWorkspace`

.

### Breaking changes¶

`Dataset`

does not have a`masks`

property any more. Use`ds['item'].masks`

instead.`Dataset`

does not support attributes any more.`DataArray`

and dataset item attributes are now are now handled as “unaligned” coords. Use`ds['item'].coords`

or`array.attrs`

to access these.API for log scale on axes and colors has changed. Use

`plot(da, scale={'tof': 'log'})`

to set a log scale on a coordinate axis, and use`plot(da, norm='log')`

to have a log image colorscale or a log y axis on a 1d plot.`vmin`

and`vmax`

now represent absolute values instead of exponents when`norm='log'`

.The

`ipympl`

matplotlib backend is now required for using inside Jupyter notebooks. This has been added as a dependency. It is also the only interactive backend that works in JupyterLab.Removed support for

`event_list`

`dtype`

, use binned data instead.Removed support for “realigned” data. This is replaced by the more flexible and generic support for “binned” data.

### Contributors¶

Matthew Andrew, Owen Arnold, Thibault Chatel, Simon Heybrock, Matthew D. Jones, Daniel Nixon, Piotr Rozyczko, Neil Vaytet, and Jan-Lukas Wynen

## v0.4 (July 2020)¶

### Features¶

New realign functionality.

Support for event-filtering.

Support for subtraction and addition for (realigned) event data.

Non-range slicing changed to preserve coords as attrs rather than dropping

`scipp.neutron`

: Instrument view with advanced geometry support, showing correct pixel shapes.Instrument view working on doc pages.

Made it simpler to add new

`dtype`

and support`transform`

for all types.Comparison functions such as

`less`

,`greater_equal`

, …`all`

and`any`

can work over all dimensions as well as explicitly provided dimension argumentIt is now possible to convert between Scipp objects and Python dictionaries using

`to_dict`

and`from_dict`

.New functions

`collapse`

and`slices`

can be use to split one or more dimensions of a DataArray to a dict of DataArrays.You can now inspect the global object list of via the

`repr`

for scipp showing Datasets, DataArrays and VariablesInternal cleanup and documentation additions.

### Noteable bug fixes¶

Several fixes in the plotting (non-regular bins, colorbar limits, axes tick labels from unaligned coordinates, etc…)

### Breaking changes¶

Coord and attributes names for neutron data have been standardized, now using hyphens instead of underscore, except for subscripts. Affected examples:

`pulse-time`

(previously`pulse_times`

),`source-position`

(previously`source_position`

),`sample-position`

(previously`sample_position`

),`detector-info`

(previously`detector_info`

).`scipp.neutron.load`

must use`advanced_geometry=True`

option for loading`detector-info`

and pixel shapes.Normalization of event data cannot be done directly any more, must use

`realign`

.Plotting variances in 2D has been removed, and the API for using

`matplotlib`

axes has been simplified slightly, since we no longer have axes for variances:Before:

`plot(..., mpl_axes={"ax": myax0, "cax": myax1})`

After:

`plot(..., ax=myax0, cax=myax1)`

Plot with keyword argument

`collapse`

has been removed in favor of two more generic free functions that return a`dict`

of data arrays that can then directly be passed to the`plot`

function:`collapse(d, keep='x')`

slices all dimensions away to keep only`'x'`

, thus always returning 1D slices.`slices(d, dim='x')`

slices along dimension`'x'`

, returning slices with`ndim-1`

dimensions contaiing all dimensions other than`'x'`

.

### Contributors¶

Owen Arnold, David Fairbrother, Simon Heybrock, Daniel Nixon, Pawel Ptasznik, Piotr Rozyczko, and Neil Vaytet

## v0.3 (March 2020)¶

Many bug fixes and small additions

Multi-threading with TBB for many operations.

Performance improvements in hotspots

Remove

`Dim`

labels in favor of plain strings. Connected to this, the`labels`

property for data arrays and datasets has been removed. Use`coords`

instead.Start to support

`out`

arguments (not everywhere yet)`scipp.neutron`

: Instrument view added

Contributors in this release: Owen Arnold, Simon Heybrock, Daniel Nixon, Dimitar Tasev, and Neil Vaytet

## v0.2 (December 2019)¶

Support for masks stored in

`DataArray`

and`Dataset`

.Support for

`groupby`

, implementing a split-apply-combine approach as known from pandas.Enhanced support for event data:

Histogramming with “weighted” data.

Multiplication/division operators between event data and histogram.

Enhanced plotting support:

Now focussing on

`matplotlib`

.Multi-dimensional plots with interactive sliders, and much more.

Significant performance improvements for majority of operations. Typically performance is now in the same ballpark as what the memory bandwidth on a single CPU core can support.

Fancy

`_repr_html_`

for quick views of datasets in Jupyter notebooks.Conda packages now also available for Windows.

`scipp.neutron`

gets improved converters from Mantid, supporting neutron monitors, sample information, and run information stored as attributes.

Contributors in this release: Owen Arnold, Igor Gudich, Simon Heybrock, Daniel Nixon, Dimitar Tasev, and Neil Vaytet

## v0.1 (September 2019)¶

This is the first official release of `scipp`

.
It is not yet meant for production-use, but marks a big step for us in terms of usability and features.
The API may change without notice in future releases.

Features:

All key data structures (

`Variable`

,`DataArray`

, and`Dataset`

).Slicing.

Basic arithmetic operations.

Physical units.

Propagation of uncertainties.

Event data.

Limitations:

Limited performance and no parallelization.

Numerous “edge cases” not supported yet.

While tested, probably far from bug-free.

## Contributing Organizations¶

^{a}European Spallation Source ERIC, Sweden^{c}Tessella, UK