CAPSUL programming API documentation

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

Classes inheritance diagram

Inheritance diagram of capsul.attributes, capsul.attributes.attributes_factory, capsul.attributes.attributes_schema, capsul.attributes.completion_engine_factory, capsul.attributes.completion_engine_iteration, capsul.attributes.completion_engine, capsul.attributes.fom_completion_engine, capsul.engine, capsul.engine.database_json, capsul.engine.database_populse, capsul.engine.database, capsul.engine.module, capsul.in_context, capsul.in_context.fsl, capsul.pipeline, capsul.pipeline.pipeline, capsul.pipeline.pipeline_construction, capsul.pipeline.pipeline_nodes, capsul.pipeline.pipeline_tools, capsul.pipeline.pipeline_workflow, capsul.pipeline.process_iteration, capsul.pipeline.python_export, capsul.pipeline.topological_sort, capsul.pipeline.xml, capsul.pipeline.custom_nodes, capsul.pipeline.custom_nodes.strcat_node, capsul.pipeline.custom_nodes.cv_node, capsul.pipeline.custom_nodes.loo_node, capsul.pipeline.custom_nodes.map_node, capsul.pipeline.custom_nodes.reduce_node, capsul.plugins, capsul.process, capsul.process.process, capsul.process.nipype_process, capsul.process.runprocess, capsul.process.xml, capsul.qt_apps, capsul.qt_apps.utils, capsul.qt_apps.utils.application, capsul.qt_apps.utils.fill_treectrl, capsul.qt_apps.utils.find_pipelines, capsul.qt_apps.utils.window, capsul.qt_gui, capsul.qt_gui.board_widget, capsul.qt_gui.widgets, capsul.qt_gui.widgets.activation_inspector, capsul.qt_gui.widgets.attributed_process_widget, capsul.qt_gui.widgets.links_debugger, capsul.qt_gui.widgets.pipeline_developer_view, capsul.qt_gui.widgets.pipeline_file_warning_widget, capsul.qt_gui.widgets.pipeline_user_view, capsul.qt_gui.widgets.viewer_widget, capsul.sphinxext, capsul.sphinxext.layoutdocgen, capsul.sphinxext.load_pilots, capsul.sphinxext.pipelinedocgen, capsul.sphinxext.usecasesdocgen, capsul.study_config, capsul.study_config.study_config, capsul.study_config.config_utils, capsul.study_config.memory, capsul.study_config.process_instance, capsul.study_config.run, capsul.study_config.config_modules.attributes_config, capsul.study_config.config_modules.brainvisa_config, capsul.study_config.config_modules.fom_config, capsul.study_config.config_modules.freesurfer_config, capsul.study_config.config_modules.fsl_config, capsul.study_config.config_modules.matlab_config, capsul.study_config.config_modules.nipype_config, capsul.study_config.config_modules.smartcaching_config, capsul.study_config.config_modules.somaworkflow_config, capsul.study_config.config_modules.spm_config, capsul.subprocess, capsul.subprocess.fsl, capsul.subprocess.spm, capsul.utils, capsul.utils.finder, capsul.utils.version_utils

Main classes and functions

capsul.pipeline: Pipeline

Pipeline Definition

Node Types

Plug

capsul.process: Process

Classes

Functions

Configuration and execution

capsul.engine: Configuration and execution

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

Classes:

Functions:

capsul.study_config: Study Configuration

Study Configuration:

Configuration Modules:

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:

in_context

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:

capsul.subprocess.fsl Functions:

capsul.subprocess.spm Classes:

capsul.subprocess.spm Functions:

Workflow conversion

GUI

Graphical widgets classes

capsul.qt_gui.widgets: Pipeline Viewers

Graphical pipeline debugging tools

Complete modules list