This repository contains the Modelica Language Specification, hosted at https://github.com/modelica/ModelicaSpecification.
Modelica® https://modelica.org/ is a non-proprietary, object-oriented, equation based language to conveniently model complex physical systems containing, e.g., mechanical, electrical, electronic, hydraulic, thermal, control, electric power or process-oriented subcomponents.
How to contribute:
- If you find an error and are not certain that you can correct it, first check that it is not already reported and then open an issue describing it in detail - focusing on why it should be changed.
- If you are confident that you can correct the issue, fork this repository and create a pull-request and in the pull-request explain the issue and the correction; you will also have to sign a CLA.
- Significant extensions are handled as Modelica Change Proposals. (Template to follow.) This can start as a simple description of the proposed extension. It will then be worked on to have a rationale explaining how the change help users, and demonstrating that it can be implemented efficiently; and finally a pull-request with the changes.
CLA: Contributor's license agreement. (Details to follow.)
How to edit and generate final documents
- For online editing you can use www.overleaf.com (details to follow)
- The pdf-documents are generated with pdflatex, which is part of most LaTeX installations, we used http://miktex.org/download
- The HTML-documents are generated with LaTeXML. That is more complicated to install - and can optionally be skipped:
- First you need perl, we used http://strawberryperl.com/
- And then ideally the official LaTeXML package: http://dlmf.nist.gov/LaTeXML/get.html#SS4.SSS0.Px1 or https://github.com/brucemiller/LaTeXML
- Except that awaiting one correction we use https://github.com/HansOlsson/LaTeXML/tree/UseLabel
- The exact commands are in the Makefile