Simple Configuration File Format for MATLAB

Simple text-based file format for loading dictionary-like configuration data into MATLAB.

Simple Configuration File Format for MATLAB

Simple text-based file format for loading dictionary-like configuration data into MATLAB.

The File Format

The simple config files are assumed to be ordinary text (.txt) files. The syntax of the files is designed to be very similar to the YAML syntax.

• configuration data can be stored as key/value pairs, delimitted using a colon (:)
• keys must be text
• values can be text, numbers, booleans, lists of text, lists of numbers, and lists of booleans
  • lists are defined using square brackets ([ ])
  • list elements are delimited using commas (,)
  • booleans can be specified as false, False, true, or True
  • empty configs can be left blank (they are loaded in as empty arrays)
• comments are started with the pound symbol (#)

NOTE: This simple config format does not support nested dictionaries.

Example

# satellite name
name: example satellite

# satellite properties
mass [kg]: 50
drag coefficient:
area of each face [m^2]: [2, 2, 3, 1.5, 5, 5]
label for each face: [face A, face B, face C, face D, face E, face F]

# control system settings
actuators active: false
sensors active: true

Loading a Simple Configuration File

A simple config file can be loaded into MATLAB using the load_config function.

Syntax

config = load_config(file_path)

Description

Inputs

• file_path (char array or 1×1 string) relative or absolute file path (with or without file extension)

Outputs

• config (1×1 dictionary (strings --> cell)) dictionary storing config data

Examples

• See EXAMPLES.mlx or the "Examples" tab on the File Exchange page for examples.