Python-VPP
Python-VPP copied to clipboard
[RFC] Refactor VPP into self contained Python package
Implementing the vpp as a standalone python package within the repo comes with a few benefits:
- Make's it clearer how additional functionality such as demos/tests/docs relate to it
- Reduces maintenance version
Have been using this pattern at work and it's been quite handy - what do we think?
I am all for it if you want to spend time on this! I think your online app is also a much better way of running the VPP than in python itself.
Aha! Yes I don't think it's fair to volunteer anyone else for this one!
Some more paper programming to make sure if this is really a change worth doing.
There are two use cases that refactoring as a package makes easier to support:
- Users seeking to evaluate parameter changes through app (done)
- Users wanting to integrate VPP functionality in downstream applications, I.e. design optimisation given wind/wave conditions
Architecture would be:
VPP package -> App -> API consumers (technical optimisation etc)
Contributors can then focus on adding technical features to VPP that can be more easily released and consumed by downstream projects.
Implementation of this is a refactor job and test package release.