Document custom YAML math syntax
brynpickering opened this issue · comments
Problem description
As of #414 we have custom YAML math formulation. We now need to document how a user can build their own math formulation (constraints/variables/objectives/global expressions).
We should do this primarily by parsing the YAML schema for writing custom math formulations (#421), which will give the required/optional keys and the data types of the corresponding values. On top of that we will need some intro text which gives an example of writing a custom constraint AND an FAQ of likely pitfalls and how to debug failing formulations.
This is separate to the documentation of the in-built math formulation, which will give a description of all in-built math (including optional custom math) and a pretty printed version of the equations, where relevant.
Calliope version
v0.7.0-dev
Fixed in #456