User API Documentation

matcal.core.adaptive_surrogates

This module contains adaptive surrogates.

matcal.core.calibration_studies

matcal.core.data

The data module contains classes and functions for converting data into the structure that MatCal requires for studies.

matcal.core.data_analysis

matcal.core.data_importer

The classes and functions in this module are intended to import data into MatCal from external sources for use in MatCal studies.

matcal.core.file_modifications

matcal.core.input_file_writer

matcal.core.models

The models module includes base classes and helper classes for MatCal models.

matcal.core.objective

The objective module contains the classes related to objectives.

matcal.core.objective_results

This module only contains the ObjectiveResults class which is a large data structure for holding all data related to objective calculation.

matcal.core.plotting

This module contains base classes used for plotting.

matcal.core.parameters

This module contains all classes related to study parameters.

matcal.core.parameter_studies

This module contains pure MatCal implementations of parameter studies.

matcal.core.qoi_extractor

This module contains all classes related to data QoI extractors.

matcal.core.residuals

The residual module contains all classes and functions for residual calculation.

matcal.core.serializer_wrapper

matcal.core.simulators.SimulatorResults(...)

Results data structure returned from a simulator.

matcal.core.state

This module contains all data related to MatCal state parameters and all classes are meant for users.

matcal.core.study_base

The study base module contains the base class for all MatCal studies.

matcal.core.surrogates

matcal.dakota.global_calibration_studies

This module contains MatCal's interface to Dakota's global calibration methods.

matcal.dakota.local_calibration_studies

This module contains MatCal's interface to Dakota's local calibration methods.

matcal.dakota.sensitivity_studies

This module contains MatCal's interface to Dakota's sensitivity study methods.

matcal.dakota.uncertainty_quantification_studies

This module contains MatCal's interface to Dakota's uncertainty quantification methods.

matcal.full_field.data

The data module contains classes and functions for converting data into the structure that MatCal requires for studies.

matcal.full_field.data_importer

The classes and functions in this module are intended to import data into MatCal from external sources for use in MatCal studies.

matcal.full_field.field_mappers

matcal.full_field.objective

The objective module contains the classes related to objectives.

matcal.sierra.input_file_writer

matcal.sierra.material

This module contains the Material object meant to define a SIERRA material file for use with a MatCal generated SIERRA model.

matcal.sierra.models

Public API for SIERRA models.