Changelog

v2.0

Enhancements

  • The user can now select between two different computation backends: PyTorch and Numpy. As the names suggest, with PyTorch all involved numbers/tensors are reprenseted as torch.Tensor objects which also allow for gradient tracking; with Numpy all involved numbers/tensors are represented as np.ndarray objects. This allows working with other Numpy-compatible libraries and generally opens the door for incorporating new backends such as Jax. The backend can be selected via the DIPAS_BACKEND environment variable ('numpy' or 'pytorch'); if unset, the backend will default to PyTorch as before. Alternatively, the backend can be manually switched via import dipas.backends; dipas.backends.backend = dipas.backends.Numpy(). Note that in this case all previously loaded lattices/elements will retain the old backend’s tensor types, so reloading is required.

Changes

  • The dipas.elements module does not expose Tensor and Parameter attributes anymore; these are now accessible via dipas.backends.backend.(TensorType|ParameterType).

v1.3

Enhancements

  • New exception types for errors during parsing and building:

    • dipas.build.UnknownVariableNameError

    • dipas.madx.parser.IllegalStatementError

  • Parsing and build errors now include the line number indicating where the error originated

  • MADX default values for element attributes are now supported

  • New option to define defaults for missing variables during parsing: dipas.madx.parser.missing_variable_names (see Compatibility with MADX and dipas.madx.parser for details); this is useful for parsing sequences without optics files

Changes

  • Deleting elements from a segment now replaces them with equivalent drift spaces (the old behavior was to simply remove them; the difference matters for non-zero-length elements). In order to completely remove elements, one should delete from segment.elements instead.

v1.2

Enhancements

  • Interface for external optimizers (+ example in docs)

  • Random noise for BPMErrors

  • Method for merging consecutive drift spaces: Segment.squeeze

  • New command line utility: print-beam

  • New module for plotting lattices and Twiss data: dipas.plot

  • New command line interface for common operations such as plotting, Twiss, ORM

v1.1

Enhancements

  • build.Lattice now supports auto-labeling its elements.

  • A custom exception is raised if the orbit diverges during closed orbit search.

  • BPMErrors are included during ORM computation.

  • Field errors can be added to Kicker elements.

v1.0

DiPAS 1.0 supports a wide variety of simulation capabilities among which are:

  • Closed orbit search

  • Twiss computation

  • Transfer maps

  • Orbit Response Matrix

  • Particle Tracking

Various lattice elements as well as alignment errors and field errors are supported.

The framework understands most MADX syntax for describing lattices and thus can parse MADX files. It also includes utility functions for interfacing with MADX and for creating corresponding script files.