Xi-CAM Documentation

The Xi-CAM package is a plugin-based framework and graphical user interface (GUI) application for synchrotron data management, acquisition, visualization, and analysis. Support for a variety of techniques is provided through its plugin architecture.

Getting Started

Before starting to develop plugins, you will need to install Xi-CAM and some of its dependencies.

Follow the QuickStart guide to get started with installation and exploring an example Xi-CAM plugin (covers GUIPlugin, Workflow, and OperationPlugins).

For more detailed documentation, you may want to visit the following:

• GUIPlugin documentation

• OperationPlugin documentation

• Workflow documentation

The Resources section has useful links to tutorials, examples, and documentation that can help with developing Xi-CAM plugins.

Developer Documentation

• QuickStart Guide
• Installing Xi-CAM for Linux
• Installing Xi-CAM for MacOS
• Installing Xi-CAM for Windows
• GUIPlugin Documentation
• Entry Points
• OperationPlugin Documentation
• Workflow Documentation
• Data ingestion in Xi-CAM
• Resources

Links

• Xi-CAM GitHub Organization

Indices and tables

• Index

• Module Index

• Search Page