https://github.com/apalache-mc/apalache
APALACHE: symbolic model checker for TLA+ and Quint
https://github.com/apalache-mc/apalache
apalache model-checking quint smt tla tlaplus verification
Last synced: 6 months ago
JSON representation
APALACHE: symbolic model checker for TLA+ and Quint
- Host: GitHub
- URL: https://github.com/apalache-mc/apalache
- Owner: apalache-mc
- License: apache-2.0
- Created: 2015-07-03T21:56:22.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2025-01-22T16:14:03.000Z (9 months ago)
- Last Synced: 2025-04-13T19:09:11.647Z (6 months ago)
- Topics: apalache, model-checking, quint, smt, tla, tlaplus, verification
- Language: Scala
- Homepage: https://apalache-mc.org/
- Size: 62.1 MB
- Stars: 455
- Watchers: 6
- Forks: 42
- Open Issues: 294
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[![main badge][]][main-ci]
[main badge]: https://github.com/apalache-mc/apalache/workflows/build/badge.svg?branch=main
[main-ci]: https://github.com/apalache-mc/apalache/actions?query=branch%3Amain+workflow%3Abuild
Apalache translates [TLA+][] into the logic supported by SMT solvers such as
[Microsoft Z3][]. Apalache can check inductive invariants (for fixed or bounded
parameters) and check safety of bounded executions (bounded model checking). To
see the list of supported TLA+ constructs, check the [supported features][]. In
general, Apalache runs under the same assumptions as [TLC][]. However, Apalache
benefits from constraint solving and can handle potentially larger state-spaces,
e.g., involving integer clocks and Byzantine faults.
To learn more about TLA+, visit [Leslie Lamport's page on TLA+][] and his [Video
course][].
## Releases
Check the [releases page][] for our latest release.
For a stable release, we recommend that you pull the latest docker image with
`docker pull ghcr.io/apalache-mc/apalache:main`, use the jar from the
most recent release, or checkout the source code from the most recent release
tag.
To try the latest cool features, check out the head of the [main branch][].
You can also find Apalache packaged via Nix at [cosmos.nix](https://github.com/informalsystems/cosmos.nix)
For more information on installation options, see [the
manual][user-manual-installation].
## Success stories
Check [Apalache examples][] that demonstrate how to use the strengths of Apalache.
Also, check the [standard repository of TLA+ examples][].
## Getting started
- Read the [Beginner's tutorial][].
- Read the [Apalache user manual][user-manual].
- Consult the (WIP) [Idioms for writing better TLA+][idioms].
- Consult the (WIP) [TLA+ language manual for engineers][language-manual].
## Community
- Discuss the use of Apalache and R&D on the [Apalache Forum][].
- [Contribute](./CONTRIBUTING.md) to the development of Apalache.
## Funding and Sponsorship
Currently, Apalache is not funded by any organization. As a result,
it is de-facto funded by its current maintainers and contributors,
including [Igor Konnov][], [Jure Kukovec][], and [Thomas Pani][].
If you would like to sponsor the project, please contact us, or
simply sponsor us on GitHub by clicking the "Sponsor" button!
We are grateful for the past financial support in the form of grants or
employment from the following organizations:
- [Informal Systems][] (Canada/Switzerland/Austria): 2020-2024
- [Vienna Business Agency][] (Austria): 2021-2023
- [Interchain Foundation][] (Switzerland): 2019-2023
- [WWTF][] (Austria): Vienna Science and Technology Fund 2016-2020
- [Inria Nancy][] and [LORIA][] (France): 2018-2019
- [TU Wien][] (Austria): 2016-2020
More details on the [Funding page](./FUNDING.md).
## Website
Our current website is served at https://apalache-mc.org .
The site is hosted by github, and changes can be made through PRs into the
[gh-pages](https://github.com/apalache-mc/apalache/tree/gh-pages) branch of this repository. See the README.md on that
branch for more information.
The user documentation is automatically deployed to the website branch as per
the [CI configuration](./.github/workflows/deploy.yml).
---
[tla+]: http://lamport.azurewebsites.net/tla/tla.html
[microsoft z3]: https://github.com/Z3Prover/z3
[supported features]: https://apalache-mc.org/docs/apalache/features.html
[tlc]: http://lamport.azurewebsites.net/tla/tools.html
[leslie lamport's page on tla+]: http://lamport.azurewebsites.net/tla/tla.html
[video course]: http://lamport.azurewebsites.net/video/videos.html
[releases page]: https://github.com/apalache-mc/apalache/releases
[master]: https://github.com/apalache-mc/apalache/tree/master
[main branch]: https://github.com/apalache-mc/apalache/tree/main
[tendermint specs]: https://github.com/tendermint/tendermint/tree/master/spec/light-client/accountability
[tendermint blockchain]: https://github.com/tendermint
[standard repository of tla+ examples]: https://github.com/tlaplus/Examples
[apalache benchmarks]: https://github.com/apalache-mc/apalache-tests
[checking inductive invariants]: https://github.com/apalache-mc/apalache-tests/blob/master/results/001indinv-report.md
[bounded model checking]: https://github.com/apalache-mc/apalache-tests/blob/master/results/002bmc-report.md
[user-manual]: http://apalache-mc.org/docs/index.html
[user-manual-docker]: https://apalache-mc.org/docs/apalache/installation/docker.html
[user-manual-installation]: https://apalache-mc.org/docs/apalache/installation/index.html
[language-manual]: https://apalache-mc.org/docs/lang/index.html
[idioms]: https://apalache-mc.org/docs/idiomatic/index.html
[light client specs]: https://github.com/tendermint/tendermint/tree/master/spec/light-client/verification
[model-based testing]: https://github.com/informalsystems/tendermint-rs/tree/master/light-client/tests/support/model_based#light-client-model-based-testing-guide
[apalache-mc.org]: https://apalache-mc.org
[TLA-Apalache workshop]: https://github.com/informalsystems/tla-apalache-workshop
[Beginner's tutorial]: https://apalache-mc.org/docs/tutorials/entry-tutorial.html
[Apalache examples]: https://github.com/konnov/apalache-examples
[Apalache Forum]: https://apalache.discourse.group/
[WWTF]: https://wwtf.at/index.php?lang=EN
[TU Wien]: https://www.tuwien.at/
[Inria Nancy]: https://www.inria.fr/en/inria-centre-universite-lorraine
[LORIA]: https://loria.fr
[Interchain Foundation]: https://interchain.io/
[Informal Systems]: https://informal.systems/
[Vienna Business Agency]: https://viennabusinessagency.at/
[Igor Konnov]: https://github.com/konnov
[Jure Kukovec]: https://github.com/kukovec
[Thomas Pani]: https://github.com/thpani
