How-to Guides

This section contains task-oriented recipes for users who already know the basics of Sardana. Each guide focuses on getting a specific job done: configuring the system, writing macros and controllers, customizing scans and data storage, managing the environment, and using the Spock and GUI tools. For installation instructions see the Installation page.

If you are new to Sardana, start with the Tutorials section. Background information on concepts can be found in the Explanation section and complete API and configuration references in the Reference section.

• Configuration
  • Configuration format and tools
  • Configuration points
• Writing macros
  • General macro development
  • Scan macro development
  • Macro hooks
  • Controlling macro sequences
  • Macro environment
  • Macro logging and reports
  • Examples
• Writing controllers
  • General controller writing
  • Controller testing
  • Motor controller
  • Counter/timer controller
  • 0D controller
  • 1D controller
  • 2D controller
  • Trigger/gate controller
  • IO register controller
  • Pseudo motor controller
  • Pseudo counter controller
• Scans and data storage
  • Scan configuration and data storage
  • Writing recorders
  • Diffractometer
• Environment variables
  • Managing environment variables
  • Environment storage backends
• Spock and GUI tools
  • Spock
  • Sardana-Taurus widgets
• Development
  • Coding guide
  • Testing
  • Test-driven development example
  • Unit test examples
  • Troubleshooting