# spin keywords

Spin parameters

## spin.SOI

Determines whether to include the spin-orbit interaction. spin.type must
be equal to non-collinear.

**type**: `scalar`

**default**: `false`

**allowed**: `true,false`

**example**: `spin.SOI = 1`

## spin.kresolved

Determines whether to compute the spin for each band and k-point in a
band-structure calculation. This is only referenced if spin.type is
non-collinear. The results are saved to band.spin in a (# k-point, \#
band, 3) array.

**type**: `scalar`

**default**: `false`

**allowed**: `true,false`

**example**: `spin.kresolved = true`

## spin.type

Determines how to treat spin in RESCU.

**type**: `string`

**default**: `'degenerate'`

**allowed**: `'degenerate','collinear','non-collinear'`

**example**: `spin.type = 'collinear'`
