importers Package

brain_tumor_connectivity_importer

Import connectivities from Brain Tumor zip archives

tvb.interfaces.command.demos.importers.brain_tumor_connectivity_importer.import_surface_rm(project_id, conn_gid)

tvb.interfaces.command.demos.importers.brain_tumor_connectivity_importer.import_tumor_connectivities(project_id, folder_path)

h5_import

Launch an operation from the command line

tvb.interfaces.command.demos.importers.h5_import.import_h5(file_path, project_id)

new_importer

Adapter example.

class tvb.interfaces.command.demos.importers.new_importer.FooDataImporter

Bases: ABCUploader

get_form_class()

get_output()

Describes inputs and outputs of the launch method.

launch(view_model: FooDataImporterModel) → TimeSeriesIndex

To be implemented in each Adapter. Will contain the logic of the Adapter. Takes a ViewModel with data, dependency direction is: Adapter -> Form -> ViewModel Any returned DataType will be stored in DB, by the Framework.

Parameters:

view_model – the data model corresponding to the current adapter

logger = <Logger tvb.interfaces.command.demos.importers.new_importer (DEBUG)>

class tvb.interfaces.command.demos.importers.new_importer.FooDataImporterForm

Bases: ABCUploaderForm

static get_upload_information()

static get_view_model()

Should keep the ViewModel class that corresponds to the current Adapter. :return: ViewModel class

class tvb.interfaces.command.demos.importers.new_importer.FooDataImporterModel(**kwargs)

Bases: UploaderViewModel

Traited class [tvb.interfaces.command.demos.importers.new_importer.FooDataImporterModel]

Attributes declared

array_data : tvb.interfaces.command.demos.importers.new_importer.FooDataImporterModel.array_data = Str(field_type=<class ‘str’>, default=None, required=True)

data_subject : tvb.core.neotraits.uploader_view_model.UploaderViewModel.data_subject = Str(field_type=<class ‘str’>, default=’John Doe’, required=True)

encrypted_aes_keytvb.core.neotraits.uploader_view_model.UploaderViewModel.encrypted_aes_key = Str(field_type=<class ‘str’>, default=None, required=False)

Check our demo notebook on how to produce this key and how we expect your files to be encrypted

operation_group_gid : tvb.core.neotraits.view_model.ViewModel.operation_group_gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=False)

ranges : tvb.core.neotraits.view_model.ViewModel.ranges = Attr(field_type=<class ‘str’>, default=None, required=False)

range_values : tvb.core.neotraits.view_model.ViewModel.range_values = Attr(field_type=<class ‘str’>, default=None, required=False)

is_metric_operation : tvb.core.neotraits.view_model.ViewModel.is_metric_operation = Attr(field_type=<class ‘bool’>, default=False, required=True)

gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)

array_data

new_importer_launcher

Launch an operation from the command line