Skip to content

Commit b8575a2

Browse files
committed
Update instructions, add link to Sketchbook.
1 parent b8fd42c commit b8575a2

File tree

2 files changed

+22
-11
lines changed

2 files changed

+22
-11
lines changed

README.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,31 @@
11
# Boolean Network Sketches: A Unifying Framework for Logical Model Inference
22

3-
This is a small Rust library focusing on logical model inference through Boolean network sketches, as described in our [paper](https://doi.org/10.1093/bioinformatics/btad158).
4-
The repository contains the high-level implementation of the framework, as well as benchmark models and data used for experiments and case studies.
3+
This is a small Rust library focusing on logical model inference through Boolean network sketches, as described in our Bioinformatics [paper](https://doi.org/10.1093/bioinformatics/btad158).
4+
This repository includes a prototype implementation of the framework, alongside benchmark models and data used for experiments and case studies.
5+
**See the following section on Sketchbook**, a production-ready desktop tool that fully implements our BN inference method.
6+
57
This readme describes the repository contents and also contains instructions on how to replicate the main experimental results of the paper.
68
The whole repository is available at [github](https://github.com/sybila/boolean-network-sketches), as well as at [zenodo](https://doi.org/10.5281/zenodo.7688740).
79

8-
This repository contains a newer release of the framework.
9-
The original release corresponding to the artefact of the paper can be downloaded [here](https://github.com/sybila/boolean-network-sketches/releases/tag/v0.1.0).
10+
> Also note that this repository currently contains an updated version of the original prototype. The initial release corresponding to the artefact of the paper can be downloaded [here](https://github.com/sybila/boolean-network-sketches/releases/tag/v0.1.0). The assets contain original source code, benchmarks, and correspoding setup instructions.
11+
12+
### Use our new tool Sketchbook!
13+
14+
This repository contains a prototype version of the Boolean Network Sketches framework, developed in 2022.
15+
Since then, we’ve implemented the full inference method in a production-ready desktop tool, called **Sketchbook**.
16+
Sketchbook features a user-friendly graphical interface for designing Boolean network sketches and computing all admissible BNs.
17+
You can find the latest version of Sketchbook at [this Github repository](https://github.com/sybila/biodivine-sketchbook). See the example screenshot below for an illustration of the interface:
18+
19+
<img src="sketchbook.jpeg" alt="sketchook-screenshot" width="650"/>
20+
1021

1122
## Setup
1223

13-
To run the experiments, you will need the Rust compiler.
24+
To run the experiments in this repository, you will need the Rust compiler.
1425
We recommend following the official instructions at [rustlang.org](https://www.rust-lang.org/learn/get-started) (default configuration should be sufficient) instead of using a package manager.
1526
However, either method should work fine.
1627
When using the official installer, everything is stored in `~/.cargo`, so admin privileges are not necessary.
17-
The tested version of Rust is `1.64` (Sep 2022).
28+
The current version of the repository was tested with Rust `1.64` (April 2025).
1829
Rust will automatically download and cache all other libraries necessary to compile the project.
1930
You should therefore have internet access while running the commands for the first time.
2031
You can force rust do download all dependencies by running `cargo fetch`.
@@ -110,7 +121,7 @@ All displayed computation times were acquired on a standard laptop with an 11th
110121
Follow the instructions in section `Setup` to install the Rust compiler.
111122
Once you are done with the experimenting, you can uninstall the compiler by running `rustup self uninstall`.
112123

113-
For convenience, we have prepared Bash scripts to wrap all the commands needed. If you want to use them, you will need a Unix-based system with Bash.
124+
For convenience, we have prepared Bash or Python scripts to wrap all the commands needed. If you want to use the scripts, you will need a Unix-based system with Bash.
114125
On Windows, it should be sufficient to use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) (we have tested the Ubuntu-20.04 WSL).
115126
However, note that these scripts are not needed, as you can execute the Rust code directly (as described below).
116127

@@ -149,9 +160,8 @@ bash ./run_scalability_benchmarks.sh
149160
bash ./run_all_experiments.sh
150161
```
151162

152-
The scripts should work on any classical Unix-based system, and we have also tested them on Windows Subsystem for Linux (WSL), particularly on Ubuntu-20.04 WSL.
153-
If you have a Unix-based system but have a problem running Bash scripts, you can try the Python version of the encompassing script.
154-
You will need a Python 3 (we have used Python 3.8 and 3.10).
163+
The scripts should work on any classical Unix-based system, and we have also tested them on Windows Subsystem for Linux (WSL), particularly on the Ubuntu distribution.
164+
If you have a Unix-based system but have a problem running Bash scripts, you can try the Python version of the encompassing script (you will need a Python 3).
155165

156166
```
157167
python3 run_all_experiments.py
@@ -203,4 +213,5 @@ The implementation itself is fairly minimal (includes i.e., high-level framework
203213

204214
Everything is open-source and available with the permissive MIT License.
205215

206-
To visualize and modify the partially specified BN models (aeon files) included in this repository, you can use the online interface of our tool [AEON](https://biodivine.fi.muni.cz/aeon). This tool can also be used to further analyse the attractors of Boolean network models.
216+
You can find the latest version of our desktop inference tool Sketchbook at [this Github repository](https://github.com/sybila/biodivine-sketchbook), as described above.
217+
To visualize and modify the partially specified BN models (aeon files) included in this repository, you can also use the online interface of our tool [AEON](https://biodivine.fi.muni.cz/aeon). This tool can also be used to further analyse the attractors of Boolean network models.

sketchbook.jpeg

127 KB
Loading

0 commit comments

Comments
 (0)