Skip to content

Commit

Permalink
Some spelling fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
sjoelund committed Mar 23, 2018
1 parent dbc28d8 commit 5a27cbb
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 42 deletions.
33 changes: 12 additions & 21 deletions UsersGuide/source/omjulia.rst
@@ -1,16 +1,7 @@
OpenModelica Julia Interface
=============================

This chapter describes the OpenModelica Julia integration facilities.

- OMJulia – the OpenModelica Julia scripting interface, see :ref:`OMJulia`.

.. _OMJulia:

OMJulia – OpenModelica Julia Interface
----------------------------------------
======================================

OMJulia – OpenModelica Julia API is a free, open source, highly
OMJulia – the OpenModelica Julia API is a free, open source, highly
portable Julia based interactive session handler for Modelica
scripting. It provides the modeler with components for creating a
complete Modelica modeling, compilation and simulation environment based
Expand All @@ -28,19 +19,19 @@ ZeroMQ - high performance asynchronous messaging library and it supports the Mod
Standard Library version 3.2 that is included in starting with
OpenModelica 1.9.2.

The Development is in progress and will be soon available.At the moment
a prototype of OMJulia is completed where the users will be able to import the
The Development is in progress and will be soon available. At the moment
a prototype of OMJulia is completed where the users will be able to import the
OMJulia package in Julia and start to interact with omc through API calls

Current Prototype
~~~~~~~~~~~~~~~~~
The current version of the OMJulia package contains the following features:

- import the OMJulia package
- Connect with omc compiler through ZMQ sockets
- Able to interact with omc compiler through list of API calls available from OpenModelicaScripting
- All the API calls are communicated with the help of sendExpression method implemented in Julia
- the results are returned as strings.
- Import the OMJulia package
- Connect with the OpenModelica compiler through zmq sockets
- Able to interact with the OpenModelica compiler through the :ref:`available API <scripting-api>`
- All the API calls are communicated with the help of the sendExpression method implemented in a Julia module
- The results are returned as strings

Test Commands
~~~~~~~~~~~~~
Expand All @@ -62,8 +53,8 @@ To get started, create a OMJulia session object:
.. figure :: media/sineplot.png
:name: sineplot
Currently this is an incomplete Beta release. In the final release the OMJulia interface is planned to implement
the more advanced API calls below where the users will have the ability to perform interactive simulation
Currently this is an incomplete Beta release. In the final release the OMJulia interface is planned to implement
the more advanced API calls below where the users will have the ability to perform interactive simulation
and analysis similar to the enhanced OMPython features.

List of Planned API support
Expand All @@ -79,4 +70,4 @@ List of Planned API support
- setParameters()
- setSimulationOptions()

With the above list of API calls implemented, the users can have more control over the result types, returned in Julia format.
With the above list of API calls implemented, the users can have more control over the result types, returned as Julia data structures.
33 changes: 12 additions & 21 deletions UsersGuide/source/ommatlab.rst
@@ -1,17 +1,8 @@
OpenModelica Matlab Interface
=============================

This chapter describes the OpenModelica Matlab integration facilities.

- OMMatlab – the OpenModelica Matlab scripting interface, see :ref:`ommatlab`.

.. _ommatlab:

OMMatlab – OpenModelica Matlab Interface
----------------------------------------
========================================

OMMatlab – OpenModelica Matlab API is a free, open source, highly
portable matlab based interactive session handler for Modelica
OMMatlab – the OpenModelica Matlab API is a free, open source, highly
portable Matlab-based interactive session handler for Modelica
scripting. It provides the modeler with components for creating a
complete Modelica modeling, compilation and simulation environment based
on the latest OpenModelica library standard available. OMPython is
Expand All @@ -29,19 +20,19 @@ messaging library and it supports the Modelica
Standard Library version 3.2 that is included in starting with
OpenModelica 1.9.2.

The Development is in progress and will be soon available.At the moment
a prototype of OMMatlab is completed where the users will be able to import the
The Development is in progress and will be soon available.At the moment
a prototype of OMMatlab is completed where the users will be able to import the
OMMatlab package in Matlab and start to interact with omc through API calls

Current Prototype
~~~~~~~~~~~~~~~~~
The current version of the OMMatlab pacakge contains the following features:

- import the OMMatlab package in Matlab
- Connect with omc compiler through zmq sockets
- Able to interact with omc compiler through list of APIS available from OpenModelicaScripting
- All the API calls are communicated with the help of sendExpression method implemented in matlab pacakge
- the results are returned as strings.
- Import the OMMatlab package in Matlab
- Connect with the OpenModelica compiler through zmq sockets
- Able to interact with the OpenModelica compiler through the :ref:`available API <scripting-api>`
- All the API calls are communicated with the help of the sendExpression method implemented in a Matlab pacakge
- The results are returned as strings

Test Commands
~~~~~~~~~~~~~
Expand All @@ -63,7 +54,7 @@ To get started, create a OMMatlab session object:
.. figure :: media/sineplot.png
:name: sineplot
Currently this is an incomplete Beta release. In the final release the OMMatlab interface
Currently this is an incomplete Beta release. In the final release the OMMatlab interface
is planned to implement the more advanced API calls below where the users will have the ability
to perform interactive simulation and analysis similar to the enhanced OMPython features.

Expand All @@ -80,4 +71,4 @@ List of Planned API support
- setParameters()
- setSimulationOptions()

With the above list of API calls implemented, the users can have more control over the result types, returned in Matlab format.
With the above list of API calls implemented, the users can have more control over the result types, returned using Matlab data structures.
2 changes: 2 additions & 0 deletions UsersGuide/source/scripting_api.rst
@@ -1,5 +1,7 @@
:tocdepth: 2

.. _scripting-api :

Scripting API
~~~~~~~~~~~~~

Expand Down

0 comments on commit 5a27cbb

Please sign in to comment.