How to install ChorGram

At the moment ChorGram is available for linux-like architectures only. So far ChorGram has been tested on Ubuntu (13.04, 14.04, 16.04, 20.04.3) and Mac OS X (v10.9).

Required Tools/ Libraries

The following tools and libraries are required.

• graphviz (and python-numpy if you would like to run the benchmarks scripts). On ubuntu/debian, run

sudo apt-get install graphviz

to install graphviz.

• Haskell and its libraries MissingH and hxt (Haskell libraries); run

  cabal install MissingH hxt

• HKC (slight variation on git); ocamlbuil is required for compiling HKC which can be installed by running

  sudo apt install ocamlbuild

• Petrify

Note that if you have a recent version of Linux, you have to install libc6:i386:

sudo dpkg --add-architecture i386
sudo apt update
sudo apt install libc6:i386

thanks to Zanna for the tips.

Besides the command line options, there is a configuration file aux/dot.cfg that can be used to tune up dot files. The format of the file is very basic: each line is a blank-separated key/value pair and an optional comment (starting with : after each value). You will probably need to change just values (in the 2nd column of the configuration file); for instance, to change to symbol separating local states in configurations to ++ you've to change the value of `statesep: making the line look like

statesep        ++      :symbol to separate states in output files

Unless you know what you're do doing, do not add lines to aux/dot.cfg. If you need to edit the file other than for altering the values as described, remember the following rules:

• do not insert text before the very first line.
• do not insert empty lines
• do not insert lines with the very same initial word

Configuration

Move the compressed files of HKC and Petrify in the directory ChorGram; any subdirectory would do, but it is advisable to put them in aux.

Decompress the files of HKC and Petrify (for Linux these are hknt-1.0.tar.bz2 and petrify-5.2-linux.tar.gz).

Compilation

Once both the directories of HKC and Petrify are ready and in the directory ChorGram, you simply open a shell and cd in the ChorGram directory from where you execute

make setup

If you want, you can compile HKC yourself by going into the directory of HKC and running

make (you will need OCaml, ./hknt-1.0/README).