Requirements

• Linux or Windows-Cygwin
• A sane gnu C++ development environment: gcc, make, etc.
• Python (2.2.2 or later) including Tkinter. For Cygwin, make sure you use the Cygwin version of Python, not the Windows native version; install Python using the Cygwin installer.
• Tcl/Tk. Python includes module Tkinter which uses but usually does not include the Tcl/Tk libraries. In this case the Tcl/Tk libraries must be installed separately. In Cygwin the package is called tcltk (under category Libs).
• Graphviz: http://www.graphviz.org/. It is recommended that you install the binary version for your platform. Make sure program "dot" ("dot.exe" on Cygwin) may be found on the PATH. For example, you may need to find the executable and create a symbolic link to it in /usr/bin.
• 200MB of hard drive space for building

Building and installing

This WhatOS version is designed to not interfere with other installations of WhatOS or with other installations of programs included in whatos_third_party. All files will be installed local to the directory where you unpack the sources.

Packages whatos and whatos_third_party must be extracted in the same directory and must remain together. The installation for package whatos will also build and install whatos_third_party.

Note: It is recommended that you avoid using file and directory names containing spaces and other special characters.

The following instructions assume whatos_1_1_0 and whatos_third_party_001, are to be installed in directory "whatos". Replace with the correct version numbers and installation directory:

$ mkdir whatos
$ cd whatos
$ tar xvfz whatos_1_1_0.tar.gz
$ tar xvfz whatos_third_party_001.tar.gz
$ cd whatos_1_1_0
$ ./aap

The last command will list all available aap targets. Read them and follow the instructions. For example, to build and install:

$ ./aap install

Note: Compilation time for upgrading to future versions of WhatOS will be considerably reduced if you do not run "./aap clean" or "./aap uninstall".

Installing for a different Python version

WhatOS and third party software will be installed for the Python version which is used to run "./aap". By default, this is "/usr/bin/env python". To install using a different Python version, for example python2.2 execute aap like this:

$ python2.2 ./aap install

Upgrading to a newer WhatOS version

Multiple installations of WhatOS may coexist in the same install directory. whatos_third_party will stay the same over many whatos versions and may not need to be upgraded. You will get an error message during installation if you need to upgrade whatos_third_party.

The following instructions assume that you want to install whatos_1_1_1 in directory "whatos", the same directory where whatos_1_1_0 exists. Replace with the correct version numbers and installation directory:

$ cd whatos
$ tar xvfz whatos_1_1_1.tar.gz
$ cd whatos_1_1_1
$ ./aap

The last command will list all available aap targets. Read them and follow the instructions. For example, to build and install:

$ ./aap install

Upgrading to a newer Python version

The WhatOS installation is tightly linked to the Python version with which it is originally installed. Therefore you must clean and uninstall before reinstalling with the new Python version.

The following instructions assume you want to reinstall whatos_1_1_0 in directory "whatos" for a new Python version:

$ cd whatos_1_1_0
$ ./aap uninstall
$ ./aap clean
$ ./aap

The last command will list all available aap targets. Read them and follow the instructions. For example, to build and install:

$ ./aap install

Third-party software

This section acknowledges third-party software used for developing WhatOS. Some of these are included in the whatos_third_party package.

• Python: for just about everything
• Boost.Python: to bridge the gap between Python and C++ (included)
• Aap: a Python-based replacement for gnu make (included)
• BuDDy: a binary decision diagram package needed by AutoState (included)
• Pmw Megawidgets: for creating better Tkinter widgets (included)
• Graphviz: for automatically creating graphs
• pySerial: for cross-platform serial port communication in Python (included)
• Docutils: for generating documentation, including this page
• Highlight: for colorizing source code throughout the documentation