matlabreport

Python package to automate the creation and publication of MATLAB reports.

Usage

matlabreport [OPTIONS] OUTLINE REPORT_M

where OUTLINE is a JSON outline file, and REPORT_M is the name of the m-file to be created.

Use matlabreport --help to see additional options.

Optional Configuration

The openreport.py module checks for the following environment variables:

If a variable is not defined, webbrowser is used to open the report for viewing. It is also used to view HTML reports.

Installation

This package can be installed with pip install matlabreport, or by cloning this repository and running python setup.py install.

Requirements

This package requires Click and pyaml, both of which will be installed during pip installation.

The MATLAB Python Engine is also required. To install, follow the instructions from MathWorks.