**📖 You can read the [docs here](https://piacere-model-checker.readthedocs.io/en/latest/) for more details. 📖**
The DOML Model Checker is a component of the [PIACERE](https://www.piacere-project.eu/) framework in charge of checking the correctness and consistency of [DOML](https://www.piacere-doml.deib.polimi.it/) models.
The DOML Model Checker is a component of the [PIACERE](https://www.piacere-project.eu/) framework
in charge of checking the correctness and consistency of
It consists of a web server exposing a REST API that receives a DOML model in XMI format (also called DOMLX) and provides as output a result detailing whether the model satisfies a set of internal requirements, and in case of negative results, what elements are in violation and how to fix the issue.
It also bundles a Cloud Service Provider (CSP) Compatibility tool that can provide the compatibility results of a model against common Cloud Service Providers.
We provide a `requirements.txt` file for CI/CD purposes.
## Installation
If you add a new package, regenerate it by running:
```sh
pip freeze > requirements.txt
```
## Setup
### Setup
Activate the Python Virtual Environment with:
```sh
...
...
@@ -28,26 +22,25 @@ Install the required packages with:
pip install-r requirements.txt
```
## Run the model checker web server
### Run the model checker web server
```sh
python -m mc_openapi
```
## Run with Uvicorn
### Run with Uvicorn
The project may be run with [Uvicorn](https://www.uvicorn.org/) as follows: