CADET-Core icon indicating copy to clipboard operation
CADET-Core copied to clipboard

Make interface specification machine-readible

Open schmoelder opened this issue 2 years ago • 1 comments

Currently, our interface specifications are written in restructured text and published on our website. However, it would be nice if we added the specifications in some machine-readible format (e.g. json). Having a single source of truth would simplify the definition of new classes (i.e. isotherm models, transport models etc) outside of CADET-Core, e.g. when wrapping them in CADET-Process.

When this is done, we should delete Code in the CADET-Core that ensures backwards compatibility for the interface, which, for instance, was added in PR #177 , issue #176

schmoelder avatar Feb 07 '24 08:02 schmoelder

As discussed, the specs should live in another, separate repo. Progress will be tracked here: https://github.com/cadet/CADET-Specification/issues/1

schmoelder avatar Mar 15 '24 12:03 schmoelder