v1.4.0

Release Notes Draft

Documentation

This release adds substantial user-facing documentation for pySC configuration files. The configuration guide now explains the main YAML sections better, including error tables, lattice setup, magnet families, BPMs, supports, RF systems, injection settings, and tuning families.

The new documentation also includes examples for file-based and inline configuration patterns, making it easier to build and review commissioning configurations directly from YAML.

Multipolar Imperfections

pySC now supports configurable multipolar imperfection models for magnet families.

A new top-level multipolar_imperfection_models section can define optional field-error models. These models can be attached to magnet families with the imperfections field:

multipolar_imperfection_models:
  quad_body_errors: quad_multipolar_errors.yaml

magnets:
  quadrupoles:
    regex: ^Q
    components:
      - B2: magnet_calibration
    imperfections: quad_body_errors

Supported imperfection model types include:

• Table models, for systematic and random normalized harmonic errors using mean_bn, mean_an, std_bn, and std_an.
• Curve models, for interpolating a target normalized harmonic from a runtime source component, such as deriving b6 from the operating quadrupole strength.

Models may be defined inline or loaded from YAML files. The imperfections field is optional per magnet family, so existing configurations continue to work unchanged unless an imperfection model is explicitly attached.