Welcome to the Contrast 0.2 documentation!

Contrast is a simple, lightweight python framework for instrument orchestration and data acquisition.

This document was built automatically from Contrast version 0.2-214-g8e787ac.

Contents:

• Concepts
  • Gadget and its subclasses
    • Motors
    • Detectors
    • Recorders
  • Macros
  • The environment object
• Library tutorial
  • Motors
    • Pure Python library
    • Motor macros
    • Creating our own Motor
  • Detectors
    • Library basics
    • Detector macros
    • Writing our own detector
• Installation and usage
  • Launching a beamline
  • Detector selection
  • User levels
  • Defining custom macros
  • Getting information out of macros
  • Direct access to python objects
• Making graphical user interfaces
  • Standalone GUI
  • Server/client models
    • A trivial listener
    • IPython kernel clients
• Built-in macros
  • activate
  • ascan
  • bookmark
  • checkgit
  • ct
  • deactivate
  • dmesh
  • dscan
  • fermatscan
  • fermatscanplus
  • healthcheck
  • listscan
  • liveplot
  • loopscan
  • lsbook
  • lsdet
  • lsm
  • lsmac
  • lsrec
  • lstrig
  • mesh
  • meshjmesh
  • mv
  • mvd
  • mvr
  • path
  • restore
  • rmbook
  • setlim
  • setpos
  • spiralascan
  • spiralscan
  • startlive
  • stoplive
  • tweak
  • umv
  • umvr
  • userlevel
  • wa
  • wm
  • wms
• API reference
  • Module contents
    • wisdom()
  • Subpackages
    • contrast.detectors package
    • contrast.environment package
    • contrast.motors package
    • contrast.recorders package
    • contrast.scans package
  • Submodules
  • contrast.Gadget module
    • Gadget
  • contrast.abbreviations module
  • contrast.utils module
    • list_to_table()
    • dict_to_table()
    • str_to_args()
    • SpecTable
    • get_git_revision()
• Building this documentation
  • Building on readthedocs.org

Indices and tables

• Index

• Module Index

• Search Page