README.mkd 1.41 KB
Newer Older
1
# Biseau
Lucas Bourneuf's avatar
Lucas Bourneuf committed
2
Build by Input Some Easy ASP from User.
3 4

Helps the exploration of formal structures by using ASP as a DSL for drawing graphs.
5
For a Graphical User Interface, see the [biseau-gui](https://gitlab.inria.fr/lbourneu/biseau-gui) package.
6

Lucas Bourneuf's avatar
Lucas Bourneuf committed
7 8
For the initial version of biseau published in the
[FCA4AI'18 workshop](https://fca4ai.hse.ru/2018) at IJCAI,
9 10
see [the archived repository biseau-initial](https://gitlab.inria.fr/lbourneu/biseau-initial)

11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

## Principles

Now, you may want to read about:

- [visualization details](doc/user-doc.mkd#visualization-principles), that explains the theory behind the visualization itself.
- [visualization DSL](doc/user-doc.mkd#asp-to-dot), that explains which atoms produces which effect in visualization.
- [scripting](doc/user-doc.mkd#scripting), that allow you to implement new behavior for biseau.



## Installation
See [user documentation](doc/user-doc.mkd#installation) for details,
but in short, you need [clingo](https://potassco.org/clingo/),
[graphviz](http://graphviz.org/) and `make install-deps`.


## Usage
See [user documentation](doc/user-doc.mkd#basic-usage) for details.
See [`Makefile`](Makefile) for various recipes.
Running biseau can be done using the following commands:

33
    python -m biseau gui     # run the Graphical User Interface (if biseau-gui is installed)
34 35
    python -m biseau         # run the Command Line Interface
    python -m biseau --help  # get help for the CLI