Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Input Generation: convert MATLAB scripts #342

Open
willGraham01 opened this issue Jun 6, 2023 · 0 comments
Open

Input Generation: convert MATLAB scripts #342

willGraham01 opened this issue Jun 6, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@willGraham01
Copy link
Collaborator

willGraham01 commented Jun 6, 2023

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?)
@willGraham01 willGraham01 added the enhancement New feature or request label Jun 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant