Xi-CAM
Site
QuickStart Guide
GUIPlugin documentation
OperationPlugin documentation
Workflow documentation
Install Xi-CAM
Overview
Looking at Xi-CAM’s Main Window
Download and Install the ExamplePlugin
How Do I Load Data?
Examining the Code
Installing Xi-CAM for Linux
Install python3
Create and Activate a Virtual Environment
Install Python Qt Bindings
Install the Xi-CAM package
Where Do I Go from Here?
Installing Xi-CAM for MacOS
Install python3
Create and Activate a Virtual Environment
Install Python Qt Bindings
Install the Xi-CAM package
Where Do I Go from Here?
Installing Xi-CAM for Windows
Install python3
Install Python Qt Bindings
Install the Xi-CAM package
Where Do I Go from Here?
Copyable Instructions
GUIPlugin Documentation
What Is A GUIPlugin?
How Do I Create a GUIPlugin?
How Do I Load Data into My Plugin?
API Reference
Entry Points
Xi-CAM Entry Points
More Information
OperationPlugin Documentation
What Is an OperationPlugin?
How Do I Use an OperationPlugin?
API Documentation
Workflow Documentation
What Is a Workflow?
Useful Methods for Modifying the Workflow
Executing a Workflow
API Reference
Data ingestion in Xi-CAM
What is an ingestor?
Resources
Example Xi-CAM Plugins
Git
NSLS-II
Python
Qt
Page
Index
A
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
R
|
S
|
T
|
U
|
V
|
W
A
add_link() (xicam.core.execution.Workflow method)
add_operation() (xicam.core.execution.Workflow method)
add_operations() (xicam.core.execution.Workflow method)
appendCatalog() (xicam.plugins.guiplugin.GUIPlugin method)
as_dask_graph() (xicam.core.execution.Workflow method)
attach() (xicam.core.execution.Workflow method)
auto_connect_all() (xicam.core.execution.Workflow method)
C
categories() (in module xicam.plugins.operationplugin)
clear_links() (xicam.core.execution.Workflow method)
clear_operation_links() (xicam.core.execution.Workflow method)
clear_operations() (xicam.core.execution.Workflow method)
D
describe_input() (in module xicam.plugins.operationplugin)
describe_output() (in module xicam.plugins.operationplugin)
detach() (xicam.core.execution.Workflow method)
disabled (xicam.plugins.operationplugin.OperationPlugin attribute)
disabled() (xicam.core.execution.Workflow method)
disabled_operations() (xicam.core.execution.Workflow method)
display_name (xicam.plugins.operationplugin.OperationPlugin attribute)
display_name() (in module xicam.plugins.operationplugin)
E
enabled() (xicam.core.execution.Workflow method)
execute() (xicam.core.execution.Workflow method)
execute_all() (xicam.core.execution.Workflow method)
F
fill_kwargs() (xicam.core.execution.Workflow method)
filled_values (xicam.plugins.operationplugin.OperationPlugin attribute)
fixable (xicam.plugins.operationplugin.OperationPlugin attribute)
fixed (xicam.plugins.operationplugin.OperationPlugin attribute)
fixed() (in module xicam.plugins.operationplugin)
G
get_inbound_links() (xicam.core.execution.Workflow method)
get_outbound_links() (xicam.core.execution.Workflow method)
GUILayout (class in xicam.plugins.guiplugin)
GUIPlugin (class in xicam.plugins.guiplugin)
H
hints (xicam.plugins.operationplugin.OperationPlugin attribute)
I
input_descriptions (xicam.plugins.operationplugin.OperationPlugin attribute)
input_names (xicam.plugins.operationplugin.OperationPlugin attribute)
input_names() (in module xicam.plugins.operationplugin)
insert_operation() (xicam.core.execution.Workflow method)
L
limits (xicam.plugins.operationplugin.OperationPlugin attribute)
limits() (in module xicam.plugins.operationplugin)
links() (xicam.core.execution.Workflow method)
M
message (xicam.plugins.operationplugin.ValidationError attribute)
N
notify() (xicam.core.execution.Workflow method)
O
operation (xicam.plugins.operationplugin.ValidationError attribute)
operation() (in module xicam.plugins.operationplugin)
operation_links() (xicam.core.execution.Workflow method)
OperationPlugin (class in xicam.plugins.operationplugin)
operations (xicam.core.execution.Workflow property)
opts (xicam.plugins.operationplugin.OperationPlugin attribute)
opts() (in module xicam.plugins.operationplugin)
output_descriptions (xicam.plugins.operationplugin.OperationPlugin attribute)
output_names (xicam.plugins.operationplugin.OperationPlugin attribute)
output_names() (in module xicam.plugins.operationplugin)
output_shape (xicam.plugins.operationplugin.OperationPlugin attribute)
output_shape() (in module xicam.plugins.operationplugin)
R
remove_link() (xicam.core.execution.Workflow method)
remove_operation() (xicam.core.execution.Workflow method)
S
set_disabled() (xicam.core.execution.Workflow method)
stage() (xicam.core.execution.Workflow method)
stages (xicam.plugins.guiplugin.GUIPlugin property)
T
toggle_disabled() (xicam.core.execution.Workflow method)
U
units (xicam.plugins.operationplugin.OperationPlugin attribute)
units() (in module xicam.plugins.operationplugin)
V
validate() (xicam.core.execution.Workflow method)
ValidationError (class in xicam.plugins.operationplugin)
visible (xicam.plugins.operationplugin.OperationPlugin attribute)
visible() (in module xicam.plugins.operationplugin)
W
Workflow (class in xicam.core.execution)