Suitcase Documentation

Suitcase translates documents generated by bluesky (or anything that follows its “event model” schema) into file formats. This documentation contains a list of formats and layouts that are currently supported or in progress. It also provides instructions for writing a suitcase for a new format.

To install suitcase and start exporting data, see Usage.

While most users will use suitcase to write files to disk, advanced users may write to a memory buffer, a network socket, etc. The serialization (documents-to-bytes) is separated from the transport (what to do with the bytes).

• Usage
  • Simple Export
  • Streaming Export
  • Serialize to Any Buffer
• Supported Formats and Layouts
  • Generics
  • “One-offs”
  • Backends
• Write Your Own Suitcase
  • Scope of a Suitcase
  • Creating a New Suitcase Package
  • API Documentation