MDMC.readers package
Subpackages
- MDMC.readers.configurations package
- Submodules
- MDMC.readers.configurations.ase module
- MDMC.readers.configurations.cif module
- MDMC.readers.configurations.conf_reader module
- MDMC.readers.configurations.conf_reader_factory module
- MDMC.readers.configurations.packmol_pdb module
- MDMC.readers.configurations.pdb module
- Module contents
- MDMC.readers.observables package
- Submodules
- MDMC.readers.observables.LAMPPDF module
- MDMC.readers.observables.LAMPSQw module
- MDMC.readers.observables.MDANSESQw module
- MDMC.readers.observables.MantidSQw module
- MDMC.readers.observables.netCDFPDF module
- MDMC.readers.observables.netCDFSQw module
- MDMC.readers.observables.obs_reader module
- MDMC.readers.observables.obs_reader_factory module
- MDMC.readers.observables.xml_SQw module
- Module contents
Submodules
MDMC.readers.reader module
Module for reader abstract class
- class MDMC.readers.reader.Reader(file_name: str)[source]
Bases:
ABC
Abstract class that defines methods common to all readers
- Parameters:
file_name (str) – name of file to read
- abstract parse(**settings: dict) None [source]
Parses the file data so that it is in a format expected by the class calling the data reader
For readers which are not specific to one data type, the calling class must be determined so that the file data can be parsed into the appropriate data type.
- Parameters:
**settings (dict) – dictionary of settings for reader
MDMC.readers.reader_factory module
Factory class for generating readers
- class MDMC.readers.reader_factory.ReaderFactory[source]
Bases:
ABC
Provides a abstract base class for methods and properties common to all reader factories
- abstract static base_class()[source]
This should be implemented to return the base class of objects returned by the
ReaderFactory
Module contents
Readers for both atomic configurations and experimental observables
Contents
configurations observables reader_factory reader