OMShell-terminal(1)

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

SYNOPSIS
OMShell-terminal [-corba] [-noserv] [-verbose]

DESCRIPTION
OMShell-terminal is a script that starts the console based client application OMShell-terminal of the OpenModelica Project. The client application OMShell-terminal is a front end between the user and the OpenModelica Compiler/Interpreter omc. The script OMShell-terminal knows two starting modes and the two communication interfaces CORBA and BSD socket:

•   In the first mode the script OMShell-terminal will be launched from a menu like GNOME menu or Debian menu. In this mode the communication between the client application OMShell-terminal and the server omc is limited to the CORBA interface. The script options -corba, -noserv and -verbose can't be used.

    During the startup sequence the script sets the required environment variables, creates a sub directory with the name OMWorkspace in user's home directory and change to it. After the change, the client application OMShell-terminal will be launched. If the starting script OMShell-terminal finds a directory OMWorkspace in the user's home directory, the script doesn't create the directory OMWorkspace again.

    The start of the client application OMShell-terminal triggers the execution of the Compiler/Interpreter omc. The Compiler/Interpreter will run in server mode. The communication will be based on the CORBA interface.

    Runs the compiler omc in an independent started server process prior to the start of the OMShell-terminal script, the starting client application OMShell-terminal will use the running omc as server. But the communication between the client and the server is limited to the CORBA interface. Consequently the independent server process omc must be started with the CORBA interface enabled.

•   In the second mode the script OMShell-terminal will be launched from a console in a X-Window environment. In this mode the communication between the client application OMShell-terminal and the server omc can use the CORBA interface or the BSD socket interface. The script option -corba selects the wanted communication interface.

    Starting the script OMShell-terminal from user's home directory, it will print a usage hint and returns to the console prompt. Launching the script from another directory then the user's home directory, the script will set the required environment variables and will run the client application OMShell-terminal.

    The start of the client application OMShell-terminal triggers the execution of the Compiler/Interpreter omc. The Compiler/Interpreter will run in server mode. The communication interface depends on the script option -corba. With the script option -corba the client OMShell-terminal application will use the CORBA communication interface. Without the option -corba the communication is based on the BSD socket interface.

    With the option -noserv the client application OMShell-terminal can use a running omc server process. In this case the communication interfaces of the client and the server must match. The script option -noserv prevents the client OMShell-terminal starting his own instance of the compiler server omc.

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-terminal avoids the clutter of the user's home directory.

The console based client application OMShell-terminal 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 running client application OMShell-terminal.

OPTIONS

-corba
    use CORBA communication interface between the client application OMShell-terminal and the Compiler/Interpreter server omc. If not set, the communication will be based on BSD socket interface.

-noserv
    the client application OMShell-terminal shall not create his own instance of the Compiler/Interpreter omc. This option shall be used, if an independent omc server process is running prior to the start of the OMShell-terminal script.

-verbose
    shows what is going on under the hood between the client application OMShell-terminal and the compiler server omc.

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-terminal launches the console based client application OMShell-terminal. Some supplementary informations about the application will be found in the following sub section.

  Executables:

•   OMShell-terminal - OpenModelica Shell a console based command shell for Modelica

    File:
        OMShell-terminal
    Path:
        /usr/bin/

SEE ALSO
omc(1), OMNotebook(1), OMShell(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.