Hopsan
|
You can write component help documentation in markdown with additional support for LaTeX equations. The markdown files will be converted to, and viewed as HTML.
The LaTeX equation support is not an official part of markdown, but in Hopsan you can add HTML comments starting with EQUATION to the markdown files.
Equations are numbered automatically and can be give a LABEL that can be referenced from the text using EQREF{label} (will be replaced in the generated HTML).
For help on how to write markdown, search the internet for a cheat sheet or similar. For inclusion of images and equations see the following example.
MyExampleOrifice.md:
### Description ![Laminar orifice picture](orifice_user.svg) Hydraulic orifice modeling laminar flow. #### Input Variables * **Kc** - Pressure-Flow Coefficient [m^5/Ns] #### Port Initial Conditions No initial conditions can be set for Q-type blocks. <!--- ### Tips---> ### Theory The laminar flow through the orifice is proportional to the pressure difference according to equation EQREF{eq:flow} <!---EQUATION LABEL=eq:flow q_{2} = K_{c} \left(p_{1}-p_{2}\right) ---> #### Hopsan TLM adaption In Q components the positive flow direction is outwards from each port, in this case the TLM equations are <!---EQUATION p_{1} = c_{1} + q_{1} Z_{c1} ---> <!---EQUATION p_{2} = c_{2} + q_{2} Z_{c2} ---> <!---EQUATION q_{1} = -q_{2} ---> The flow equation can now be rewritten in the following steps <!---EQUATION q_{2} = K_{c} \left( c_{1} - q_{2} Z_{c1} - c_{2} + q_{2} Z_{c2} \right) ---> <!---EQUATION q_{2} = K_{c} \left( c_{1} - c_{2} \right) - K_{c} q_{2} \left( Z_{c1} + Z_{c2} \right) ---> <!---EQUATION q_{2} \left( 1 + K_{c} q_{2} \left( Z_{c1} + Z_{c2} \right) \right) = K_{c} \left( c_{1} - c_{2} \right) ---> Which finally becomes the implemented equation EQREF{eq:final} <!---EQUATION LABEL=eq:final q2 = \frac{K_{c}\left(c_{1}-c_{2}\right)}{1.0+K_{c}\left(Zc_{1}+Zc_{2}\right)} ---> #### References