solidipes package

Subpackages

• solidipes.loaders package
  • Submodules
    • solidipes.loaders.abaqus module
      • Abaqus
      • ParseAbaqus
    • solidipes.loaders.binary module
      • Binary
    • solidipes.loaders.cached_metadata module
      • CachedMetadata
      • _default_cached_attributes
      • cached_loadable
      • cached_property
    • solidipes.loaders.code_snippet module
      • CodeSnippet
    • solidipes.loaders.data_container module
      • DataContainer
      • loadable
      • wrap_errors()
    • solidipes.loaders.file module
      • File
      • LoaderList
      • _supported_extensions
      • get_cached_preferred_loader()
      • load_file()
    • solidipes.loaders.file_sequence module
      • FileSequence
    • solidipes.loaders.geof_mesh module
      • GeofMesh
    • solidipes.loaders.gnuplot module
      • GnuPlot
    • solidipes.loaders.group module
      • Group
      • LoaderList
      • load_groups()
    • solidipes.loaders.hdf5 module
      • HDF5
    • solidipes.loaders.image module
      • Image
      • SVGWrapper
    • solidipes.loaders.image_sequence module
      • ImageSequence
    • solidipes.loaders.matlab module
      • MatlabData
    • solidipes.loaders.meshio module
      • Meshio
    • solidipes.loaders.mime_types module
      • get_extension()
      • get_extension2mime_types()
      • get_mime_type()
      • get_mime_type2extensions()
      • get_possible_extensions()
      • get_possible_mimes()
      • is_valid_extension()
      • make_from_text()
    • solidipes.loaders.notebook module
      • Notebook
    • solidipes.loaders.parse_inp module
      • ParseGEOF
      • ParseINP
      • read_geof()
    • solidipes.loaders.pdf module
      • PDF
    • solidipes.loaders.pyvista_mesh module
      • DEFAULT_DATA_ID
      • PyvistaMesh
      • get_cell_data_from_id_or_array()
      • get_point_data_from_id_or_array()
    • solidipes.loaders.sequence module
      • Sequence
    • solidipes.loaders.symlink module
      • SymLink
    • solidipes.loaders.table module
      • Table
    • solidipes.loaders.text module
      • Markdown
      • Text
    • solidipes.loaders.tikz module
      • TIKZ
    • solidipes.loaders.video module
      • Video
    • solidipes.loaders.xdmf module
      • XDMF
    • solidipes.loaders.xml module
      • XML
  • Module contents
    • Abaqus
      • Abaqus.elements()
      • Abaqus.mesh
      • Abaqus.meshes
      • Abaqus.nodes()
      • Abaqus.parts
      • Abaqus.structure
      • Abaqus.supported_mime_types
      • Abaqus.xml
    • Binary
      • Binary._valid_extension()
      • Binary.text
    • CachedMetadata
      • CachedMetadata._cancel_scheduled_commit()
      • CachedMetadata._commit()
      • CachedMetadata._get_default_cached_attributes()
      • CachedMetadata._get_zodb_file_storage()
      • CachedMetadata._global_cached_metadata
      • CachedMetadata._init_cached_metadata()
      • CachedMetadata._populate_cached_metadata_from_yaml()
      • CachedMetadata._schedule_commit()
      • CachedMetadata._scheduled_commit
      • CachedMetadata._scheduler
      • CachedMetadata._storage
      • CachedMetadata._transaction_manager
      • CachedMetadata._write_cached_metadata_to_yaml()
      • CachedMetadata.cached_loadable
      • CachedMetadata.cached_property
      • CachedMetadata.clear_cache()
      • CachedMetadata.clear_cached_metadata()
      • CachedMetadata.close_cached_metadata()
      • CachedMetadata.get_cached_metadata()
      • CachedMetadata.get_global_cached_metadata()
      • CachedMetadata.global_cached_metadata
      • CachedMetadata.is_cache_invalid()
      • CachedMetadata.load_cached_metadata()
      • CachedMetadata.modified_time
      • CachedMetadata.save_field_to_cache()
      • CachedMetadata.set_cached_metadata_entry()
      • CachedMetadata.update_cached_metadata()
      • CachedMetadata.update_global_cached_metadata()
    • CodeSnippet
      • CodeSnippet._valid_loading()
      • CodeSnippet.lint
      • CodeSnippet.lint_errors
      • CodeSnippet.lint_raw
      • CodeSnippet.supported_mime_types
      • CodeSnippet.text
    • DataContainer
      • DataContainer._data_collection
      • DataContainer._has_native_attr()
      • DataContainer._valid_loading()
      • DataContainer.add()
      • DataContainer.copy()
      • DataContainer.data
      • DataContainer.data_info
      • DataContainer.default_viewer
      • DataContainer.errors
      • DataContainer.get()
      • DataContainer.has()
      • DataContainer.load_all()
      • DataContainer.loadable
      • DataContainer.remove()
      • DataContainer.view()
    • File
      • File._supported_extensions()
      • File._valid_extension()
      • File._valid_loading()
      • File._valid_non_empty()
      • File.add_message()
      • File.archive_discussions()
      • File.archived_discussions
      • File.check_file_support()
      • File.discussions
      • File.file_info
      • File.file_stats
      • File.modified_time
      • File.preferred_loader_name
      • File.supported_mime_types
      • File.valid_loading
    • FileSequence
      • FileSequence._abc_impl
      • FileSequence._find_groups()
      • FileSequence._load_element()
      • FileSequence._set_total_size()
      • FileSequence.modified_time
      • FileSequence.paths
      • FileSequence.select_file()
    • GeofMesh
      • GeofMesh.mesh
      • GeofMesh.supported_mime_types
    • GnuPlot
      • GnuPlot.image
      • GnuPlot.supported_mime_types
    • Group
      • Group._abc_impl
      • Group._find_groups()
    • HDF5
      • HDF5.datasets
      • HDF5.supported_mime_types
    • Image
      • Image.exif_data
      • Image.get_exif_data()
      • Image.image
      • Image.supported_mime_types
    • Markdown
      • Markdown.supported_mime_types
    • MatlabData
      • MatlabData.arrays
      • MatlabData.supported_mime_types
    • Meshio
      • Meshio.mesh
    • Notebook
      • Notebook.notebook
      • Notebook.supported_mime_types
    • PDF
      • PDF.pdf
      • PDF.supported_mime_types
    • PyvistaMesh
      • PyvistaMesh.add_cell_data()
      • PyvistaMesh.add_point_data()
      • PyvistaMesh.cell_data_names
      • PyvistaMesh.copy_pyvista_data_to_collection()
      • PyvistaMesh.data_info
      • PyvistaMesh.default_viewer
      • PyvistaMesh.get_cell_data()
      • PyvistaMesh.get_point_data()
      • PyvistaMesh.get_warped()
      • PyvistaMesh.mesh
      • PyvistaMesh.point_data_names
      • PyvistaMesh.pyvista_mesh
      • PyvistaMesh.remove_cell_data()
      • PyvistaMesh.remove_point_data()
      • PyvistaMesh.set_cell_values()
      • PyvistaMesh.set_point_values()
      • PyvistaMesh.supported_mime_types
    • SymLink
      • SymLink._valid_loading()
      • SymLink.linked_file
    • TIKZ
      • TIKZ.pdf
      • TIKZ.supported_mime_types
    • Table
      • Table.header
      • Table.read_csv()
      • Table.read_numpy()
      • Table.supported_mime_types
      • Table.table
      • Table.validate_header()
    • Text
      • Text.supported_mime_types
      • Text.text
    • Video
      • Video.supported_mime_types
      • Video.video
    • XDMF
      • XDMF._element_count
      • XDMF._load_element()
      • XDMF._load_hdf5_data_item()
      • XDMF._load_xdmf_data_item()
      • XDMF.domain
      • XDMF.find_dataitem_from_ref()
      • XDMF.grid
      • XDMF.grids
      • XDMF.mesh
      • XDMF.mesh_name
      • XDMF.n_frames
      • XDMF.select_frame()
      • XDMF.supported_mime_types
      • XDMF.version
      • XDMF.xdmf
    • XML
      • XML.supported_mime_types
      • XML.xml
    • load_file()
    • load_groups()
• solidipes.reports package
  • Subpackages
    • solidipes.reports.widgets package
      • Submodules
      • Module contents
  • Submodules
    • solidipes.reports.curation module
      • CurationReport
    • solidipes.reports.jtcam module
      • JTCAMReport
      • JTCAMReportEditable
      • JTCAMReportSpawner
      • jtcam_icon()
    • solidipes.reports.report module
      • Report
    • solidipes.reports.web_report module
      • WebReport
      • WebReportSpawner
      • clear_session_state()
      • sp_page()
  • Module contents
• solidipes.scanners package
  • Submodules
    • solidipes.scanners.scanner module
      • DictTree
      • ExportScanner
      • FilepathTree
      • LoaderTree
      • ProgressBar
      • Scanner
      • StreamlitProgressBar
      • cached_scan()
      • convert_filepath_tree_to_loader_tree()
      • list_files()
  • Module contents
• solidipes.scripts package
  • Submodules
    • solidipes.scripts.download module
      • main()
      • populate_arg_parser()
      • process_metadata()
    • solidipes.scripts.generate_report module
      • main()
      • populate_arg_parser()
    • solidipes.scripts.init module
      • create_ignore_file()
      • create_metadata_file()
      • create_solidipes_directory()
      • get_existing_description()
      • main()
      • populate_arg_parser()
    • solidipes.scripts.main module
      • main_PYTHON_ARGCOMPLETE_OK()
      • parse_args()
    • solidipes.scripts.mount module
      • get_mount_info_from_args()
      • main()
      • populate_arg_parser()
      • populate_nfs_parser()
      • populate_s3_parser()
      • populate_smb_parser()
      • populate_ssh_parser()
    • solidipes.scripts.quick_view module
      • main()
      • populate_arg_parser()
    • solidipes.scripts.unmount module
      • main()
      • populate_arg_parser()
    • solidipes.scripts.upload module
      • main()
      • populate_arg_parser()
  • Module contents
• solidipes.uploaders package
  • Submodules
    • solidipes.uploaders.renku module
      • RenkulabUploader
      • add_remote()
      • get_session_link()
      • init_git()
      • init_renku()
      • main()
      • push()
    • solidipes.uploaders.uploader module
      • Uploader
    • solidipes.uploaders.zenodo module
      • ZenodoUploader
      • _get_archive_filename()
      • create_archive()
      • get_cleaned_deposition_infos()
      • get_deposition_uri()
      • get_root_directory()
      • handle_zenodo_exception()
      • load_and_check_metadata()
      • main()
      • text_progress_bar()
  • Module contents
• solidipes.utils package
  • Submodules
    • solidipes.utils.cloud module
      • add_global_mount_info()
      • check_process_return()
      • connect_to_postgres()
      • convert_cloud_to_cloud()
      • convert_local_to_cloud()
      • get_existing_mount_info()
      • get_mount_id()
      • list_mounts()
      • mount()
      • mount_all()
      • mount_nfs_with_mount_command()
      • mount_s3_juicefs()
      • mount_s3_juicefs_psql()
      • mount_s3_juicefs_sqlite3()
      • mount_s3fs()
      • mount_smb_with_mount_command()
      • mount_sshfs()
      • mount_with_mount_command()
      • remove_keys_from_info()
      • rsync()
      • unmount()
      • unmount_all()
      • wait_mount()
      • write_temp_passwd_file()
    • solidipes.utils.config module
    • solidipes.utils.git_infos module
      • GitInfos
    • solidipes.utils.list_subclasses module
      • get_subclass_from_module()
      • get_subclasses_from_package()
    • solidipes.utils.metadata module
    • solidipes.utils.solidipes_logging module
      • FormatterShell
      • getLogger()
      • invalidPrint()
    • solidipes.utils.utils module
      • _get_config_path()
      • add_completed_stage()
      • bcolors
      • dict_to_pretty_str()
      • find_config_directory()
      • generate_readme()
      • get_cloud_dir_path()
      • get_cloud_info()
      • get_completed_stages()
      • get_config()
      • get_config_path()
      • get_git_repository()
      • get_git_root()
      • get_ignore()
      • get_mimes()
      • get_mimes_path()
      • get_path_relative_to_root()
      • get_path_relative_to_workdir()
      • get_readme_path()
      • get_solidipes_directory()
      • get_study_description_path()
      • get_study_log_path()
      • get_study_metadata()
      • get_study_metadata_path()
      • get_study_root_path()
      • get_user_solidipes_directory()
      • get_zenodo_infos()
      • include_metadata_description()
      • init_git_repository()
      • is_stage_completed()
      • load_yaml()
      • populate_metadata_mandatory_fields()
      • remove_completed_stage()
      • rename_file()
      • save_yaml()
      • separate_metadata_description()
      • set_cloud_info()
      • set_config()
      • set_ignore()
      • set_mimes()
      • set_study_metadata()
      • set_zenodo_infos()
      • transform_data_containers_to_dict()
      • transform_dict_to_data_containers()
    • solidipes.utils.viewer_backends module
      • set_backend()
    • solidipes.utils.zenodo_utils module
      • ZenodoException
      • _download_zenodo_licenses()
      • check_response()
      • clean_deposition()
      • create_deposition()
      • download_file()
      • download_files()
      • get_access_token()
      • get_existing_deposition_identifier()
      • get_existing_deposition_infos()
      • get_host_and_id()
      • save_deposition_identifier()
      • upload_archive()
      • upload_deposition_metadata()
  • Module contents
    • ZenodoException
    • add_completed_stage()
    • bcolors
      • bcolors.BLACK
      • bcolors.BLINK
      • bcolors.BLUE
      • bcolors.BOLD
      • bcolors.BRIGHT_BLACK
      • bcolors.BRIGHT_BLUE
      • bcolors.BRIGHT_CYAN
      • bcolors.BRIGHT_GREEN
      • bcolors.BRIGHT_MAGENTA
      • bcolors.BRIGHT_RED
      • bcolors.BRIGHT_WHITE
      • bcolors.BRIGHT_YELLOW
      • bcolors.CYAN
      • bcolors.GREEN
      • bcolors.MAGENTA
      • bcolors.RED
      • bcolors.RESET
      • bcolors.UNDERLINE
      • bcolors.WHITE
      • bcolors.YELLOW
    • check_response()
    • download_files()
    • generate_readme()
    • get_cloud_info()
    • get_completed_stages()
    • get_git_repository()
    • get_git_root()
    • get_host_and_id()
    • get_ignore()
    • get_mimes()
    • get_path_relative_to_root()
    • get_readme_path()
    • get_study_description_path()
    • get_study_log_path()
    • get_study_metadata()
    • get_study_metadata_path()
    • get_study_root_path()
    • include_metadata_description()
    • is_stage_completed()
    • list_mounts()
    • mount_all()
    • mount_s3fs()
    • remove_completed_stage()
    • rename_file()
    • set_cloud_info()
    • set_ignore()
    • set_mimes()
    • set_study_metadata()
    • unmount()
• solidipes.viewers package
  • Submodules
    • solidipes.viewers.binary module
      • Binary
    • solidipes.viewers.code_snippet module
      • Code
      • guess_language()
    • solidipes.viewers.hdf5 module
      • HDF5
      • scan_hdf5_recursively()
    • solidipes.viewers.image module
      • Image
    • solidipes.viewers.image_source module
      • ImageSource
    • solidipes.viewers.matlab module
      • MatlabData
    • solidipes.viewers.notebook module
      • Notebook
    • solidipes.viewers.pdf module
      • PDF
    • solidipes.viewers.pyvista_plotter module
      • PyvistaPlotter
    • solidipes.viewers.symlink module
      • SymLink
    • solidipes.viewers.table module
      • Table
    • solidipes.viewers.text module
      • MarkdownViewer
      • Text
    • solidipes.viewers.video module
      • Video
    • solidipes.viewers.viewer module
      • Viewer
      • wrap_errors()
    • solidipes.viewers.xdmf module
      • XDMF
    • solidipes.viewers.xml module
      • XML
  • Module contents
    • Binary
      • Binary._abc_impl
      • Binary.add()
      • Binary.show()
    • Code
      • Code._abc_impl
      • Code.add()
      • Code.show()
    • HDF5
      • HDF5._abc_impl
      • HDF5.add()
      • HDF5.datasets
      • HDF5.show()
    • Image
      • Image._abc_impl
      • Image.add()
      • Image.image
      • Image.show()
      • Image.svg_format()
    • ImageSource
      • ImageSource._abc_impl
      • ImageSource.add()
      • ImageSource.image
      • ImageSource.show()
    • MarkdownViewer
      • MarkdownViewer._abc_impl
      • MarkdownViewer.show()
    • MatlabData
      • MatlabData._abc_impl
      • MatlabData.add()
      • MatlabData.arrays
      • MatlabData.show()
    • Notebook
      • Notebook._abc_impl
      • Notebook.add()
      • Notebook.notebook
      • Notebook.show()
    • PDF
      • PDF._abc_impl
      • PDF.add()
      • PDF.pdf
      • PDF.show()
    • PyvistaPlotter
      • PyvistaPlotter._abc_impl
      • PyvistaPlotter._update_path_list()
      • PyvistaPlotter.add()
      • PyvistaPlotter.add_mesh()
      • PyvistaPlotter.add_points()
      • PyvistaPlotter.plotter
      • PyvistaPlotter.save()
      • PyvistaPlotter.show()
      • PyvistaPlotter.shown
    • SymLink
      • SymLink._abc_impl
      • SymLink.add()
      • SymLink.show()
      • SymLink.video
    • Table
      • Table._abc_impl
      • Table.add()
      • Table.data_container
      • Table.show()
      • Table.show_plot()
    • Text
      • Text._abc_impl
      • Text.add()
      • Text.show()
      • Text.text
    • Video
      • Video._abc_impl
      • Video.add()
      • Video.show()
      • Video.video
    • Viewer
      • Viewer._abc_impl
      • Viewer.add()
      • Viewer.check_data_compatibility()
      • Viewer.compatible_data_types
      • Viewer.save()
      • Viewer.show()
    • XDMF
      • XDMF._abc_impl
      • XDMF.add()
      • XDMF.show()
    • XML
      • XML._abc_impl
      • XML.add()
      • XML.show()

Module contents

Computational solid mechanics package for loading and visualizing files

solidipes.load_file(path)

Load a file from path into the appropriate object type