README.md 1013 Bytes
Newer Older
Hans-Peter Deifel's avatar
Hans-Peter Deifel committed
1
# CoPaR, the *Co*algebraic *Pa*rtition *Re*finer
Hans-Peter Deifel's avatar
Hans-Peter Deifel committed
2
3
4
5
6

## Building

    stack build

7
8
Alternatively, you can directly download the [latest binaries for linux](https://gitlab.cs.fau.de/i8/copar/-/jobs/artifacts/master/download?job=test).

Hans-Peter Deifel's avatar
Hans-Peter Deifel committed
9
10
11
12
13
## Running

There isn't much to see, yet. To see pretty printed parse results,
use:

Hans-Peter Deifel's avatar
Hans-Peter Deifel committed
14
    stack exec copar refine < FILENAME
Hans-Peter Deifel's avatar
Hans-Peter Deifel committed
15

Hans-Peter Deifel's avatar
Hans-Peter Deifel committed
16
17
Where `FILENAME` is a file describing the input. Examples are in
`examples/`.
18

Hans-Peter Deifel's avatar
Hans-Peter Deifel committed
19
Command line syntax is described in `stack exec -- copar --help`.
20

21
22
23
24
25
26
27
28
## Benchmarks

Extensive benchmarks of CoPaR on different input files can be found at
[gitlab.cs.fau.de/hpd/copar-benchmarks](https://gitlab.cs.fau.de/hpd/copar-benchmarks).

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

29
30
31
32
33
## 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
34
    stack haddock --open copar
35
36

This can help to understand the code structure.