Skip to content

Input Generation: convert MATLAB scripts #342

@willGraham01

Description

@willGraham01

Produce inputs via Python and h5py

There is an existing drive to remove the MATLAB header dependency from the tdms executable source code. In similar vein, and to completely detach the TDMS workflow from MATLAB, we should look to translate the input-file generation scripts from MATLAB files into another language (such as Python).

Broadly speaking:

  • The files in tdms/tests/system/data/input_generation/matlab all need to be converted, but their functionality preserved.
  • This presents an opportunity for these loose files, and the input generation method as a whole, to be organised into a package or module.
  • Fixes the issue with being unable to run the full input regeneration workflow on GitHub runners setup-matlab doesn't allow us to run MATLAB directly or via python #239.
  • Reduce the bloat in the data/input_generation folder by having a separate module.
  • Open up development for a user-tool for creating TDMS inputs.

Existing development

The regen-to-python-playtest branch contains initial progress towards the objectives of:

  • Reorganising the files into a package structure
  • Introducing unit tests for them
  • Documenting inline

Additional Considerations

  • Is a new language necessary? (Could write a MATLAB toolbox, for example)
  • Is Python the optimal language?
  • Do we want a separate repo or docs page?
  • What features might we want to add onto this in the future? (Input creation GUI/guide?)

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions