YAML for MATLAB

Note

This website is an independent documentation project written by Fernando N. Santos-Navarro. It documents the yaml package, which is a separate software project developed and maintained by Martin Koch. For source code, releases, or issue tracking, please visit the package repository.

YAML for MATLAB is a user-focused documentation for the yaml package for MATLAB.

Its purpose it to help MATLAB users understand, adopt, and use YAML effectively in their tools and workflows by leveraging the yaml package. To this end, the documentation follows the Diatáxis framework and includes tutorials, how-to guides, API reference and explanations designed to facilitate the adoption and effective use of YAML in MATLAB.

This documentation is written for and pinned to version 1.6.0 of the yaml package.

About the package

The yaml package, developed by Martin Koch, allows you to read and write YAML files directly from MATLAB. It supports YAML 1.1 and is compatible with MATLAB R2019b and newer.

Consider using this package if you want to:

  • use YAML as a configuration format for MATLAB applications

  • exchange structured data with other languages and tools

  • store human-readable data files alongside your MATLAB projects.

The package is built on top of the SnakeYAML v1.30 Java library, wrapped in a MATLAB-friendly interface that requires no Java knowledge from the user.

Installation

  1. Download the package from one of the following sources:

  2. Place the +yaml folder in a directory of your choice.

  3. Add that directory to your MATLAB path.

Scope of this documentation

To avoid confusion about responsibilities, this project has the following scope:

  • YAML for MATLAB. Focuses exclusively on improving accessibility, learning, and long-term usability through comprehensive documentation, examples, and tutorials.

  • YAML package. Contains the source code, implementation logic, and release management.

Support Channels:

  • Documentation Issues. Typos, unclear explanations, or missing examples in this documentation should be reported to the documentation repository.

  • Code Issues. Bugs, feature requests, or contributions related to the yaml package itself should be submitted to the package repository.

Credits and License