This is the UI for the SoOSiM simulator.

There are two ways of installing this package. In both cases, you need
to have your cabal bin directory in your path. I recommend using cabal-dev,
unless you want to install SoOSim for all users or produce a distributable file.

0) You will need ghc, cabal-install, and some libraries. Under ubuntu, the following
installation covers everything starting from a fresh, just-installed Ubuntu (probably works in Debian too):

    $ apt-get install ghc cabal-install libz-dev git libftgl-dev libglade2-dev alex happy libgtkglext1-dev

1) Install cabal-dev

    $ cabal install cabal-dev
    $ export PATH=$HOME/.cabal/bin:$PATH

(you need to add cabal's bin dir to your path.  In *nix OSs, this usually
means adding $HOME/.cabal/bin to your PATH.)

2) Create a directory where everything will be installed and compiled and run install-with-deps.sh.

    $ mkdir soosim-all
    $ cd soosim-all
    $ wget https://raw.github.com/ivanperez-keera/SoOSiM-ui/master/install-with-deps.sh
    $ chmod a+x install-with-deps.sh
    $ ./install-with-deps.sh

The executable should be produced inside cabal-dev/bin/SoOSiM-ui

Let me know if other libs are necessary, or if anything fails (feel free to open an issue).


== What follows are old instructions. Follow the instructions above instead.

1) Download all the dependencies, unpack each one of them and install.
You will need:

 * The following packages from Keera Studios (https://github.com/keera-studios/):
   gtk-helpers     >= 0.0.4
   hails-mvc-environment-gtk
   hails-mvc-model-protectedmodel
   hails-mvc-view-gtk
   hails-reactive-gtk
   hails-reactivevalues

 * keera-callbacks: https://github.com/ivanperez-keera/keera-callbacks
 * gloss-gtk:       https://github.com/ivanperez-keera/gloss-gtk
 * SoOSiM:          https://github.com/ivanperez-keera/SoOSiM
 * SoOSiM-ui:       https://github.com/ivanperez-keera/SoOSiM-ui

For each one of those, unpack, go into the generated dir, and
run cabal install (or 'cabal install --reinstall' if you installed
them before).

2) Use my hackage repo to install all the dependencies.

Add the following line to your .cabal/config file, right below remote-repo:
hackage.haskell.org [...]

remote-repo: ivanperez-keera:http://ivanperez-keera.github.com/packages/archive

Then run cabal update && cabal install SoOSiM-ui

In any case, you need to have a few dependencies, among them:
 - gtk:      for which you need to install the gtk development libraries
 - gtkglext: for which you need to install the gtkgl development libraries

This program has been reported working on Linux and MacOSX.
It remains untested under windows.

====

Once installed, the program opens the default example in the user interface.
With the current configuration, that cannot be changed (the reason is not as
dumb as it may seem: examples are actual haskell code, not just some file
that's opened and interpreted).

The colours used to paint the diagrams are specified in a config file.
In *nix OSs, this should be located in ~/.cabal/share/SoOSiM-ui-0.1/data/config.
This will change in the future (it's the wrong location, as changes are
lost once the version number is increased).

That file descibes 4 pairs of colours. The first element in each
pair is always the colour when selected. The second element is the
colour when not selected. The colours are, in order:

 - Processing units (nodes).
 - Running components
 - Waiting components
 - Idle components