pyctbn-benchmarks/README.md

# pyCTBN - Benchmarks

This benchmark is tailored to work with the "modernized" and polished version
of `pyCTBN`.

## Preparation

To clone with all submodules:

```sh
git clone --recursive git@git-service.tld:user/repo.git
```

If you cloned without `--recursive`, you probably want to initialize the
submodules:

```sh
git submodule update --init --recursive
```

Create a virtual environment:

```sh
python3 -m venv .venv && source .venv/bin/activate
```

Install the dependencies:

```sh
pip3 install -r requirements.txt
```

## Usage

Create a `networks.d` directory in this project workspace.

Move the `json` files of the networks in the just created `networks.d`
directory.

Execute the shell script `./run.sh` to run the tests contained in the
`networks.d` directory:

```sh
./run.sh
```

To learn to use directly the benchmark program:

```sh
./benchmark.py --help
```