Getting Started

Installation

Satyrus requires a 3.7+ CPython (python.org) distribution. You may install it directly via pip or build from source.

pip - Linux, OSx

$ python3 -m pip install satyrus[all]

pip - Windows

> pip install satyrus[all]

Building from source

$ git clone https://github.com/pedromxavier/Satyrus3
$ cd Satyrus3
$ pip install .[all]

The [all] suffix is optional but recommended since it automatically installs the dependencies required for running the available solver interfaces (DWave & Gurobi).

Note: Satyrus is still under constant development. If you have already installed, please install using the --upgrade option.

$ pip install .[all] --upgrade

Command line interface

After installation, the satyrus executable should be available in the command line interface: give it a try!

$ satyrus --help
$ satyrus source.sat

Also, consider visiting the examples page.