pyrokinetics.file_utils

Pyrokinetics handles many different file types generated from many different software packages. This module contains utilities for simplifying the process of reading and processing files. These utilities also make it possible to extend Pyrokinetics for new file types without modifying the existing code.

For more information, see File Readers.

Classes

AbstractFileReader()	An abstract base class for classes that can read data from disk and create a Pyrokinetics object.
FileReader()	Builds upon AbstractFileReader, but adds the required class keyword arguments file_type and reads.
FileReaderFactory(file_type[, super_class])	Factory variant in which file type can be inferred from a path as well as a key.
ReadableFromFile()	Base class that adds the following functions to a class:

Exceptions

FileInferenceException(excs)

Collection of Exceptions to be raised at once.