# Reference

# Schema

Property Required Type Description
version true string LatticeJSON version
title false string The title of the lattice
info false string Additional information about the lattice
energy false number Energy of the particle beam in GeV
root true string The root lattice
lattices true object Definition of the lattice and sub-lattices
elements true object Definition of the elements

# Lattice

"lattice": [<object>, <object>,...]
"sublattices": {
  <name>: [<object>, <object>,...],
  <name>: [<object>, <object>,...],
  ...
}

# Elements

Elements is a dictionary with element names as keys and their definition as value.

"elements": {
  <name>: [<type>, <attributes>],
  <name>: [<type>, <attributes>],
  ...
}

# Drift

Attribute Type Description
info string Additional information about the element.
length number The length of the element.
dx number Horizontal misalignment
dy number Vertical misalignment
ds number Longitudinal misalignment
tilt number Rotation about the longitudinal axis

# Dipole

Attribute Type Description
info string Additional information about the element.
length number The length of the element.
dx number Horizontal misalignment
dy number Vertical misalignment
ds number Longitudinal misalignment
tilt number Rotation about the longitudinal axis
angle number Deflection angle
radius number Radius of curvature
e1 number
e2 number
h1 number
h2 number
conversion_factor_ps_value number

# Quadrupole

Attribute Type Description
info string Additional information about the element.
length number The length of the element.
dx number Horizontal misalignment
dy number Vertical misalignment
ds number Longitudinal misalignment
tilt number Rotation about the longitudinal axis
k1 number Geometric quadrupole strength
conversion_factor_ps_value number

# Sextupole

Attribute Type Description
info string Additional information about the element.
length number The length of the element.
dx number Horizontal misalignment
dy number Vertical misalignment
ds number Longitudinal misalignment
tilt number Rotation about the longitudinal axis
k2 number Geometric sextupole strength
conversion_factor_ps_value number

# Octupole

Attribute Type Description
info string Additional information about the element.
length number The length of the element.
dx number Horizontal misalignment
dy number Vertical misalignment
ds number Longitudinal misalignment
tilt number Rotation about the longitudinal axis
k3 number Geometric octupole strength
conversion_factor_ps_value number