/ModelicaSpecification

Specification of the Modelica Language

Primary LanguageTeX

ModelicaSpecification

This repository contains the Modelica Language Specification, hosted at https://github.com/modelica/ModelicaSpecification.

Build status

Build Status

Description

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, magnetic, hydraulic, thermal, control, electric power or process-oriented subcomponents.

Releases

Version Link Published
3.5-dev Master branch not yet
3.4 PDF 2017
3.3rev1 PDF 2014
3.2rev2 PDF 2013
3.2rev1 PDF 2012
3.3 PDF 2012
3.2 PDF 2010
3.1 PDF 2009
3.0 PDF 2007
2.2 PDF 2005
2.1 PDF 2004
2.0 PDF 2002
1.4 PDF 2000
1.3 PDF 1999
1.2 PDF 1999
1.1 PDF 1998
1.0 PDF 1997

More Info on released versions: https://www.modelica.org/documents

Contribution

  1. 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.
  2. 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.
  3. 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:
  1. First you need perl, we used http://strawberryperl.com/
  2. And then ideally the official LaTeXML package: http://dlmf.nist.gov/LaTeXML/get.html#SS4.SSS0.Px1 or https://github.com/brucemiller/LaTeXML
  3. Except that awaiting one correction we use https://github.com/HansOlsson/LaTeXML/tree/UseLabel
  4. The exact commands are in the Makefile