OMNotebook(1)

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

SYNOPSIS
OMNotebook

DESCRIPTION
OMNotebook is a script that starts the Qt based client application OMNotebook of the OpenModelica Project. The client application OMNotebook is a front end between the user and the OpenModelica Compiler/Interpreter omc. The script OMNotebook 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 application OMNotebook will be launched. If the starting script OMNotebook found a directory OMWorkspace in the user's home directory, it will switch into the directory OMWorkspace and then it will start the application OMNotebook.

    The start of the client application OMNotebook 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 OMNotebook.

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

•   In the second mode the script OMNotebook will be launched from a console. When the user starts the script OMNotebook 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 OMNotebook. The directory OMWorkspace will not be created like in the above case. The current directory will be the working directory for the client application OMNotebook and the indirect started Compiler/Interpreter server omc.

    Runs the compiler omc in an independent started server process like in the first case, the client application OMNotebook will use omc as server. The client OMNotebook 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 OMNotebook avoids the clutter of the user's home directory.

The Qt based client application OMNotebook is a Mathematica style Notebook for Modelica. In separate graphical viewers the user can further investigate and manipulate the results of the simulation. These viewers are the JAVA based application Ptolemy and the Qt based application graphWindow. The purpose of OMNotebook is to provide an advanced Modelica teaching tool. This release of OMNotebook includes DrModelica. A package which provides all the examples from Peter Fritzson's book the “Principles of Object-Oriented Modeling and Simulation with Modelica 2.1”.

ENVIRONMENT

DRMODELICAHOME
    This variable contains the absolute path towards the DrModelica package which provides all the examples from Peter Fritzson's book the “Principles of Object-Oriented Modeling and Simulation with Modelica 2.1”.

    Default directory:
        /usr/share/omnotebook/drmodelica/

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

  Executables:

•   OMNotebook - OpenModelica Notebook a Mathematica style Notebook for Modelica

    File:
        OMNotebook
    Path:
        /usr/bin/

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