hutch-python
1.15.0

Getting Started

  • Starting a Session
  • What to Expect When You are Expecting a New Hutch Python

User Documentation

  • Startup Sequence
  • Database Objects
  • DAQ
  • Beamline File
  • Experiment File
  • Presets
  • Reporting Issues
  • Tips and Tricks
  • Useful Utilities
  • Related Modules

Developer Documentation

  • Environments
  • Hutch Setup
  • Yaml Files
  • Debug
  • Release History

Internal API Reference

  • bug.py
  • cache.py
  • cli.py
  • ipython_log.py
  • load_conf.py
  • load submodules
  • log_setup.py
  • namespace.py
  • utils.py
hutch-python
  • »
  • Related Modules
  • View page source

Related ModulesΒΆ

Here are some links to documentation of modules that hutch-python relies heavily on:

  • SLAC Modules:

    • pcdsdaq: For using the daq

      These documents explain how to use the daq object and how to incorporate the daq object into bluesky plans.

    • pcdsdevices: For LCLS devices

      These documents are a complete API specification for available device classes, along with an explanation of some of the more important interfaces.

    • happi: For object loading

      These documents show how to add devices to the shared database, and how to read them back.

  • NSLS-II Modules:

    • bluesky: For using the RunEngine

      These documents explain how to create and use plans and how to use the RE object to run them. It also goes into depth about how the RunEngine works and how it can be customized.

    • ophyd: For developing LCLS devices

      These documents describe the design philosophy behind the ophyd Device architecture and how to create new device classes.

Previous Next

© Copyright .

Built with Sphinx using a theme provided by Read the Docs.