Skip to content

Complete the experimental Matlab toolbox.  #177

@ssun30

Description

@ssun30

Abstract

Implement the currently missing features in the experimental Matlab interface.

Motivation

Describe the need for the work being done:

  • For Ubuntu users, a prefix must be added to the command line to correctly load GLIBC into Matlab.
  • There is no tutorial. Users could only learn about the toolbox by reading the code of the new samples. The readme.md for the toolbox is not intuitive for users to follow.
  • Building documentation with Sphinx is currently not enabled for the new interface.
  • Currently the only way to test the toolbox is running the test_examples.m script which does not cover all methods in all classes.
  • Without automated installation there is no easy way to adding testing into the CI workflow.
  • Building from source is currently the only way to have access to the new interface. A pkg installer for Mac OS users and msi installer for Windows users is needed for the official release.

Description

  • For building documentations, it's sufficient (for now) to pin Sphinx version to 5.1.1 in our CI. This could be addressed in a quick PR.

References

Links to a development branch in your fork of the Cantera repository, Pull Requests, GitHub Issues, Users' Group topics, or other relevant material.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Matlabwork-in-progressAn enhancement that someone is currently working on

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions