https://github.com/fizzbee-io/fizzbee

Easiest-ever formal methods language! Designed for developers crafting distributed systems, microservices, and cloud applications
https://github.com/fizzbee-io/fizzbee

alloy alloy-analyzer formal-languages formal-methods formal-verification ltl pluscal prism tla tla-plus tlaplus

Last synced: about 2 months ago
JSON representation

Easiest-ever formal methods language! Designed for developers crafting distributed systems, microservices, and cloud applications

• Host: GitHub
• URL: https://github.com/fizzbee-io/fizzbee
• Owner: fizzbee-io
• License: apache-2.0
• Created: 2024-03-26T20:43:58.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-05-08T21:42:31.000Z (about 2 months ago)
• Last Synced: 2024-05-09T20:38:42.722Z (about 2 months ago)
• Topics: alloy, alloy-analyzer, formal-languages, formal-methods, formal-verification, ltl, pluscal, prism, tla, tla-plus, tlaplus
• Language: Python
• Homepage: https://fizzbee.io
• Size: 354 KB
• Stars: 69
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-stars - fizzbee-io/fizzbee - `★106` Easiest-ever formal methods language! Designed for developers crafting distributed systems, microservices, and cloud applications (Python)
• awesome-stars - fizzbee-io/fizzbee - Easiest-ever formal methods language! Designed for developers crafting distributed systems, microservices, and cloud applications (Python)

README

        
# fizzbee

A Formal specification language and model checker

to specify distributed systems.

Try out now at [Fizzbee Online Playground](https://fizzbee.io/). No installation needed.

# Docs

If you are familiar with [TLA+](https://lamport.azurewebsites.net/tla/tla.html), this would be a quick start

[From TLA+ to Fizz](https://github.com/fizzbee-io/fizzbee/blob/main/docs/fizzbee-quick-start-for-tlaplus-users.md)

# Run a model checker

For now, no prebuilt binaries. But you can try without installation at https://fizzbee.io/play 

Or Install from source.

- Bazel: You need bazel installed to build. [Bazelisk](https://github.com/bazelbuild/bazelisk?tab=readme-ov-file#installation) is the recommended way to use bazel. Rename the binary to bazel and put it part of your PATH.

- gcc: This project uses protobuf. Bazel proto_library does not use precompiled protoc, and it builds from scratch. It requires g++ compiler. `sudo apt update; sudo apt install g++`

```

./fizz path_to_spec.fizz  

```

Example:

```

./fizz examples/tutorials/19-for-stmt-serial-check-again/ForLoop.fizz 

```

Note: Generally, you won't need to rebuild the binary,

but most likely will be required after each `git pull`.

# Development

## Bazel build

To run all tests:

```

bazel test //...

```

To regenerate BUILD.bazel files,

```

bazel run //:gazelle

```

To add a new dependency,

```

bazel run //:gazelle -- update-repos github.com/your/repo

```

or

```

gazelle update-repos github.com/your/repo

```

When making grammar changes, run

```

antlr4 -Dlanguage=Python3 -visitor *.g4

```

and commit the py files.

TODO: Automate this using gen-rule, so the generated files are not required in the repository

## Cross compilation to linux

Only the go model checker is cross compiled to linux.

On local machine, run `bazel build //:fizzbee`

To dockerize or to run on the linux server:

```

bazel build --platforms=//:linux_arm  //:fizzbee

```

or

```

bazel build --platforms=//:linux_x86  //:fizzbee

```

Python seems to work without platforms flag but unfortunately, 

passing platforms flag actually breaks the build.