PIACERE Model Checker

📖 You can read the docs here for more details. 📖

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

We provide a requirements.txt file for CI/CD purposes.

If you add a new package, regenerate it by running:

pip freeze > requirements.txt

Setup

Activate the Python Virtual Environment with:

source .venv/bin/activate

Install the required packages with:

pip install -r requirements.txt

Run the model checker web server

python -m mc_openapi

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 tests

Run tests with:

python -m pytest

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 8080 of the container. To use it locally, you may bind it with port 8080 of localhost by adding -p 127.0.0.1:8080:8080/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. You can read the latest version at readthedocs.io

If you want to build the documentation manually, run:

cd docs
make html

The documentation will be generated in docs/_build.