Skip to content
Snippets Groups Projects
Unverified Commit a6d09a01 authored by Andrea Franchini's avatar Andrea Franchini
Browse files

update readme and version

parent 198e0164
No related branches found
No related tags found
No related merge requests found
[![Documentation Status](https://readthedocs.org/projects/piacere-model-checker/badge/?version=latest)](https://piacere-model-checker.readthedocs.io/en/latest/?badge=latest) [![Documentation Status](https://readthedocs.org/projects/piacere-model-checker/badge/?version=latest)](https://piacere-model-checker.readthedocs.io/en/latest/?badge=latest)
# PIACERE Model Checker # PIACERE Model Checker
_______________________
## **You can read the [docs here](https://piacere-model-checker.readthedocs.io/en/latest/) for more details.** **📖 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 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 in charge of checking the correctness and consistency of
...@@ -15,7 +14,7 @@ in charge of checking the correctness and consistency of ...@@ -15,7 +14,7 @@ in charge of checking the correctness and consistency of
If you add a new package, regenerate it by running: If you add a new package, regenerate it by running:
```sh ```sh
poetry run pip freeze > requirements.txt pip freeze > requirements.txt
``` ```
## Setup ## Setup
...@@ -59,7 +58,7 @@ And then run it with ...@@ -59,7 +58,7 @@ And then run it with
docker run -d wp4/dmc docker run -d wp4/dmc
``` ```
The Uvicorn server will be running and listening on port 80 of the container. 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` To use it locally, you may bind it with port `8080` of `localhost`
by adding `-p 127.0.0.1:8080:80/tcp` to the `docker run` command. by adding `-p 127.0.0.1:8080:80/tcp` to the `docker run` command.
...@@ -67,10 +66,9 @@ by adding `-p 127.0.0.1:8080:80/tcp` to the `docker run` command. ...@@ -67,10 +66,9 @@ by adding `-p 127.0.0.1:8080:80/tcp` to the `docker run` command.
The documentation has been written in [Sphinx](https://www.sphinx-doc.org/) The documentation has been written in [Sphinx](https://www.sphinx-doc.org/)
and covers both usage through the PIACERE IDE and the REST APIs. and covers both usage through the PIACERE IDE and the REST APIs.
You can read the latest version at [readthedocs.io](https://piacere-model-checker.readthedocs.io/en/latest/)
Read it at [readthedocs.io](https://piacere-model-checker.readthedocs.io/en/latest/) If you want to build the documentation manually, run:
Build the documentation with:
```sh ```sh
cd docs cd docs
make html make html
......
__version__ = '1.2.0' __version__ = '2.1.0'
...@@ -60,9 +60,9 @@ def infer_domlx_version(raw_model: bytes) -> DOMLVersion: ...@@ -60,9 +60,9 @@ def infer_domlx_version(raw_model: bytes) -> DOMLVersion:
else: else:
raise RuntimeError(f"Supplied with DOMLX model of unsupported version {v_str}") raise RuntimeError(f"Supplied with DOMLX model of unsupported version {v_str}")
else: else:
return DOMLVersion.V2_0 # Should be DOMLVersion.V1_0, but we use V2_0 because the 2.0 IDE doesn't fill it return DOMLVersion.V2_0 # Should be DOMLVersion.V1_0, but we use V2_0 because the 2.1 IDE doesn't fill it
else: else:
raise RuntimeError("Supplied with malformed DOMLX model.") raise RuntimeError(f"Supplied with malformed DOMLX model or unsupported DOML version.\nIn use version is: {DOMLVersion.V2_1}")
def parse_doml_model(raw_model: bytes, doml_version: Optional[DOMLVersion]) -> Tuple[IntermediateModel, DOMLVersion]: def parse_doml_model(raw_model: bytes, doml_version: Optional[DOMLVersion]) -> Tuple[IntermediateModel, DOMLVersion]:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment