Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .CI/index.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Modelica Specification</title>
<title>Modelica Language Specification</title>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.5.0/css/bootstrap.min.css" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
<link rel="stylesheet" href="https://doc.modelica.org/Modelica%203.2.3/Resources/helpOM/style.css" />
Expand All @@ -16,13 +16,13 @@
<nav class="navbar navbar-light bg-light">
<div class="container justify-content-between flex-nowrap">
<span class="navbar-brand mb-0">
<a href="https://modelica.org/"><img src="https://raw.githubusercontent.com/modelica/MA-Logos/master/HighRes/Modelica_Language.svg" alt="Modelica Language logo" class="md-logo"></a>
<a href="https://modelica.org/"><img src="https://raw.githubusercontent.com/modelica/MA-Logos/master/HighRes/Modelica_Language.svg" alt="Modelica language logo" class="md-logo"></a>
</span>
<div id="head-selects"></div>
</div>
</nav>
<div class="container pt-4">
<h1 class="pt-2 h2">Modelica Specification</h1>
<h1 class="pt-2 h2">Modelica Language Specification</h1>
"""
tail = """ </div>

Expand Down
9 changes: 3 additions & 6 deletions MLS.tex
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@

\include{chapters/titlepage}

% Add new Modelica Language logotype
% The header ruler looks odd as Modelica Language define a natural line that is further up
% We also need to fill the vertical space on the right
% Add new Modelica language logotype.
% The header ruler looks odd as "Modelica Language Specification" defines a natural line that is further up.
% We also need to fill the vertical space on the right.
% Not using page numbers in right-header, since we usually refer to sections.
%
% Using nouppercase since it is seems more normal for the sections, and is also
Expand Down Expand Up @@ -150,9 +150,6 @@
% Derivation of Stream Equations
\include{chapters/derivationofstream}

% Modelica Revision History
\include{chapters/revisions}

\clearpage% get the \phantomsection below on the correct page
\phantomsection
\addcontentsline{toc}{chapter}{\bibname}%
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<img src="https://github.com/modelica/ModelicaSpecification/raw/master/media/Modelica_Language.svg?sanitize=true#gh-light-mode-only" alt="Modelica Language Logo" width="250px"/>
<img src="https://github.com/modelica/ModelicaSpecification/raw/master/media/Modelica_Language_dark.svg?sanitize=true#gh-dark-mode-only" alt="Modelica Language Logo" width="250px"/>
<img src="https://github.com/modelica/ModelicaSpecification/raw/master/media/Modelica_Language.svg?sanitize=true#gh-light-mode-only" alt="Modelica language logo" width="250px"/>
<img src="https://github.com/modelica/ModelicaSpecification/raw/master/media/Modelica_Language_dark.svg?sanitize=true#gh-dark-mode-only" alt="Modelica language logo" width="250px"/>

# Modelica Language Specification

# ModelicaSpecification
This repository contains the Modelica Language Specification, hosted at https://github.com/modelica/ModelicaSpecification.
Development is organized within the [Modelica Association Project Language (MAP-Lang)](https://modelica.org/projects) according to the [project rules](https://github.com/modelica/MAP-Lang_ProjectRules/blob/main/MAP-Lang-ProjectRules.md).

Expand Down
2 changes: 1 addition & 1 deletion RationaleMCP/0033/ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ This MCP is based on an existing solution using vendor specific annoations in Wo
Wolfram MathCore is willing to convert these vendor specific annotations to the form standardized by this MCP, and provide the plots for free to the MSL.

### Experience with Prototype
See Summary above. The greatly enhanced user experience was observed even though the existing collection of predefined plots does not make use of captions. The use of captions have been tested with very nice results on a smaller number of plots.
See Summary above. The greatly enhanced user experience was observed even though the existing collection of predefined plots does not make use of captions. The use of captions have been tested with very nice results on a smaller number of plots.

## Required Patents
To the best of our knowledge, there are no patents that would conflict with the incorporation of this MCP.
Expand Down
155 changes: 61 additions & 94 deletions RationaleMCP/DevelopmentProcess.md

Large diffs are not rendered by default.

19 changes: 8 additions & 11 deletions RationaleMCP/GuidingPrinciples.MD
Original file line number Diff line number Diff line change
@@ -1,17 +1,14 @@
Guiding Principles of the Modelica Language Development
--
# Guiding Principles of the Modelica Language Development

The overall goal of the development process is guided by the following fundamental tenets that all aim to
facilitate widespread adoption of the standard and promoting modeling of cyber-physical systems:
The overall goal of the development process is guided by the following fundamental tenets that all aim to facilitate widespread adoption of the standard and promoting modeling of cyber-physical systems:

1. Compatibility: The Modelica Language Standard shall be internally consistent and complete.
The Standard documents shall be an enabler for convenient and precise definition of cyber-physical systems.
1. **Compatibility**: The Modelica Language Specification shall be internally consistent and complete.
The specfication documents shall be an enabler for convenient and precise definition of cyber-physical systems.

2. Simplicity: The Modelica Language Standard shall stay as simple as possible.
1. **Simplicity**: The Modelica Language Specification shall stay as simple as possible.

3. Stability: Backwards compatibility of future versions of the Modelica Language Standard shall be maintained whenever possible.
1. **Stability**: Backwards compatibility of future versions of the Modelica Language Specification shall be maintained whenever possible.

4. Neutrality: The Modelica Language shall be neutral with respect to tools, technologies (e.g. processors, compilers, OS,
file system access, solvers, real-time capability, ...) and languages.
1. **Neutrality**: The Modelica Language Specification shall be neutral with respect to tools, technologies (e.g. processors, compilers, OS, file system access, solvers, real-time capability, ...) and languages.

5. Transparency: End users and tool vendors shall be informed about the progress of standardization as early as possible.
1. **Transparency**: End users and tool vendors shall be informed about the progress of standardization as early as possible.
8 changes: 4 additions & 4 deletions Tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## Abstract:

This document is a tutorial for the Modelica language, which is developed by the Modelica Association, a non-profit organization with seat in Linköping, Sweden.
This tutorial was originally for version 1.4 of the Modelica Language, the text and examples has been updated to be correct for the latest version, but the tutorial does not explain features introduced later.
This tutorial was originally for version 1.4 of the Modelica Language Specification, the text and examples has been updated to be correct for the latest version, but the tutorial does not explain features introduced later.
Modelica is a freely available, object-oriented language for modeling of large, complex, and heterogeneous physical systems.
It is suited for multi-domain modeling, for example, mechatronic models in robotics, automotive and aerospace applications involving mechanical, electrical, hydraulic and control subsystems, process oriented applications and generation and distribution of electric power.
Models in Modelica are mathematically described by differential, algebraic and discrete equations.
Expand Down Expand Up @@ -119,7 +119,7 @@ Similar laws apply to flow rates in a piping network and to forces and torques i

When developing models and model libraries for a new application domain, it is good to start by defining a set of connector classes.
A common set of connector classes used in all components in the library supports compatibility of the component models.
In the Modelica Standard Library developed together with the Modelica Language, for many domains appropriate connector definitions are already available.
In the Modelica Standard Library developed together with the Modelica language, for many domains appropriate connector definitions are already available.

A common property of many electrical components is that they have two pins.
This means that it is useful to define an "interface" model class,
Expand Down Expand Up @@ -2023,7 +2023,7 @@ annotation ( Documentation( info = "
<HTML>
<p>
Package <b>Modelica</b> is a <b>standardized</b> and <b>pre-defined</b>
package that is developed together with the Modelica language from the
package that is developed together with the Modelica Language Specification from the
Modelica Association, see
<a href=\"http://www.Modelica.org\">http://www.Modelica.org</a>.
It is also called <b>Modelica Standard Library</b>.
Expand Down Expand Up @@ -2085,7 +2085,7 @@ Interested simulation professionals who would like to contribute are encouraged

## References

The following are the references for the original design of the Modelica Language.
The following are the references for the original design of the Modelica language.

- Abadi M., and L. Cardelli: A Theory of Objects. Springer Verlag, ISBN 0-387-94775-2, 1996.
Broenink J.F.: "Bond-Graph Modeling in Modelica". ESS’97 - European Simulation
Expand Down
2 changes: 1 addition & 1 deletion chapters/copyright.tex
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
No patent liability is assumed with respect to the use of information contained herein.
While every precaution has been taken in the preparation of this document no responsibility for errors or omissions is assumed.

The contributors to this and to previous versions of this document are listed in \cref{modelica-revision-history}.
The members of the Modelica Association project \emph{Modelica Language} (MAP-Lang) contributed to the Modelica Language Specification.
2 changes: 1 addition & 1 deletion chapters/introduction.tex
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ \section{Scope of the Specification}\label{scope-of-the-specification}
Many Modelica models, especially in the associated Modelica Standard Library, are higher index systems, and can only be reasonably simulated if symbolic index reduction is performed, i.e., equations are differentiated and appropriate variables are selected as states, so that the resulting system of equations can be transformed to state space form (at least locally numerically), i.e., a hybrid DAE of index zero.
In order to allow this structural analysis, a tool may reject simulating a model if parameters cannot be evaluated during translation -- due to calls of external functions or initial equations/initial algorithms for \lstinline!fixed = false! parameters.
Accepting such models is a quality of implementation issue.
The Modelica specification does not define how to simulate a model.
This document does not define how to simulate a model.
However, it defines a set of equations that the simulation result should satisfy as well as possible.

The key issues of the translation (or flattening) are:
Expand Down
3 changes: 2 additions & 1 deletion chapters/preface.tex
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,6 @@ \chapter*{Preface}\label{preface}
The text directly under the chapter headings are non-normative introductions to the chapters.

The Modelica language has been developed since 1996.
Modelica~1, the first version of Modelica, was released in September 1997, and had the language specification as a short appendix to the rationale.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting; I was surprised by it just being 1 - not 1.0; but the document itself had just a 1.

This document describes version \mlsversion{} of the Modelica language.
The revision history is available in \cref{modelica-revision-history}.
The current version, as well as all previous versions of this document, and the list of changes are available at \url{https://specification.modelica.org}.
15 changes: 0 additions & 15 deletions chapters/revisions.tex

This file was deleted.

2 changes: 1 addition & 1 deletion css/MLS.css
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ a { text-decoration: none; color: inherit; }
a:hover { text-decoration: underline; }

.ltx_titlepage {
padding-top: 2rem; /* The big Modelica Language logo doesn't look good too close to page header. */
padding-top: 2rem; /* The big Modelica language logo doesn't look good too close to page header. */
}

.ltx_tocentry_subsection { display: none; }
Expand Down
2 changes: 1 addition & 1 deletion overleaf_guide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Editing ModelicaSpecification with Overleaf

You can use [Overleaf](https://www.overleaf.com/) for convenient online collaborative editing of the Modelica Specification LaTeX sources.
You can use [Overleaf](https://www.overleaf.com/) for convenient online collaborative editing of the Modelica Language Specification LaTeX sources.

## Getting Started

Expand Down
4 changes: 2 additions & 2 deletions styleguide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Modelica Specification style guide
# Modelica Language Specification style guide

This is the style guide for the Modelica Specification document.
This is the style guide for the Modelica Language Specification document.


## Document format and tool chain
Expand Down