scyther/gui/INSTALL.md

75 lines
1.9 KiB
Markdown
Raw Permalink 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
2020-10-28 07:49:32 +00:00
Scyther requires **Python 3** now, and no longer supports Python 2.
2013-12-13 22:33:10 +00:00
* **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.
The recommended way of installing is through `pip` and described this page:
2013-12-13 22:33:10 +00:00
https://www.wxpython.org/download.php
2013-12-13 22:33:10 +00:00
This version of Scyther requires at least **wxPython 4.0**. Note that older versions of Scyther did not work with wxPython 4.
2013-12-13 22:33:10 +00:00
For Ubuntu users, it is important to add an additional parameter, e.g., for Ubuntu 20.04, the recommended pip install is:
2013-12-13 22:33:10 +00:00
```
$ sudo apt install python-pip
$ pip install -U \
-f https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-20.04 \
wxPython
```
2013-12-13 22:33:10 +00:00
Running Scyther
---------------
2013-12-13 22:58:26 +00:00
Extract the Scyther archive and navigate to the extracted directory.
2013-12-13 22:33:10 +00:00
Start Scyther by executing the file
`scyther-gui.py`
2013-12-13 22:33:10 +00:00
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
Right-click the file `scyther-gui.py` and select "Open with" and
2013-12-13 22:47:47 +00:00
then "Python Launcher".
2013-12-13 22:33:10 +00:00