scyther/gui/INSTALL.md

90 lines
2.3 KiB
Markdown
Raw Normal View History

2013-12-13 22:33:10 +00:00
Installation and usage of the Scyther tool
==========================================
Requirements
------------
2013-12-13 22:47:47 +00:00
To be able to use all of Scyther's features, the following three
dependencies are needed. If you only require the back-end tool (used
from the command line) then you need only the first.
2013-12-13 22:33:10 +00:00
1. ### The GraphViz library ###
2013-12-13 22:33:10 +00:00
This library is used by the Scyther tool to draw graphs. It can be
freely downloaded from:
http://www.graphviz.org/
Download the latest stable release and install it.
2. ### Python ###
2013-12-13 22:33:10 +00:00
Stable releases of the Python interpreter are available from:
2013-12-13 22:47:47 +00:00
http://www.python.org/download/
2013-12-13 22:33:10 +00:00
Scyther does not support Python 3. You are therefore recommended to
choose the latest production release of Python 2, e.g., Python 2.7.
* **Mac OS X**
2013-12-13 22:47:47 +00:00
2013-12-13 22:49:41 +00:00
If the package yields an error when you try to install it,
please use the following, in the directory where you downloaded
it:
```
$ sudo installer -pkg graphviz-2.34.0.pkg -target /
```
2013-12-13 22:33:10 +00:00
3. ### wxPython libraries ###
2013-12-13 22:33:10 +00:00
The GUI user interface uses the wxPython libraries.
2013-12-13 22:47:47 +00:00
http://www.wxpython.org/download.php
2013-12-13 22:33:10 +00:00
There are many different wxPython packages. You should choose a 32-bit
package that matches your Python version (e.g., 2.7). It is
recommended to select the unicode version from the stable releases.
As of writing (May 2013) the following links lead to the appropriate
wxPython packages for Python 2.7:
* **Windows**
2013-12-13 22:47:47 +00:00
http://downloads.sourceforge.net/wxpython/wxPython2.8-win32-unicode-2.8.12.1-py27.exe
2013-12-13 22:33:10 +00:00
* **Mac OS X**
2013-12-13 22:47:47 +00:00
http://downloads.sourceforge.net/wxpython/wxPython2.8-osx-unicode-2.8.12.1-universal-py2.7.dmg
2013-12-13 22:33:10 +00:00
Note that this package is in an old format and you will probably
get a warning "Package is damaged". This can be resolved by:
```
$ sudo installer -pkg /Volume/.../wxPython2.8-osx-unicode-universal-py2.7.pkg/ -target /
```
2013-12-13 22:33:10 +00:00
* **Ubuntu/Debian Linux**
2013-12-13 22:47:47 +00:00
http://wiki.wxpython.org/InstallingOnUbuntuOrDebian
2013-12-13 22:33:10 +00:00
Running Scyther
---------------
Start Scyther by executing the file
scyther-gui.py
2013-12-13 22:47:47 +00:00
in the main directory of the extracted archive.
2013-12-13 22:33:10 +00:00
* **Mac OS X**
2013-12-13 22:33:10 +00:00
2013-12-13 22:47:47 +00:00
Right-click the file 'scyther-gui.py' and select "Open with" and
then "Python Launcher".
2013-12-13 22:33:10 +00:00