Skip to content

Latest commit

 

History

History
158 lines (108 loc) · 5.57 KB

installation.rst

File metadata and controls

158 lines (108 loc) · 5.57 KB
Raw

Installing Stainless

Stainless is probably easiest to build on Linux-like platforms, but read on regarding other platforms.

Due to its nature, this documentation section may not always be up to date; we welcome pull requests with carefully written and tested improvements to the information below.

Requirements:

Linux & Mac OS-X

Get the sources of Stainless by cloning the official Stainless repository:

$ git clone https://github.com/epfl-lara/stainless.git
Cloning into 'stainless'...
// ...
$ cd stainless
$ sbt clean compile
// takes about 1 minute

Compilation will automatically generate the following two bash scripts: 1. bin/stainless-scalac that will use the scalac compiler as frontend, 2. bin/stainless-dotty that uses the dotc compiler as frontend (experimental).

You may want to introduce a soft-link from bin/stainless-scalac to stainless:

$ ln -s bin/stainless-scalac stainless

Note that Stainless is organized as a structure of several projects. The main project lives in core while the two available frontends can be found in frontends/scalac and frontends/dotty. From a user point of view, this should most of the time be transparent and the build command should take care of everything.

Windows

Get the sources of Stainless by cloning the official Stainless repository. You will need a Git shell for windows, e.g. Git for Windows.

$ git clone https://github.com/epfl-lara/stainless.git
Cloning into 'stainless'...
// ...
$ cd stainless
$ sbt clean compile
// takes about 1 minutes

Compilation will automatically generate the following two bash scripts: 1. bin/stainless-scalac that will use the scalac compiler as frontend, 2. bin/stainless-dotty that uses the dotc compiler as frontend (experimental).

You will now need to either port the bash scripts to Windows, or to run them under Cygwin.

External Solvers

Inox, the solving backend for Stainless, relies on SMT solvers for reasoning about quantifier-free formulas. See inox' solver documentation for more information on how to get/install these solvers.

Note that for the Native Z3 API to be available, you will have to place the jar produced by building ScalaZ3 into unmanaged/scalaz3-$os-$arch-$scalaVersion.jar.

Running Tests

Stainless comes with a test suite. Consider running the following commands to invoke different test suites:

$ sbt test
$ sbt it:test

Building Stainless Documentation

To build this documentation locally, you will need Sphinx ( http://sphinx-doc.org/ ), a restructured text toolkit that was originally developed to support Python documentation.

After installing sphinx, run sbt previewSite. This will generate the documentation and open a browser.

The documentation resides in the core/src/sphinx/ directory and can also be built without sbt using the provided Makefile. To do this, in a Linux shell go to the directory core/src/sphinx/, type make html, and open in your web browser the generated top-level local HTML file, by default stored in src/sphinx/_build/html/index.html. Also, you can open the *.rst documentation files in a text editor, since they are human readable in their source form.

Using Stainless in Eclipse

Untested!

You first need to tell sbt to globally include the Eclipse plugin in its known plugins. To do so type

$ echo "addSbtPlugin(\"com.typesafe.sbteclipse\" % \"sbteclipse-plugin\" % \"2.4.0\")" >> ~/.sbt/0.13/plugins/plugins.sbt

In your Stainless home folder, type: `sbt clean compile eclipse`

This should create all the necessary metadata to load Stainless as a project in Eclipse.

You should now be able to import the project into your Eclipse workspace. Don't forget to also import dependencies (the dotty and cafebabe projects, found somewhere in your ~/.sbt directory).

For each run configuration in Eclipse, you have to set the ECLIPSE_HOME environment variable to point to the home directory of your Eclipse installation. To do so, go to

Run -> Run Configuration

and then, after picking the configuration you want to run, set the variable in the Environment tab.

If you want to use ScalaTest from within Eclipse, download the ScalaTest plugin. For instructions, see Using ScalaTest with Eclise. Do NOT declare your test packages as nested packages in separate lines, because ScalaTest will not see them for some reason. E.g. don't write

package leon
package test
package myTestPackage

but instead

package leon.test.myTestPackage