Getting Started
Overview
Installation
Quick start
Frequently Asked Questions
User Guide
Data Structures
Slicing
Computation
Masking
Binned Data
Binned Data
Computation with Binned Data
Filtering
Histogramming, grouping, and binning
GroupBy
Coordinate transformations
Reading and Writing Files
How to…
Tips, tricks, and anti-patterns
Visualization
Representations and Tables
Plotting Overview
Plotting in depth
Plotting 1-D data
Plotting 2-D data
Plotting N-D data
Customizing figures
Datetime handling
Reference
Classes
scipp.Bins
scipp.DataArray
scipp.Dataset
scipp.GroupByDataArray
scipp.GroupByDataset
scipp.Unit
scipp.Variable
scipp.typing.VariableLike
scipp.typing.MetaDataMap
Creation functions
scipp.array
scipp.arange
scipp.empty
scipp.empty_like
scipp.full
scipp.full_like
scipp.geomspace
scipp.linspace
scipp.logspace
scipp.matrix
scipp.matrices
scipp.ones
scipp.ones_like
scipp.scalar
scipp.vector
scipp.vectors
scipp.zeros
scipp.zeros_like
Free functions
scipp.bin
scipp.bins
scipp.bins_like
scipp.choose
scipp.collapse
scipp.histogram
scipp.logical_and
scipp.logical_or
scipp.logical_xor
scipp.lookup
scipp.merge
scipp.rebin
scipp.reduce
scipp.slices
scipp.sort
scipp.stddevs
scipp.to_unit
scipp.transform_coords
scipp.values
scipp.variances
scipp.where
scipp.abs
scipp.add
scipp.ceil
scipp.cross
scipp.divide
scipp.dot
scipp.erf
scipp.erfc
scipp.exp
scipp.floor
scipp.floor_divide
scipp.log
scipp.log10
scipp.mod
scipp.multiply
scipp.norm
scipp.reciprocal
scipp.round
scipp.sqrt
scipp.subtract
scipp.broadcast
scipp.concat
scipp.concatenate
scipp.flatten
scipp.fold
scipp.transpose
scipp.allclose
scipp.allsorted
scipp.equal
scipp.greater
scipp.greater_equal
scipp.identical
scipp.isclose
scipp.islinspace
scipp.issorted
scipp.less
scipp.less_equal
scipp.not_equal
scipp.isnan
scipp.isinf
scipp.isfinite
scipp.isposinf
scipp.isneginf
scipp.nan_to_num
scipp.all
scipp.any
scipp.cumsum
scipp.max
scipp.mean
scipp.min
scipp.nanmax
scipp.nanmean
scipp.nanmin
scipp.nansum
scipp.sum
scipp.sin
scipp.cos
scipp.tan
scipp.asin
scipp.acos
scipp.atan
scipp.atan2
scipp.geometry.position
scipp.geometry.rotation_matrix_from_quaternion_coeffs
scipp.groupby
scipp.counts_to_density
scipp.density_to_counts
scipp.show
scipp.show_graph
scipp.table
scipp.to_html
scipp.plot
scipp.to_dict
scipp.from_dict
scipp.compat.from_pandas
scipp.compat.from_xarray
scipp.get_logger
scipp.display_logs
Modules
scipp.constants
scipp.constants.physical_constants
scipp.spatial
scipp.spatial.transform
scipp.spatial.transform.as_rotvec
scipp.spatial.transform.from_rotvec
scipp.logging
scipp.logging.clear_log_widget
scipp.logging.display_logs
scipp.logging.get_log_widget
scipp.logging.get_logger
scipp.logging.get_widget_handler
scipp.logging.make_log_widget
scipp.logging.make_stream_handler
scipp.logging.make_widget_handler
scipp.logging.WidgetHandler
Linear Algebra
Data types
Physical units
Propagation of uncertainties
Ownership mechanism and readonly flags
Logging
Runtime Configuration
Developer Documentation
Getting Started
API Reference
Architecture Decision Records
ADR 0001: Remove dataset masking support
ADR 0002: Remove instrument view 2D projection options
ADR 0003: Refactor plotting code to use Model-View-Controller design pattern
ADR 0004: Use the ipympl backend for Matplotlib figures in Jupyter
ADR 0005: Remove need for
bins
property when calling
bin
or
histogram
ADR 0006: Add read-only flags
ADR 0007: Do not support arguments referring to
x
or
y
ADR 0008: Consistent multi-dimensional coords
ADR 0009: Handle dimensionless as non-counts
ADR 0010: Acknowledge stability and maintainability tasks
Coding conventions
Concepts
C++ API for constructing variables
Customizing Scipp
Dependencies
Deployment
How To…
Multi-Dimensional Indexing
Tooling
Transforming data
Implementation of class Variable
Tutorials
1-D datasets and tables
Multi-dimensional datasets
About
About scipp
What’s new in scipp
Roadmap
Contributing to scipp
Release Notes
repository
open issue
Scipp version
latest
v0.10
v0.9
v0.8
v0.7
v0.6
v0.5
v0.4
v0.3
Related projects
scipp
scippneutron
ess
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
Z
_
__init__() (scipp.Bins method)
(scipp.DataArray method)
(scipp.Dataset method)
(scipp.GroupByDataArray method)
(scipp.GroupByDataset method)
(scipp.logging.WidgetHandler method)
(scipp.Unit method)
(scipp.Variable method)
A
abs() (in module scipp)
acos() (in module scipp)
add() (in module scipp)
all() (in module scipp)
(scipp.DataArray method)
(scipp.GroupByDataArray method)
(scipp.GroupByDataset method)
(scipp.Variable method)
allclose() (in module scipp)
allsorted() (in module scipp)
any() (in module scipp)
(scipp.DataArray method)
(scipp.GroupByDataArray method)
(scipp.GroupByDataset method)
(scipp.Variable method)
arange() (in module scipp)
array() (in module scipp)
as_rotvec() (in module scipp.spatial.transform)
asin() (in module scipp)
astype() (scipp.DataArray method)
(scipp.Variable method)
atan() (in module scipp)
atan2() (in module scipp)
attrs (scipp.Bins property)
(scipp.DataArray property)
B
bin() (in module scipp)
Bins (class in scipp)
bins (scipp.DataArray property)
(scipp.Dataset property)
(scipp.Variable property)
bins() (in module scipp)
bins_like() (in module scipp)
broadcast() (in module scipp)
(scipp.DataArray method)
(scipp.Variable method)
C
ceil() (in module scipp)
(scipp.DataArray method)
(scipp.Variable method)
choose() (in module scipp)
clear() (scipp.Dataset method)
clear_log_widget() (in module scipp.logging)
collapse() (in module scipp)
concat() (in module scipp)
(scipp.Bins method)
(scipp.GroupByDataArray method)
(scipp.GroupByDataset method)
concatenate() (in module scipp)
(scipp.Bins method)
constituents (scipp.Bins property)
coords (scipp.Bins property)
(scipp.DataArray property)
(scipp.Dataset property)
copy() (scipp.DataArray method)
(scipp.Dataset method)
(scipp.GroupByDataArray method)
(scipp.GroupByDataset method)
(scipp.Variable method)
cos() (in module scipp)
counts_to_density() (in module scipp)
cross() (in module scipp)
cumsum() (in module scipp)
(scipp.Variable method)
D
data (scipp.Bins property)
(scipp.DataArray property)
DataArray (class in scipp)
Dataset (class in scipp)
density_to_counts() (in module scipp)
dim (scipp.DataArray property)
(scipp.Variable property)
dims (scipp.DataArray property)
(scipp.Dataset property)
(scipp.Variable property)
display_logs() (in module scipp)
(in module scipp.logging)
divide() (in module scipp)
dot() (in module scipp)
dtype (scipp.DataArray property)
(scipp.Variable property)
E
emit() (scipp.logging.WidgetHandler method)
empty() (in module scipp)
empty_like() (in module scipp)
equal() (in module scipp)
erf() (in module scipp)
erfc() (in module scipp)
exp() (in module scipp)
F
fields (scipp.Variable property)
flatten() (in module scipp)
(scipp.DataArray method)
(scipp.Variable method)
floor() (in module scipp)
(scipp.DataArray method)
(scipp.Variable method)
floor_divide() (in module scipp)
fold() (in module scipp)
(scipp.DataArray method)
(scipp.Variable method)
format() (scipp.logging.WidgetHandler method)
from_dict() (in module scipp)
from_pandas() (in module scipp.compat)
from_rotvec() (in module scipp.spatial.transform)
from_xarray() (in module scipp.compat)
full() (in module scipp)
full_like() (in module scipp)
G
geomspace() (in module scipp)
get() (scipp.Dataset method)
get_log_widget() (in module scipp.logging)
get_logger() (in module scipp)
(in module scipp.logging)
get_widget_handler() (in module scipp.logging)
greater() (in module scipp)
greater_equal() (in module scipp)
groupby() (in module scipp)
(scipp.DataArray method)
(scipp.Dataset method)
GroupByDataArray (class in scipp)
GroupByDataset (class in scipp)
H
histogram() (in module scipp)
I
identical() (in module scipp)
isclose() (in module scipp)
isfinite() (in module scipp)
isinf() (in module scipp)
islinspace() (in module scipp)
isnan() (in module scipp)
isneginf() (in module scipp)
isposinf() (in module scipp)
issorted() (in module scipp)
items() (scipp.Dataset method)
K
keys() (scipp.Dataset method)
L
less() (in module scipp)
less_equal() (in module scipp)
linspace() (in module scipp)
log() (in module scipp)
log10() (in module scipp)
logical_and() (in module scipp)
logical_or() (in module scipp)
logical_xor() (in module scipp)
logspace() (in module scipp)
lookup() (in module scipp)
M
make_log_widget() (in module scipp.logging)
make_stream_handler() (in module scipp.logging)
make_widget_handler() (in module scipp.logging)
masks (scipp.Bins property)
(scipp.DataArray property)
matrices() (in module scipp)
matrix() (in module scipp)
max() (in module scipp)
(scipp.GroupByDataArray method)
(scipp.GroupByDataset method)
(scipp.Variable method)
mean() (in module scipp)
(scipp.Bins method)
(scipp.DataArray method)
(scipp.GroupByDataArray method)
(scipp.GroupByDataset method)
(scipp.Variable method)
merge() (in module scipp)
meta (scipp.Bins property)
(scipp.DataArray property)
(scipp.Dataset property)
MetaDataMap (in module scipp.typing)
min() (in module scipp)
(scipp.GroupByDataArray method)
(scipp.GroupByDataset method)
(scipp.Variable method)
mod() (in module scipp)
module
scipp.constants
scipp.logging
scipp.spatial
scipp.spatial.transform
multiply() (in module scipp)
N
name (scipp.DataArray property)
(scipp.Unit property)
nan_to_num() (in module scipp)
nanmax() (in module scipp)
(scipp.Variable method)
nanmean() (in module scipp)
(scipp.DataArray method)
(scipp.Variable method)
nanmin() (in module scipp)
(scipp.Variable method)
nansum() (in module scipp)
(scipp.DataArray method)
(scipp.Variable method)
ndim (scipp.DataArray property)
(scipp.Variable property)
norm() (in module scipp)
not_equal() (in module scipp)
O
ones() (in module scipp)
ones_like() (in module scipp)
P
physical_constants() (in module scipp.constants)
plot() (in module scipp)
(scipp.DataArray method)
(scipp.Dataset method)
(scipp.Variable method)
position() (in module scipp.geometry)
R
rebin() (in module scipp)
reciprocal() (in module scipp)
reduce() (in module scipp)
rename_dims() (scipp.DataArray method)
(scipp.Dataset method)
(scipp.Variable method)
rotation_matrix_from_quaternion_coeffs() (in module scipp.geometry)
round() (in module scipp)
(scipp.DataArray method)
(scipp.Variable method)
S
scalar() (in module scipp)
scipp.constants
module
scipp.logging
module
scipp.spatial
module
scipp.spatial.transform
module
shape (scipp.DataArray property)
(scipp.Dataset property)
(scipp.Variable property)
show() (in module scipp)
show_graph() (in module scipp)
sin() (in module scipp)
size() (scipp.Bins method)
sizes (scipp.DataArray property)
(scipp.Dataset property)
(scipp.Variable property)
slices() (in module scipp)
sort() (in module scipp)
sqrt() (in module scipp)
stddevs() (in module scipp)
subtract() (in module scipp)
sum() (in module scipp)
(scipp.Bins method)
(scipp.DataArray method)
(scipp.GroupByDataArray method)
(scipp.GroupByDataset method)
(scipp.Variable method)
T
table() (in module scipp)
tan() (in module scipp)
to_dict() (in module scipp)
to_hdf5() (scipp.DataArray method)
(scipp.Dataset method)
(scipp.Variable method)
to_html() (in module scipp)
to_unit() (in module scipp)
transform_coords() (in module scipp)
(scipp.DataArray method)
(scipp.Dataset method)
transpose() (in module scipp)
(scipp.DataArray method)
(scipp.Variable method)
U
underlying_size() (scipp.Dataset method)
(scipp.Variable method)
Unit (class in scipp)
unit (scipp.DataArray property)
(scipp.Variable property)
V
value (scipp.DataArray property)
(scipp.Variable property)
values (scipp.DataArray property)
(scipp.Variable property)
values() (in module scipp)
(scipp.Dataset method)
Variable (class in scipp)
VariableLike (in module scipp.typing)
variance (scipp.DataArray property)
(scipp.Variable property)
variances (scipp.DataArray property)
(scipp.Variable property)
variances() (in module scipp)
vector() (in module scipp)
vectors() (in module scipp)
W
where() (in module scipp)
WidgetHandler (class in scipp.logging)
Z
zeros() (in module scipp)
zeros_like() (in module scipp)