PIACERE Model Checker

The DOML Model Checker is a component of the PIACERE framework in charge of checking the correctness and consistency of DOML models.

This project is packaged with Poetry.

Build and Run

Build with

poetry install

then run with

poetry run python -m mc_openapi

Run tests with:

poetry run python -m pytest

Run with Uvicorn

The project may be run with Uvicorn as follows:

uvicorn --port 8080 --host 0.0.0.0 --interface wsgi --workers 2 mc_openapi.app_config:app

Run with Docker

First, build the docker image with the usual

docker build -t wp4/dmc .

And then run it with

docker run -d wp4/dmc

The Uvicorn server will be running and listening on port 80 of the container. To use it locally, you may e.g. bind it with port 8080 of localhost by adding -p 127.0.0.1:8080:80/tcp to the docker run command.

Building the Documentation

The documentation has been written in Sphinx and covers both usage through the PIACERE IDE and the REST APIs.

To build it, type

poetry shell

and then

cd docs
make html

The documentation will be generated in docs/_build.