Software

License Agreement

This web page provides access to software packages produced by the Accelerator Operations and Physics Group.

Note that some of this software (notably the SDDS code) is also distributed by the EPICS collaboration. However, those versions are usually out of date and we suggest that SDDS users download from this site. The directory structures are the same in the two distributions.

Authors: Michael Borland, Robert Soliday and Hairong Shang
Packagers: Robert Soliday

If you encounter any installation issues, please soliday@anl.gov.

Installation Guides

Prepackaged Software

  1. AOP Software Download Links

    SDDS ToolKit
    Python sdds Module
    Java SDDS ToolKit
    SDDS EPICS ToolKit
    OAG Tcl/Tk Scripts
    elegant

    elegant is an accelerator code that computes beta functions, matrices, orbits, floor coordinates, amplification factors, dynamic aperture, and more. It does 6-D tracking with matrices and/or canonical integrators, and supports a variety of time-dependent elements. It also does optimization (e.g., matching), including optimization of tracking results. It is the principle accelerator code used at APS. To get started with elegant, you can use the following example files and scripts as a guide.
    The manual is available here.
    Check out the Pelegant setup guide for multi-CPU-core computers.
    Another source of information and help is the on-line forum.

    Spiffe

    Spiffe is a fully-electromagnetic 2-1/2 dimensional particle-in-cell code for simulation of rf guns and similar systems with cylindrical symmetry.

    Shower

    Shower is a C-interface to EGS4, a Monte Carlo electromagnetic shower simulation program. EGS4 (developped at SLAC) is a set of subroutines that generates and tracks particle in a electromagnetic shower. In the conventional EGS4 code system, the user must supply their own input and output routines and problem geometry definition written in the MORTRAN language. This arduous process has been replaced by the C-code interface provided here by reading and writing input and output particle information as data files, the geometry definition as a file of namelist type commands, and other information in an addition summary data file. All data files are in SDDS format, and therefore compatible with other processing and tracking programs.

    Shower requires that the EGS4_CROSSSECTION environment variable be set to the location of the materials.pegs4dat file

    Clinchor

    Clinchor calculates the growth rates of longitudinal and transverse coupled bunch modes in an electron storage ring. The manual is available here.
    Some example files are here.

    Shield

    Shield is a computer code for performing shielding analyses around a high-energy electron accelerator. It makes use of simple analytic expressions for the production and attenuation of photons and neutrons resulting from electron beams striking thick targets, such as dumps, stoppers, collimators, and other beam devices. This version is based on SHEILD11 (SLAC).

Source Code

  1. EPICS Source Code Download Links

    EPICS Base
    • base-7.0.8.1.tar.gz (June 27, 2024)
      Download only if you intend to use EPICS (Experimental Physics and Industrial Control System).
    • EPICS Base Build Rules Only (February 28, 2014)
      Use this instead of the full EPICS Base if you don't intend to use EPICS.
    • EPICS Extensions Build Rules (February 28, 2014)
      You will need this in addition to the EPICS Base build rules to build SDDS software.
    • OAG Build Rules (February 28, 2014)
      You will need this in addition to the other build rules to build elegant, OAG Tcl/Tk, Spiffe and Shower software.

  2. AOP Source Code Download Links

    SDDS ToolKit Source Code
    Python sdds Module Source Code
    Java SDDS Source Code
    • Java SDDS Release (February 3, 2023)
      This version works independently from the C code. Documentation for the Java SDDS library can be found here.
    Matlab SDDS Source Code
    • Matlab SDDS Release (February 9, 2023)
      This version requires the Java SDDS Binary be installed in the Matlab class path. These files are also included in the SDDS Source distribution. Installation instructions are also available.
    SDDS EPICS Source Code
    OAG Tcl/Tk Scripts
    elegant Source Code
    • elegant source version 2024.1.0 (December 16, 2024)
      It works with the library sources in SDDS.5.6. This version builds on Linux, Windows, OS X, and other systems. You will need the "rpn definitions file", available here; be sure to define the environment variable RPN_DEFNS to point to this file.
    • elegant source version 2023.4.0 (November 13, 2023)
      It works with the library sources in SDDS.5.6. This version builds on Linux, Windows, OS X, and other systems. You will need the "rpn definitions file", available here; be sure to define the environment variable RPN_DEFNS to point to this file.
    Spiffe Source Code
    Shower Source Code

ChatGPT Assistants

Demonstration Scripts

  1. Python demo scripts
  2. gzip'd tar file contains a number of Tcl/Tk scripts and data files for running demonstrations of the SDDS and the SDDS/EPICS Toolkits. It uses these toolkits and our extensions to Tcl/Tk. The demonstrations involve simulation of a storage ring using the portable channel access server, collection and analysis of data from the storage ring, measurement of the response matrix, and correction of the orbit. You should download and unpack this file first, then consult the README file for more detailed instructions. At present, these demos are only supported on LINUX and other UNIX platforms.