TheVirtualBrain:

TheDocumentationwebsite.

Table Of Contents

Previous topic

Suggested Coding Conventions.

Next topic

h5 Package

This Page

storage Package

storage_interface

This module is an interface for the tvb storage module. All calls to methods from this module must be done through this class.

class tvb.storage.storage_interface.StorageInterface[source]

Bases: builtins.object

IMAGES_FOLDER = 'IMAGES'
OPERATION_FOLDER_PREFIX = 'Operation_'
PROJECTS_FOLDER = 'PROJECTS'
ROOT_NODE_PATH = '/'
TEMP_FOLDER = 'TEMP'
TVB_FILE_EXTENSION = '.xml'
TVB_PROJECT_FILE = 'Project.xml'
TVB_STORAGE_FILE_EXTENSION = '.h5'
TVB_ZIP_FILE_EXTENSION = '.zip'
ZIP_FILE_EXTENSION = 'zip'
build_data_export_folder(data, export_folder)[source]
check_and_delete(folder)[source]
check_created(path='/home/tvb_user/TVB_STORAGE/')[source]
cleanup_encryption_handler(dir_gid)[source]
static compute_recursive_h5_disk_usage(start_path='.')[source]
static compute_size_on_disk(file_path)[source]
static copy_file(source, dest, dest_postfix=None, buffer_size=1048576)[source]
dec_running_op_count(folder)[source]
decrypt_files_to_dir(dir_gid, files, dir)[source]
decrypt_results_to_dir(dir_gid, dir, from_subdir=None)[source]
encrypt_inputs(dir_gid, files_to_encrypt, subdir=None)[source]
static encryption_enabled()[source]
ends_with_tvb_file_extension(file)[source]
ends_with_tvb_storage_file_extension(file)[source]
export_datatypes(paths, operation)[source]
export_project(project, folders_to_exclude, export_folder, linked_paths, op)[source]
static generate_random_password(pass_size)[source]
get_allen_mouse_cache_folder(project_name)[source]
get_current_enc_dirname(dir_gid)[source]
get_encrypted_dir(dir_gid)[source]
get_filenames_in_zip(dest_path, mode='r')[source]
get_images_folder(project_name)[source]
get_password_file(dir_gid)[source]
get_project_folder(project_name, *sub_folders)[source]
get_project_meta_file_path(project_name)[source]
static get_projects_folder()[source]
static get_storage_manager(file_full_path)[source]
get_temp_folder(project_name)[source]
get_tumor_dataset_folder()[source]
inc_project_usage_count(folder)[source]
inc_running_op_count(folder)[source]
is_in_usage(project_folder)[source]
join()[source]
logger = <Logger tvb.storage.storage_interface (DEBUG)>
mark_stop()[source]
move_datatype_with_sync(to_project, to_project_path, new_op_id, full_path, vm_full_path)[source]
open_tvb_zip(dest_path, name, mode='r')[source]
push_folder_to_sync(project_name)[source]
read_metadata_from_xml(xml_path)[source]
read_project_metadata(project_path)[source]
remove_datatype_file(h5_file)[source]
static remove_files(file_list, ignore_exception=False)[source]
static remove_folder(folder_path, ignore_errors=False)[source]
remove_image_metadata(figure)[source]
remove_operation_data(project_name, operation_id)[source]
remove_project(project)[source]
remove_project_structure(project_name)[source]
rename_project(current_proj_name, new_name)[source]
run()[source]
set_project_active(project, linked_dt=None)[source]
set_project_inactive(project)[source]
start()[source]
static startup_cleanup()[source]
static sync_folders(folder)[source]
unpack_zip(uploaded_zip, folder_path)[source]
write_image_metadata(figure, meta_entity)[source]
write_metadata_in_xml(entity, final_path)[source]
write_project_metadata(meta_dictionary)[source]
write_project_metadata_from_dict(project_path, meta_entity)[source]
write_zip_folder(dest_path, folder, exclude=None)[source]
static zip_folder(result_name, folder_root)[source]
zip_folders(all_datatypes, project_name, zip_full_path)[source]