Quick start#

This section provides a quick introduction to scipp. For in depth explanations refer to the sections in the user guide.

[1]:

import numpy as np
import scipp as sc

We start by creating some variables:

[2]:

var = sc.Variable(dims=['y', 'x'], values=np.random.rand(4,5))
sc.show(var)

Type the name of a variable at the end of a cell to generate an HTML respresentation:

[3]:

var

[3]:

scipp.Variable (160 Bytes)

(y: 4, x: 5)

float64

𝟙

0.098, 0.924, ..., 0.330, 0.328

Values:
array([[0.09833837, 0.92407188, 0.4903907 , 0.2810445 , 0.1546288 ],
       [0.2066901 , 0.93029172, 0.46673729, 0.43659741, 0.94705058],
       [0.22550587, 0.84341108, 0.24288544, 0.4037169 , 0.19883732],
       [0.98451595, 0.35153845, 0.50836422, 0.33013965, 0.32765522]])

[4]:

x = sc.Variable(dims=['x'], values=np.arange(5), unit=sc.units.m)
y = sc.Variable(dims=['y'], values=np.arange(4), unit=sc.units.m)

We combine the variables into a data array:

[5]:

array = sc.DataArray(
    data=var,
    coords={'x': x, 'y': y})
sc.show(array)
array

[5]:

scipp.DataArray (232 Bytes)

Dimensions:
- y: 4
- x: 5
Coordinates: (2)
- x
  (x)
  int64
  m
  0, 1, 2, 3, 4
```
Values:
array([0, 1, 2, 3, 4])
```
- y
  (y)
  int64
  m
  0, 1, 2, 3
```
Values:
array([0, 1, 2, 3])
```

Data: (1)

(y, x)

float64

𝟙

0.098, 0.924, ..., 0.330, 0.328

Values:
array([[0.09833837, 0.92407188, 0.4903907 , 0.2810445 , 0.1546288 ],
       [0.2066901 , 0.93029172, 0.46673729, 0.43659741, 0.94705058],
       [0.22550587, 0.84341108, 0.24288544, 0.4037169 , 0.19883732],
       [0.98451595, 0.35153845, 0.50836422, 0.33013965, 0.32765522]])

Variables can have uncertainties. Scipp stores these as variances (the square of the standard deviation):

[6]:

array.variances = np.square(np.random.rand(4,5))
sc.show(array)

We create a dataset:

[7]:

dataset = sc.Dataset(
    data={'a': var},
    coords={'x': x, 'y': y, 'aux': x})
dataset['b'] = array
dataset['scalar'] = 1.23 * (sc.units.m / sc.units.s)
sc.show(dataset)

We can slice variables, data arrays, and datasets using a dimension label and an index or a slice object like i:j:

[8]:

dataset['c'] = dataset['b']['x', 2]
sc.show(dataset)
dataset

We can also generate table representations (only 0-D and 1-D) and plots:

[9]:

sc.table(dataset['y', 2])

[10]:

sc.plot(dataset)

Arithmetic operations can be combined with slicing and handle propagation of uncertainties and units:

[11]:

print(dataset)

<scipp.Dataset>
Dimensions: Sizes[y:4, x:5, ]
Coordinates:
  aux                         int64              [m]  (x)  [0, 1, ..., 3, 4]
  x                           int64              [m]  (x)  [0, 1, ..., 3, 4]
  y                           int64              [m]  (y)  [0, 1, 2, 3]
Data:
  a                         float64  [dimensionless]  (y, x)  [0.0983384, 0.924072, ..., 0.33014, 0.327655]  [0.878392, 0.175916, ..., 2.42838e-05, 0.558412]
  b                         float64  [dimensionless]  (y, x)  [0.0983384, 0.924072, ..., 0.33014, 0.327655]  [0.878392, 0.175916, ..., 2.42838e-05, 0.558412]
  c                         float64  [dimensionless]  (y)  [0.490391, 0.466737, 0.242885, 0.508364]  [0.475704, 0.575806, 0.011077, 0.467682]
    Attributes:
        aux                         int64              [m]  ()  [2]
        x                           int64              [m]  ()  [2]
  scalar                    float64            [m/s]  ()  [1.23]

[12]:

dataset['b']['y', 0:2] -= dataset['y', 0:2]['a']['x', 0]
dataset['b'] *= dataset['scalar']
print(dataset)

<scipp.Dataset>
Dimensions: Sizes[y:4, x:5, ]
Coordinates:
  aux                         int64              [m]  (x)  [0, 1, ..., 3, 4]
  x                           int64              [m]  (x)  [0, 1, ..., 3, 4]
  y                           int64              [m]  (y)  [0, 1, 2, 3]
Data:
  a                         float64            [m/s]  (y, x)  [0, 1.01565, ..., 0.406072, 0.403016]  [2.65784, 1.59506, ..., 3.67389e-05, 0.844821]
  b                         float64            [m/s]  (y, x)  [0, 1.01565, ..., 0.406072, 0.403016]  [2.65784, 1.59506, ..., 3.67389e-05, 0.844821]
  c                         float64            [m/s]  (y)  [0.482224, 0.319858, 0.298749, 0.625288]  [2.04861, 0.963798, 0.0167585, 0.707556]
    Attributes:
        aux                         int64              [m]  ()  [2]
        x                           int64              [m]  ()  [2]
  scalar                    float64            [m/s]  ()  [1.23]

Finally, type the imported name of the scipp module at the end of a cell for a list of all current scipp objects (variables, data arrays, datasets). Click on entries to expand nested sections:

[13]:

sc

[13]:

<module 'scipp' from '/home/runner/work/scipp/scipp/.tox/docs/lib/python3.8/site-packages/scipp/__init__.py'>