Skip to content

Commit

Permalink
Update readme and project description.
Browse files Browse the repository at this point in the history
  • Loading branch information
daemontus committed Dec 21, 2021
1 parent f73cd86 commit 79d906d
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Biodivine BDD library (Python)

This repository contains simple Python bindings for the [Biodivine BDD library](https://github.com/sybila/biodivine-lib-bdd).
This repository contains simple Python bindings for the [Biodivine BDD library](https://github.com/sybila/biodivine-lib-bdd). It allows you to quickly create and manage binary decision diagrams from Python.

To install the bindings, use
To install the bindings, run

```
pip install biodivine_bdd
```
```

Other examples on how to use the Python bindings are available in this [jupyter notebook](https://deepnote.com/project/Aeonpy-Examples-CR33GbmyS2e4tqqZCcCwjA/%2Fexample_bdd.ipynb). Additional documentation is currently available only in the source code (or in the original Rust library), however the tutorial should hopefully cover most topics well. In case of any problems, do not hesitate to create an issue and get in touch.
5 changes: 4 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ build-backend = "maturin"

[project]
name = "biodivine-bdd"
version = "0.0.1"
repository = "https://github.com/sybila/biodivine-lib-bdd-py"
documentation = "https://deepnote.com/project/Aeonpy-Examples-CR33GbmyS2e4tqqZCcCwjA/%2Fexample_bdd.ipynb"
description = "Python bindings for the Biodivine Binary Decision Diagram library."
version = "0.0.2"
requires-python = ">=3.6"
classifiers = [
"Programming Language :: Rust",
Expand Down

0 comments on commit 79d906d

Please sign in to comment.