SDDS ToolKit

The Self Describing Data Sets (SDDS) file protocol underpins a robust and expanding toolkit of generic programs. These tools facilitate simulation post-processing, graphics generation, data preparation, program interfacing, and experimental data analysis.

This document details the SDDS command-line toolkit. For those interested in developing programs using SDDS, please refer to the SDDS Application Programmer's Guide. The initial section of this document overlaps with the aforementioned guide.

An introductory guide, "Getting Started with SDDS," is available in HTML, PDF, and PostScript formats. Additionally, sample data can be downloaded to follow along with the examples.

SDDS EPICS ToolKit

The SDDS-compliant EPICS toolkit comprises software applications designed for collecting and writing data within Experimental Physics and Industrial Control System (EPICS) database records. While each application performs straightforward operations, their combination with other SDDS post-processing tools enables complex data analysis and accelerator control at the Advanced Photon Source. These versatile tools are applicable to various EPICS-controlled devices beyond accelerators.

User's Manual for elegant

This manual covers the latest version of elegant, a 6-D accelerator simulation code featuring matrix tracking, symplectic elements, optimization, synchrotron radiation, scattering, and more. elegant adheres to the SDDS standard. An APS Light-Source Note detailing elegant is also available.

Example files and scripts can be downloaded from the software download page. Additional support and information are available through the online forum.

Pelegant Manual

This manual guides you through building Pelegant, running the code, and optimizing performance. Appendices detail the parallelized elements and commands used in regression tests. Familiarity with the User's Manual for elegant is recommended before consulting this document.

A technical paper, forthcoming in the proceedings of AAC06, provides additional details and is available as a PDF.

Short Introduction to SDDS

Presented on April 13, 1998, this talk offers a concise introduction to SDDS, exploring its philosophy, contrasting it with conventional systems, and illustrating its application at APS.

SDDS Information

Comprehensive information about SDDS and its applications is available at SDDS Information. This resource is ideal for those new to SDDS or elegant.

SDDS Application Programmer's Guide

This guide serves as a resource for programmers working with the SDDS subroutine library.

APS SDDS Tcl/Tk Extension

A Tcl/Tk extension library for reading and writing SDDS files, these commands are integrated into the oagwish interpreter.

APS CA Tcl/Tk Extension

This Tcl/Tk extension library provides EPICS functions and is built into the oagwish interpreter.

APS Tcl/Tk Library and Interpreter Extensions

A collection of Tcl and Tk procedures designed to streamline the development of Tcl/Tk applications with a consistent appearance and functionality. Access the library via the Tcl auto_load feature.

PEM - Procedure Execution Manager

PEM offers an interface for invoking and monitoring machine procedures, along with supporting scripts and Tcl library code. Machine procedures enable the coding of frequently used operations and commissioning sequences into modular procedures accessible through various methods.

APS RunControl Library

This C library is tailored for closed-loop EPICS control applications typically running in the background on workstations.

APS logDaemon and Client Library

This server and client library facilitate a general, distributed message logging service.

Spiffe Manual

The user's manual for Spiffe, a fully electromagnetic 2.5-dimensional particle-in-cell code designed for simulating RF guns and similar systems with cylindrical symmetry. Spiffe complies with the SDDS standard.

Array Display Tool (ADT)

ADT is a Motif-based program utilized to display arrays of process variables from the Advanced Photon Source control system.

Shower Manual

The user's manual for Shower, an interface to EGS4, an electromagnetic shower simulation code. Shower is SDDS-compliant and facilitates simulations of RF guns and similar systems.

Clinchor Manual

This manual details Clinchor, a program designed to calculate growth rates of multi-bunch beam modes. Clinchor adheres to the SDDS standard.

AOP High-Level Applications Documentation

Access the OAG High-Level Applications Documentation for detailed information on high-level application software developed by the Accelerator Operations and Physics Group. These applications feature graphical user interfaces built with Tcl/Tk and leverage the SDDS Toolkit. Currently, a selection of applications is documented here. For more information on the toolkit, refer to this section.