search

modsim / CADET

A modular, fast, and accurate simulation framework for (column) liquid chromatography
GNU General Public License v3.0
50 stars 24 forks source link

Make interface specification machine-readible #164

Open schmoelder opened 5 months ago

schmoelder commented 5 months ago

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 commented 3 months ago

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