CAPSUL programming API documentation¶

See also the User Guide section for more general usage documentation.

Classes inheritance diagram¶

Main classes and functions¶

`capsul.pipeline`: Pipeline¶

Pipeline Definition¶

Pipeline

Node Types¶

Plug¶

Plug

`capsul.process`: Process¶

Classes¶

Functions¶

get_process_instance()

Configuration and execution¶

`capsul.engine`: Configuration and execution¶

This new system will replace capsul.study_config in Capsul v3.

Classes:¶

CapsulEngine

Functions:¶

capsul_engine()

`capsul.study_config`: Study Configuration¶

Study Configuration:¶

Configuration Modules:¶

somaworkflow_config.SomaWorkflowConfig
matlab_config.MatlabConfig
spm_config.SPMConfig
fsl_config.FSLConfig
freesurfer_config.FreeSurferConfig
nipype_config.NipypeConfig
brainvisa_config.BrainVISAConfig
fom_config.FomConfig
attributes_config.AttributesConfig
smartcaching_config.SmartCachingConfig

`capsul.attributes`: Attributes and processes completion¶

See also the user doc Parameters completion.

Classes¶

Running external software¶

`capsul.in_context`¶

The new system which will be used in Capsul v3 is based on CapsulEngine and is the module:

`capsul.subprocess`¶

This module is obsolete and will be replaced by in_process. It is still used in Capsul v2 when using StudyConfig.

`capsul.subprocess.fsl` Classes:¶

Popen

`capsul.subprocess.fsl` Functions:¶

fsl_command_with_environment()
check_fsl_configuration()
check_configuration_values()
auto_configuration()
call()
check_call()
check_output()

`capsul.subprocess.spm` Classes:¶

Popen

`capsul.subprocess.spm` Functions:¶

Workflow conversion¶

GUI¶

Graphical widgets classes

`capsul.qt_gui.widgets`: Pipeline Viewers¶

PipelineDeveloperView
PipelineUserView
AttributedProcessWidget

Graphical pipeline debugging tools¶

ActivationInspector
CapsulLinkDebuggerView

Complete modules list¶