Save Run-Time Data from Simulation

Save simulation data to MATLAB^® workspace; log signals; export signal, time, output, and state data

You can save signal values to the MATLAB workspace or to an MLDATX file, MAT-file, or Excel^® during simulation for later retrieval and postprocessing. Saving simulation data is also known as logging or exporting simulation data.

Saving simulation data in Dataset format simplifies postprocessing by providing a common format for the results of a variety of logging techniques. Using Dataset format stores the data as MATLAB timeseries objects, which you can process with MATLAB.

Signal logging and data stores use Dataset format.
Output and state logging use Dataset as the default format.
The default save format for the To File and To Workspace blocks is Timeseries.

Simulink^® provides tools to convert logged data to Dataset format.

To determine which approach to use for logging signal data, see Export Simulation Data.

Blocks

Outport	Create output port for subsystem or external output
Record	Log data to the workspace, to a file, or both
To File	Write data to file
To Workspace	Write data to workspace

Tools

Instrumentation Properties	View and edit signal logging and visualization properties
Signal Properties	View and edit signal properties
Simulation Data Inspector	Inspect and compare data and simulation results to validate and iterate model designs

Functions

expand all

Configure Signal Logging

`Simulink.sdi.markSignalForStreaming`	Turn logging on or off for a signal
`Simulink.sdi.getSignalInputProcessingMode`	Get setting of Input Processing signal property
`Simulink.sdi.setSignalInputProcessingMode`	Specify value for Input Processing signal property
`Simulink.SimulationData.signalLoggingSelector`	Open Signal Logging Selector

Limit Logged Data Size

Configure Logged Data Size Limits

`Simulink.sdi.setMaxDiskUsage`	Specify maximum size for data logged to disk
`Simulink.sdi.getMaxDiskUsage`	Get configured maximum size for data logged to disk
`Simulink.sdi.setRequiredFreeSpace`	Specify minimum disk space to leave free when logging data
`Simulink.sdi.getRequiredFreeSpace`	Get configured minimum disk space requirement for logging
`Simulink.sdi.setDeleteRunsOnLowSpace`	Specify behavior when logged data size approaches configured limits
`Simulink.sdi.getDeleteRunsOnLowSpace`	Get configured behavior when size of logged data approaches configured limits
`Simulink.sdi.setRecordData`	Specify record mode for logging
`Simulink.sdi.getRecordData`	Check record mode for logging

Configure Simulation Data Inspector Archive

`Simulink.sdi.setArchiveRunLimit`	Specify a limit for the number of runs stored in the Simulation Data Inspector archive
`Simulink.sdi.setAutoArchiveMode`	Specify whether the Simulation Data Inspector automatically archives simulation runs
`Simulink.sdi.getArchiveRunLimit`	Determine configured run limit for Simulation Data Inspector archive
`Simulink.sdi.getAutoArchiveMode`	Determine if the Simulation Data Inspector is configured to automatically archive

Configure Logging Location

`Simulink.sdi.setStorageLocation`	Specify location for logged data on disk
`Simulink.sdi.getStorageLocation`	Get path to custom storage location for data logged to disk
`Simulink.sdi.setStorageMode`	Specify whether to log data to disk or memory
`Simulink.sdi.getStorageMode`	Check if logging is configured to log data to disk or memory

Process Logged Data

`Simulink.SimulationData.createStructOfTimeseries`	Create structure of `timeseries` data to load as simulation input for bus
`Simulink.SimulationData.forEachTimeseries`	Call function on each `timeseries` object
`Simulink.SimulationData.DatasetRef.getDatasetVariableNames`	List names of `Dataset` variables in MAT-file
`getAsDatastore`	Get matlab.io.datastore.SimulationDatastore representation of element from referenced Dataset object
`Simulink.ModelDataLogs.convertToDataset`	Convert logging data from `Simulink.ModelDataLogs` format to `Simulink.SimulationData.Dataset` format
`Simulink.SimulationData.updateDatasetFormatLogging`	Convert model and its referenced models to use `Dataset` format for signal logging

Classes

expand all

Access Logged Simulation Data

`Simulink.SimulationOutput`	Access simulation results
`Simulink.SimulationData.Dataset`	Access logged simulation data or group simulation input data
`Simulink.SimulationData.Signal`	Container for signal logging information
`Simulink.SimulationData.DatasetRef`	Create `Simulink.SimulationData.DatasetRef` object
`matlab.io.datastore.SimulationDatastore`	Datastore for inputs and outputs of Simulink models
`Simulink.SimulationData.BlockPath`	Fully specified Simulink block path
`Simulink.SimulationData.State`	State logging element
`Simulink.SimulationData.Unit`	Store units for simulation data
`Simulink.SimulationData.LoggingInfo`	Signal logging override settings
`Simulink.SimulationData.ModelLoggingInfo`	Signal logging override settings for a model
`Simulink.SimulationData.SignalLoggingInfo`	Signal logging override settings for signal
`Simulink.SimulationMetadata`	Access metadata of simulation runs

Simulink Configuration Parameters

Model Configuration Parameters: Data Import/Export

Topics

Simulation Data

Export Simulation Data

Export (log) simulation data as a baseline for analyzing and debugging a model.

Data Format for Logged Simulation Data

You can use many formats for logged data, including Dataset, MATLAB timeseries, arrays, and structures. Supported data formats vary between different logging techniques. However, Dataset format is available for all logging techniques.

Dataset Conversion for Logged Data

To convert a workspace variable that contains data that was logged in a format other than Dataset format to use Dataset format, use a Simulink.SimulationData.Dataset constructor.

Work with Big Data for Simulations

Log, load, and analyze big data for simulations.

Limit the Size of Logged Data

Choose among several strategies to limit the size of logged data.

Specify Signal Values to Log

Specify which signal values to log during simulation.

Log Data to Persistent Storage

Store logged simulation data to persistent storage in a MAT-file.

Load Big Data for Simulations

Load big data as simulation input.

Analyze Big Data from a Simulation

Access simulation data logged to persistent storage for analysis in MATLAB.

Log Signal Data That Uses Units

Log signal data that uses units by using Dataset or Timeseries logging format for signal logging, the To File block, and the To Workspace block.

Samples to Export for Variable-Step Solvers

Control how much output the simulation generates when your model uses a variable-step solver. Use the Output options configuration parameter.

Log Data to the Workspace and a File Using the Record Block

Use the Record block to log data to the workspace, to a file, or to both the workspace and a file.

Simulation State

State Information

How blocks use the state information for calculating the output signal value for the current simulation step.

Save State Information

Save state information for logged states for each simulation step during a simulation.

Signal Logging

Export Signal Data Using Signal Logging

To capture signal data from a simulation, you can use signal logging. Mark the signals that you want to log and enable signal logging for the model.

Configure a Signal for Logging

Mark the signals that you want to log simulation data for.

View the Signal Logging Configuration

View the signals that are marked for signal logging.

Enable Signal Logging for a Model

To log signals marked for signal logging, set the Signal logging configuration parameter.

Override Signal Logging Settings

For a specific simulation run, override the signal logging settings for individual signals marked for logging.

View and Access Signal Logging Data

View and access the signal logging data for a completed or paused simulation.

Convert Logged Data to Dataset Format

To convert a workspace variable that contains data that was logged in a format other than Dataset format to use Dataset format, use a Simulink.SimulationData.Dataset constructor.

Log Signals in For Each Subsystems

Use signal logging in For Each subsystems.