logo

Getting Started

  • What is Scipp?
  • Installation
  • Quick start
  • Frequently Asked Questions

User Guide

  • Data Structures
    • Data Structures
    • Creating Arrays and Datasets
  • Indexing and Selecting
  • Computation
  • Masking
  • Binned Data
    • Binned Data
    • Computation with Binned Data
    • Rearranging and Filtering Binned Data
    • Histogramming, grouping, and binning
  • GroupBy
  • Coordinate transformations
  • Reading and Writing Files
  • Tips, tricks, and anti-patterns

Visualization

  • Representations and Tables
  • Plotting

Reference

  • Classes
    • scipp.DataArray
    • scipp.DataGroup
    • scipp.Dataset
    • scipp.DType
    • scipp.Unit
    • scipp.Variable
    • scipp.Bins
    • scipp.Coords
    • scipp.GroupByDataArray
    • scipp.GroupByDataset
    • scipp.Masks
    • scipp.BinEdgeError
    • scipp.BinnedDataError
    • scipp.CoordError
    • scipp.DataArrayError
    • scipp.DatasetError
    • scipp.DimensionError
    • scipp.DTypeError
    • scipp.UnitError
    • scipp.VariableError
    • scipp.VariancesError
    • scipp.typing.DTypeLike
    • scipp.typing.MetaDataMap
    • scipp.typing.VariableLike
  • Creation functions
    • scipp.array
    • scipp.arange
    • scipp.datetime
    • scipp.datetimes
    • scipp.empty
    • scipp.empty_like
    • scipp.epoch
    • scipp.full
    • scipp.full_like
    • scipp.geomspace
    • scipp.index
    • scipp.linspace
    • scipp.logspace
    • 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.collapse
    • scipp.elemwise_func
    • scipp.group
    • scipp.hist
    • scipp.logical_not
    • scipp.logical_and
    • scipp.logical_or
    • scipp.logical_xor
    • scipp.lookup
    • scipp.nanhist
    • scipp.merge
    • scipp.midpoints
    • 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.negative
    • scipp.norm
    • scipp.pow
    • scipp.reciprocal
    • scipp.round
    • scipp.sqrt
    • scipp.subtract
    • scipp.broadcast
    • scipp.concat
    • scipp.flatten
    • scipp.fold
    • scipp.squeeze
    • 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.make_html
    • scipp.make_svg
    • scipp.plot
    • scipp.show
    • scipp.show_graph
    • scipp.table
    • scipp.to_html
    • scipp.get_logger
    • scipp.display_logs
  • Modules
    • scipp.binning
      • scipp.binning.make_binned
      • scipp.binning.make_histogrammed
    • scipp.compat
      • scipp.compat.dict
        • scipp.compat.dict.from_dict
        • scipp.compat.dict.to_dict
      • scipp.compat.pandas_compat
        • scipp.compat.pandas_compat.from_pandas
        • scipp.compat.pandas_compat.from_pandas_dataframe
        • scipp.compat.pandas_compat.from_pandas_series
        • scipp.compat.pandas_compat.parse_bracket_header
      • scipp.compat.wrapping
        • scipp.compat.wrapping.wrap1d
      • scipp.compat.xarray_compat
        • scipp.compat.xarray_compat.from_xarray
        • scipp.compat.xarray_compat.to_xarray
    • scipp.constants
      • scipp.constants.physical_constants
    • scipp.io
      • scipp.io.csv
        • scipp.io.csv.load_csv
      • scipp.io.hdf5
        • scipp.io.hdf5.collection_element_name
        • scipp.io.hdf5.load_hdf5
        • scipp.io.hdf5.open_hdf5
        • scipp.io.hdf5.save_hdf5
        • scipp.io.hdf5.to_hdf5
        • scipp.io.hdf5.BinDataIO
        • scipp.io.hdf5.DataArrayIO
        • scipp.io.hdf5.DataGroupIO
        • scipp.io.hdf5.DatasetIO
        • scipp.io.hdf5.HDF5IO
        • scipp.io.hdf5.NumpyDataIO
        • scipp.io.hdf5.ScippDataIO
        • scipp.io.hdf5.StringDataIO
        • scipp.io.hdf5.VariableIO
    • scipp.spatial
      • scipp.spatial.affine_transform
      • scipp.spatial.affine_transforms
      • scipp.spatial.as_vectors
      • scipp.spatial.inv
      • scipp.spatial.linear_transform
      • scipp.spatial.linear_transforms
      • scipp.spatial.rotation
      • scipp.spatial.rotation_as_rotvec
      • scipp.spatial.rotations
      • scipp.spatial.rotations_from_rotvecs
      • scipp.spatial.scaling_from_vector
      • scipp.spatial.scalings_from_vectors
      • scipp.spatial.translation
      • scipp.spatial.translations
    • scipp.units
      • scipp.units.aliases
      • scipp.units.UnitAliases
    • scipp.scipy
      • scipp.scipy.integrate
        • scipp.scipy.integrate.simpson
        • scipp.scipy.integrate.trapezoid
      • scipp.scipy.interpolate
        • scipp.scipy.interpolate.interp1d
      • scipp.scipy.ndimage
        • scipp.scipy.ndimage.gaussian_filter
        • scipp.scipy.ndimage.generic_filter
        • scipp.scipy.ndimage.maximum_filter
        • scipp.scipy.ndimage.median_filter
        • scipp.scipy.ndimage.minimum_filter
        • scipp.scipy.ndimage.percentile_filter
        • scipp.scipy.ndimage.rank_filter
      • scipp.scipy.optimize
        • scipp.scipy.optimize.curve_fit
      • scipp.scipy.signal
        • scipp.scipy.signal.butter
        • scipp.scipy.signal.sosfiltfilt
        • scipp.scipy.signal.SOS
    • scipp.configuration
      • scipp.configuration.Config
    • 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_widget_handler
      • scipp.logging.WidgetHandler
      • scipp.logging.WidgetLogRecord
    • scipp.testing
      • scipp.testing.assertions
        • scipp.testing.assertions.assert_identical
      • scipp.testing.strategies
        • scipp.testing.strategies.coord_dicts
        • scipp.testing.strategies.dataarrays
        • scipp.testing.strategies.dims
        • scipp.testing.strategies.floating_dtypes
        • scipp.testing.strategies.integer_dtypes
        • scipp.testing.strategies.n_variables
        • scipp.testing.strategies.scalar_numeric_dtypes
        • scipp.testing.strategies.sizes_dicts
        • scipp.testing.strategies.units
        • scipp.testing.strategies.variables
    • scipp.sphinxext.autoplot
  • Linear Algebra
  • Data types
  • Physical units
  • Propagation of uncertainties
  • Ownership mechanism and readonly flags
  • Logging
  • Testing code with Scipp
  • Runtime Configuration
  • Developer Documentation
    • Getting Started
    • 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
      • ADR 0011: Renaming of Dimensions in transform_coords
      • ADR 0012: Rebin should apply irreducible masks
      • ADR 0013: Plot should not resample automatically
      • ADR 0014: Switch to Calendar Versioning
      • ADR 0015: Disable support for broadcasting variances
      • ADR 0016: Do not support “attrs”
      • ADR 0017: Restrict Dataset to items with matching dimensionality
    • Coding conventions
    • Concepts
    • C++ API for constructing variables
    • Customizing Scipp
    • Dependencies
    • Multi-Dimensional Indexing
    • Jupyter Notebook Style Guide
    • Releasing Scipp
    • Tooling
    • Transforming data
    • Implementation of class Variable

Tutorials

  • From tabular data to binned data
  • RHESSI Solar Flares

About

  • About Scipp
  • What’s new in Scipp
  • Roadmap
  • Contributing to Scipp
  • Release Notes
  • Migration Notes
    • Migrating to Scipp 23.01.0
Theme by the Executable Book Project
  • scipp
  • plopp
  • scippnexus
  • scippneutron
  • ess
  • 23.8 (latest)
  • 23.7
  • 23.5
  • 23.3
  • 23.1
  • 22.11
  • 0.17
  • 0.16
  • 0.15
  • 0.14
  • 0.13
  • 0.12
  • 0.11
  • 0.10
  • 0.9
  • 0.8
  • repository
  • open issue
  • suggest edit
  • .rst

Data Structures

Data Structures#

  • Data Structures
  • Creating Arrays and Datasets

previous

Frequently Asked Questions

next

Data Structures

By Scipp contributors
© Copyright 2023 Scipp contributors.