OMShell(1)

NAME
OMShell - Start script, set environment variables and invoke the Qt based client application OMShell

SYNOPSIS
OMShell

DESCRIPTION
OMShell is a script that starts the Qt based client application OMShell of the OpenModelica Project. The client application OMShell is a front end between the user and the OpenModelica Compiler/Interpreter omc. The script OMShell knows two starting modes:

•   In the first mode it will be launched from a menu like GNOME menu or Debian menu. In this case the script will set the required environment variables, will create a sub directory with the name OMWorkspace in user's home directory and will changed into it. After the change, the client application OMShell will be launched. If the starting script OMShell found a directory OMWorkspace in the user's home directory, it will switch into the directory OMWorkspace and then it will start the application OMShell.

    The start of the client application OMShell will trigger the start of the Compiler/Interpreter omc. The Compiler/Interpreter omc will run in server mode and will communicate over CORBA with the client application OMShell.

    Runs the compiler omc in an independent started server process prior to the start of the OMShell script, the starting client application OMShell will use the running omc as server. The client application OMShell will not launch its own omc server.

•   In the second mode the script OMShell will be launched from a console. When the user starts the script OMShell from his or her home directory, the script gives a usage hint and will return to the console prompt. Starting the script from another directory then the user's home directory, the script will set the required environment variables and will run the application OMShell. The directory OMWorkspace will not be created like in the first case. The current directory will be the working directory for the client application OMShell and the indirect started Compiler/Interpreter server omc.

    Runs the compiler omc in an independent started server process like in the above case, the client application OMShell will use omc as server. The client OMShell will not start its own omc server. The communication between the client and the server will use the CORBA interface.

The special treatment of the user's home directory is necessary, because the compiler omc produce during his run C++ source code and some auxiliary files. These files will be stored in the current working directory. The behavior of the script OMShell avoids the clutter of the user's home directory.

The Qt based client application OMShell is an interactive session handler or in other words a command shell for Modelica. In the shell the user can run OpenModelica control commands. These commands supports the import of Modelica classes, the loading of Modelica source code, the flatten of Modelica source code, the simulation of models, the plotting of simulation results and many more. In separate graphical viewers the user can further investigate and manipulate the results of the simulation. These viewers can be called from the OMShell.

ENVIRONMENT

OPENMODELICAHOME
    This variable contains the absolute path towards the OpenModelica Compiler/Interpreter executable omc.

    Default directory:
        /usr/

OPENMODELICALIBRARY
    Absolute path towards the OpenModelica library Modelica.

    Default directory:
        /usr/share/omlibrary/modelicalib/

QTHOME
    Absolute path towards the directory with Qt libraries. The Compiler/Interpreter omc use these libraries to build the simulation executable. Setting the environment variable is only necessary, if omc is compiled with Qt support. The Compiler/Interpreter omc of the Debian package is compiled with Ot support by default.

    Default directory:
        ${OPENMODELICAHOME}/lib/

FILES
The start script OMShell launches the Qt based client application OMShell. Some supplementary informations about the application will be found in the following sub section.

  Executables:

•   OMShell - OpenModelica Shell a command shell for Modelica

    File:
        OMShell
    Path:
        /usr/bin/

SEE ALSO
omc(1), OMNotebook(1), OMShell-terminal(1)

AUTHOR
The original author was William Spinelli. Changes and improvements were made by Robert Wotzlaw <Robert.Wotzlaw at web.de>.

The current author isn't a member of the Open Source Modelica Consortium (OSMC) nor a collaborator at the Programming Environment Laboratory (PELAB), Department of Computer and Information Science (IDA) of the Linkoeping University (LiU). He supports the OpenModelica Project as volunteer.