solidipes.loaders package

Submodules

Module contents

class solidipes.loaders.Abaqus(**kwargs)[source]

Bases: CodeSnippet

elements(part)[source]
property mesh
property meshes
nodes(part)[source]
property parts
property structure
supported_extensions = ['inp']

List of additionally supported file extensions. Override in subclasses.

property xml
class solidipes.loaders.Binary(**kwargs)[source]

Bases: File

File of unsupported type

property text
class solidipes.loaders.CachedMetadata(**kwargs)[source]

Bases: DataContainer

classmethod _cancel_scheduled_commit()[source]

Cancel scheduled commit

classmethod _commit()[source]

Update cached metadata database

_get_default_cached_attributes() → set[source]

Build the list of cached fields from the class description

classmethod _get_zodb_file_storage(path: str) → FileStorage[source]
_global_cached_metadata = None
classmethod _init_cached_metadata(initial_path='.')[source]
classmethod _populate_cached_metadata_from_yaml(initial_path='.')[source]

Populate cached metadata from YAML file

classmethod _schedule_commit()[source]

Schedule later update of metadata database

_scheduled_commit = None
_scheduler = <sched.scheduler object>
_storage = None
_transaction_manager = <transaction._manager.TransactionManager object>
classmethod _write_cached_metadata_to_yaml(initial_path='.')[source]

Write cached metadata to YAML file

class cached_loadable(func)

Bases: loadable

Decorator class to indicate that a loadable must be cached

foo(obj, *args, **kwargs)
foo_setter(obj, value, *args, **kwargs)
class cached_property(fget=None, fset=None, fdel=None, doc=None)

Bases: property

Decorator class to indicate that a property must be cached

clear_cached_metadata(fields=[])[source]
classmethod close_cached_metadata()[source]
get_cached_metadata()[source]
static get_global_cached_metadata() → OOBTree[source]
property global_cached_metadata: OOBTree
is_cache_invalid()[source]
load_cached_metadata()[source]

Load cached metadata and put in _data_collection (as attributes)

property modified_time[source]
save_field_to_cache(key)[source]
set_cached_metadata_entry(key, value)[source]
update_cached_metadata()[source]

Update cached metadata with instance’s fields listed in cached_attributes

classmethod update_global_cached_metadata(unique_identifier=None)[source]

Update cached metadata dictionary

class solidipes.loaders.CodeSnippet(**kwargs)[source]

Bases: Text

_valid_loading()[source]
property lint
property lint_errors
property lint_raw
supported_extensions = ['py', 'cc', 'hh', 'm', 'sh', 'tex', 'latex']

List of additionally supported file extensions. Override in subclasses.

supported_mime_types = ['text/x-shellscript/', 'text/x-tex', 'text/x-script.python', 'text/x-sh']

List of supported mime types. Override in subclasses.

property text
class solidipes.loaders.DataContainer(initial_data={}, name=None, unique_identifier=None, **kwargs)[source]

Bases: object

Container class for other structured data containers

_data_collection

Dictionary of other DataContainer or arbitrary objects. Set entry to “None” to mark as loadable.

_has_native_attr(key)[source]

Check if attribute is present, outside of _data_collection, without using __getattr__

_valid_loading()[source]
add(key, data=None)[source]

Add an arbitrary object to the data collection

copy()[source]

Returns a shallow copy without the need to read from disk again

property data

Load all data if necessary and return it

Accessing this property for the first time will load the data. If self.__loaded_data has only one entry, returns it directly.

Override the _load_data method in subclasses to define how data is loaded or built using other data containers.

property data_info

Returns a multi-line string with information about data keys

default_viewer

Default viewer for this file. Optionally override this in subclasses.

errors

stores the error messages during loading

get(key)[source]

Get a data object by key, loading it if necessary

has(key)[source]

Check if data is available in this container

load_all(*args, **kwargs)[source]
class loadable(func)

Bases: property

foo(obj, *args, **kwargs)
foo_setter(obj, value, *args, **kwargs)
remove(key)[source]

Remove a data object from the data collection

view(**kwargs)[source]

View the file using the default viewer

class solidipes.loaders.File(path=None)[source]

Bases: CachedMetadata, DataContainer

Abstract container class for file metadata

A File can be read from disk and may contain multiple DataContainer entries.

_valid_extension()[source]
_valid_loading()[source]
add_message(author, msg)[source]
archive_discussions(flag=True)[source]
property archived_discussions
classmethod check_file_support(path)[source]

Check mime type, then extension of file

property discussions
property file_info
property file_stats
property modified_time
property preferred_loader_name
supported_extensions = []

List of additionally supported file extensions. Override in subclasses.

supported_mime_types = []

List of supported mime types. Override in subclasses.

property valid_loading
class solidipes.loaders.FileSequence(pattern, paths)[source]

Bases: Sequence, CachedMetadata, Group

Sequence of files

_abc_impl = <_abc._abc_data object>
static _find_groups(is_dir_path_dict: dict[str, bool]) → dict[str, list[str]][source]

Find groups of file and directory names.

From a list of file and directory names (on a single level), return a dictionary with - key: pattern, - value: list of file and directory names that belong to the group.

_load_element(n)[source]

Must raise KeyError if element does not exist

Override this method in subclasses.

_set_total_size()[source]
property modified_time
property paths
select_file(n)[source]
class solidipes.loaders.GnuPlot(**kwargs)[source]

Bases: CodeSnippet

property image
supported_extensions = ['gp', 'gpu', 'gih']

List of additionally supported file extensions. Override in subclasses.

supported_mime_types = ['application/gnuplot']

List of supported mime types. Override in subclasses.

class solidipes.loaders.Group(pattern: str, paths: list[str], **kwargs)[source]

Bases: ABC

Group of files and directories.

_abc_impl = <_abc._abc_data object>
abstract static _find_groups(is_dir_path_dict: dict[str, bool]) → dict[str, list[str]][source]

Find groups of file and directory names.

From a list of file and directory names (on a single level), return a dictionary with - key: pattern, - value: list of file and directory names that belong to the group.

class solidipes.loaders.HDF5(**kwargs)[source]

Bases: File

HDF5 loader

property datasets
supported_mime_types = ['application/x-hdf5']

List of supported mime types. Override in subclasses.

class solidipes.loaders.Image(**kwargs)[source]

Bases: File

Image loaded with PIL

property exif_data
get_exif_data()[source]
property image
supported_mime_types = ['image/']

List of supported mime types. Override in subclasses.

class solidipes.loaders.Markdown(**kwargs)[source]

Bases: Text

Markdown file

supported_extensions = ['md']

List of additionally supported file extensions. Override in subclasses.

supported_mime_types = ['text/markdown']

List of supported mime types. Override in subclasses.

class solidipes.loaders.MatlabData(**kwargs)[source]

Bases: File

Matlab .mat file

property arrays
supported_extensions = ['mat']

List of additionally supported file extensions. Override in subclasses.

supported_mime_types = ['application/x-matlab-data']

List of supported mime types. Override in subclasses.

class solidipes.loaders.Meshio(**kwargs)[source]

Bases: File

File loaded with meshio

property mesh
class solidipes.loaders.Notebook(**kwargs)[source]

Bases: File

Notebook file, in Jupyter style

property notebook
supported_extensions = ['ipynb']

List of additionally supported file extensions. Override in subclasses.

class solidipes.loaders.PDF(**kwargs)[source]

Bases: File

Image loaded as base64

property pdf
supported_mime_types = ['application/pdf']

List of supported mime types. Override in subclasses.

class solidipes.loaders.PyvistaMesh(**kwargs)[source]

Bases: File

Mesh file loaded with pyvista

add_cell_data(array, name)[source]
add_point_data(array, name)[source]
property cell_data_names
copy_pyvista_data_to_collection()[source]

Add pyvista data to data collection

property data_info

Trigger loading of Pyvista mesh and return info

default_viewer

Fully loaded pyvista mesh

get_cell_data(name)[source]
get_point_data(name)[source]
get_warped(data_id, factor=1.0)[source]

Returns another PyvistaMesh with the mesh points displaced by the given data.

Parameters:

  • data (string) – Name of point data. If data is 1D, the mesh is warped along its normals. Otherwise, the data must have the same number dimensionality as the mesh.

  • factor (float) – Factor to multiply the displacements by. Defaults to 1.0.

property mesh
property point_data_names
property pyvista_mesh
remove_cell_data(name)[source]
remove_point_data(name)[source]
set_cell_values(data_id)[source]

Sets the cell values for plotting to the given data.

Parameters:

data (string) – Name of cell data.

set_point_values(data_id)[source]

Sets the point values for plotting to the given data.

Parameters:

data (string) – Name of point data.

supported_extensions = ['msh', 'stl', 'vtu', 'pvtu', 'vtk', 'avs']

List of additionally supported file extensions. Override in subclasses.

Bases: File

Symbolic link (special file)

property linked_file
class solidipes.loaders.TIKZ(**kwargs)[source]

Bases: CodeSnippet

property pdf
supported_extensions = ['tikz']

List of additionally supported file extensions. Override in subclasses.

supported_mime_types = ['application/latex/tikz']

List of supported mime types. Override in subclasses.

class solidipes.loaders.Table(**kwargs)[source]

Bases: File

Table file loaded with Pandas

property header
read_csv(fname, **kwargs)[source]
read_numpy(fname, **kwargs)[source]
supported_extensions = ['csv', 'xlsx', 'npy']

List of additionally supported file extensions. Override in subclasses.

supported_mime_types = ['text/csv', 'application/vnd.ms-excel', 'application/numpy/array']

List of supported mime types. Override in subclasses.

property table
validate_header(header)[source]
class solidipes.loaders.Text(**kwargs)[source]

Bases: File

Text file, potentially formatted with markdown

supported_extensions = ['txt', 'in', 'data']

List of additionally supported file extensions. Override in subclasses.

supported_mime_types = ['text/plain', 'application/lammps']

List of supported mime types. Override in subclasses.

property text
class solidipes.loaders.Video(**kwargs)[source]

Bases: File

Video file

supported_mime_types = ['video/']

List of supported mime types. Override in subclasses.

property video
class solidipes.loaders.XDMF(**kwargs)[source]

Bases: Sequence, XML

property _element_count
_load_element(n)[source]

Load a single frame

_load_hdf5_data_item(item)[source]
_load_xdmf_data_item(item)[source]
property domain
find_dataitem_from_ref(ref)[source]
property grid
property grids
property mesh
property mesh_name
property n_frames
select_frame(frame)[source]
supported_extensions = ['xdmf']

List of additionally supported file extensions. Override in subclasses.

property version
property xdmf
class solidipes.loaders.XML(**kwargs)[source]

Bases: Text

supported_mime_types = ['text/xml', 'application/xml', 'application/paraview/state']

List of supported mime types. Override in subclasses.

property xml
solidipes.loaders.load_file(path)[source]

Load a file from path into the appropriate object type

solidipes.loaders.load_groups(is_dir_path_dict: dict[str, bool], root_path: str) → tuple[dict[str, Group], dict[str, bool]][source]

Load groups of files and directories.

Return a dictionary of {pattern: loaded groups} and a dictionary with the remaining file and directory names.