Save Run-Time Data from Simulation

Save simulation data such as output, signal, time, state, and data store logging data

You can save simulation data to the MATLAB^® workspace or to a file, including an MLDATX file, MAT file, or Excel^® file, during simulation for later retrieval and postprocessing. Simulation data can include any combination of output, signal, time, state, and data store logging 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 or timetable objects, which you can process with MATLAB.

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

Blocks

Outport	Create output port for subsystem or external output
Record	View and log data to the workspace, a file, or both (Since R2021a)
To File	Write data to file
To Workspace	Log data to workspace from Simulink model

Tools

Instrumentation Properties	View and edit logging and visualization properties for logged signal
Signal Properties	View and edit signal properties
Simulation Data Inspector	Inspect and compare data and simulation results to validate and iterate model designs
Simulink Signal Logging Selector	View signal logging configuration and override signal logging settings

Functions

expand all

Configure Signal Logging

`Simulink.sdi.markSignalForStreaming`	Turn logging on or off for signal
`Simulink.sdi.getSignalInputProcessingMode`	Get value of Input Processing signal property
`Simulink.sdi.setSignalInputProcessingMode`	Specify value for Input Processing signal property

Override Signal Logging Settings

`Simulink.SimulationData.ModelLoggingInfo.createFromModel`	Create `Simulink.SimulationData.ModelLoggingInfo` object for top model with override settings for each logged signal in model
`findSignal`	Find index of signals in `Signals` property vector
`setLogAsSpecifiedInModel`	Set logging mode for top model or top-level Model block
`getLogAsSpecifiedInModel`	Determine whether model logs as specified in model or uses override settings
`verifySignalAndModelPaths`	Verify paths in `Simulink.SimulationData.ModelLoggingInfo` object

Limit Logged Data Size

Configure Logged Data Size Limits

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

Configure Simulation Data Inspector Archive

`Simulink.sdi.setArchiveRunLimit`	Specify number of runs to retain in Simulation Data Inspector archive
`Simulink.sdi.setAutoArchiveMode`	Specify how Simulation Data Inspector manages simulation runs
`Simulink.sdi.getArchiveRunLimit`	Get limit for number of runs to retain in Simulation Data Inspector archive
`Simulink.sdi.getAutoArchiveMode`	Get Simulation Data Inspector run management mode

Configure Logging Location

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

Process Logged Data

`extractTimetable`	Extract data from `Simulink.SimulationData.Dataset` or `Simulink.SimulationData.Signal` objects into timetables (Since R2021b)
`getAsDatastore`	Get `matlab.io.datastore.SimulationDatastore` representation of element from referenced `Dataset` object
`removeElement`	Remove element from `Simulink.SimulationData.Dataset` object
`Simulink.SimulationData.createStructOfTimeseries`	Create structure of `timeseries` data to load as simulation input for bus
`Simulink.SimulationData.forEachTimeseries`	Apply function to data contained in set of `timeseries` objects
`Simulink.SimulationData.DatasetRef.getDatasetVariableNames`	List names of variables in MAT file that contain `Simulink.SimulationData.Dataset` objects

Objects

expand all

Access Logged Simulation Data

`Simulink.SimulationOutput`	Access simulation outputs and metadata
`Simulink.SimulationMetadata`	Information about model, environment, execution, and timing of simulation
`Simulink.SimulationData.Dataset`	Access logged simulation data or group simulation input data
`Simulink.SimulationData.Signal`	Container for signal logging information
`Simulink.SimulationData.State`	Container for state 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 block path
`Simulink.SimulationData.Unit`	Container for units for simulation data
`Simulink.SimulationData.LoggingInfo`	Signal logging override settings
`Simulink.SimulationData.ModelLoggingInfo`	Signal logging override settings for model
`Simulink.SimulationData.SignalLoggingInfo`	Signal logging override settings for signal

Model Settings

expand all

Specify Data to Log

Time	Option to log time values for simulation
Output	Option to log data for top-level output ports
States	Option to log block state values during simulation
Signal logging	Option to log data for signals marked for logging in model
Data stores	Option to log data for Data Store Memory blocks
Final states	Option to log final state values
Save final operating point	Option to save complete model operating point when simulation is paused or stopped

Specify Logged Data Format

Single simulation output	Option to return simulation results as single `Simulink.SimulationOutput` object
Save format	Format for logged states, output, and final states data
Log Dataset data to file	Option to log data that uses `Dataset` format to MAT or MLDATX file
Record logged workspace data in Simulation Data Inspector	Option to send data logged in format other than `Dataset` to Data Inspector at end of simulation

Specify Values to Log

Decimation	Option to apply decimation factor for logged output, state, and time data
Limit data points to last	Option to log only last n data points for outputs, states, and time
Logging intervals	Option to specify time intervals in which to log simulation data
Output options	Options to produce output values at specified times in variable-step simulation
Output times	Option to specify times for which variable-step simulation produces output values
Refine factor	Option to produce additional output values between simulation time steps

Topics

Simulation Data

Save Simulation Data
Save simulation data for analyzing and debugging a model.
View and Access Logged Simulation Data
View and access saved simulation data for a completed or paused simulation.
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.
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.
Convert 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.
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.

Signal Logging

Save Signal Data Using Signal Logging
Capture signal data from a simulation by marking signals you want to log in the model.
Override Signal Logging Settings
For a specific simulation run, override the signal logging settings for individual signals marked for logging.
View the Signal Logging Configuration
View the signals that are marked for signal logging.
Visualize and Access Signal Logging Data
View and access the signal logging data for a completed or paused simulation.
Access Logged Signals with Spaces and Newlines in Logged Names
Access logged signals with names that contain spaces or newlines.

Big Data

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.
Export Data to Parquet File Using Record Block
Use the Record block to export data to a Parquet file.
Analyze Big Data from a Simulation
Access simulation data logged to persistent storage for analysis in MATLAB.

Simulation State

Save Block States and Simulation Operating Points
Learn how you can use state information logged from simulation and decide how to log states and operating points.
Save State Information
Save state information for logged states.

Data Stores

Log Data Stores
Configure a data store for logging so that you can view the data stored in a simulation run.

Related Information

Featured Examples

Logging Intervals

Specify logging intervals for a model to limit the amount of exported data.

Open Live Script