Source code for tvb.adapters.exporters.tvb_linked_export

# -*- coding: utf-8 -*-
# TheVirtualBrain-Framework Package. This package holds all Data Management, and
# Web-UI helpful to run brain-simulations. To use it, you also need to download
# TheVirtualBrain-Scientific Package (for simulators). See content of the
# documentation-folder for more details. See also
# (c) 2012-2024, Baycrest Centre for Geriatric Care ("Baycrest") and others
# This program is free software: you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software Foundation,
# either version 3 of the License, or (at your option) any later version.
# This program is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
# PARTICULAR PURPOSE.  See the GNU General Public License for more details.
# You should have received a copy of the GNU General Public License along with this
# program.  If not, see <>.
# When using The Virtual Brain for scientific publications, please cite it as explained here:

.. moduleauthor:: Adrian Dordea <>

from tvb.adapters.exporters.abcexporter import ABCExporter
from tvb.core.entities import load
from tvb.core.entities.model.model_datatype import DataType, DataTypeGroup
from tvb.core.neocom import h5
from tvb.core.neotraits.h5 import H5File
from import StorageInterface

[docs] class TVBLinkedExporter(ABCExporter): """ """ def __init__(self): self.storage_interface = StorageInterface()
[docs] def get_supported_types(self): return [DataType]
[docs] def get_label(self): return "TVB Format with links"
[docs] def gather_datatypes_for_copy(self, data, dt_path_list): data_path = h5.path_for_stored_index(data) if data_path not in dt_path_list: dt_path_list.append(data_path) with H5File.from_file(data_path) as f: sub_dt_refs = f.gather_references() for _, ref_gid in sub_dt_refs: if ref_gid: dt = load.load_entity_by_gid(ref_gid) self.gather_datatypes_for_copy(dt, dt_path_list)
[docs] def export(self, data, project, public_key_path, password): """ Exports data type: 1. If data is a normal data type, simply exports storage file (HDF format) 2. If data is a DataTypeGroup creates a zip with all files for all data types """ download_file_name = self._get_export_file_name(data) if DataTypeGroup.is_data_a_group(data): all_datatypes, op_file_dict = self.prepare_datatypes_for_export(data) # Copy the linked datatypes dt_path_list = [] data_type = all_datatypes[0] self.gather_datatypes_for_copy(data_type, dt_path_list) # Create ZIP archive zip_file = self.storage_interface.export_datatypes_structure(op_file_dict, data, download_file_name, public_key_path, password, (dt_path_list[1:], data_type)) return download_file_name, zip_file, True else: dt_path_list = [] self.gather_datatypes_for_copy(data, dt_path_list) download_file_name = self._get_export_file_name(data) zip_to_export = self.storage_interface.export_datatypes(dt_path_list, data, download_file_name, public_key_path, password) return None, zip_to_export, True
[docs] def get_export_file_extension(self, data): return StorageInterface.TVB_ZIP_FILE_EXTENSION
[docs] def skip_group_datatypes(self): return False