README.md 1.27 KB
Newer Older
1
# CoPaR, the `Co`algebraic `Pa`rtition `R`efiner
2

Hans-Peter Deifel's avatar
Hans-Peter Deifel committed
3

4 5 6 7
## Building

    stack build

8
Alternatively, you can directly download the [latest binaries for
Thorsten Wißmann's avatar
Thorsten Wißmann committed
9
linux](https://git8.cs.fau.de/software/copar/-/jobs/artifacts/master/download?job=test).
10

11 12 13 14
Enabling the flag `benchmark-generators` also build generators and helper
executables used to create various benchmark suites that have been used in
different publications. To build with that flag, use the command `stack build
--flag copar:benchmark-generators`.
15

16
## Running
17

18
To partition states of a coalgebra specification, use the command
19

20 21 22
    stack exec -- copar refine FILENAME
    
Examples for input files are in the directory `examples/`.
23

Thorsten Wißmann's avatar
Thorsten Wißmann committed
24 25
Command line syntax is described in `copar --help` and the input
file syntax in `copar help`.
26

27 28 29
## Benchmarks

Extensive benchmarks of CoPaR on different input files can be found at
30
[git8.cs.fau.de/software/copar-benchmarks](https://git8.cs.fau.de/software/copar-benchmarks).
31 32 33 34

Micro-Benchmarks for internal data structures and routines are available in the
`bench/` directory and can be executed with `stack bench`.

35 36 37 38 39
## API documentation

The documentation for the internal API can be built and opened in the
default browser with:

Hans-Peter Deifel's avatar
Hans-Peter Deifel committed
40
    stack haddock --open copar
41 42

This can help to understand the code structure.