Skip to content

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
daemontus committed Sep 16, 2024
1 parent b7b3f92 commit 7b1473f
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,14 @@ fn should_log(log_level: usize) -> bool {
log_level > LOG_NOTHING
}

/// AEON.py is a library...
/// AEON.py is a Python library for working with Boolean networks. It supports a wide
/// range of features, including symbolic representation of network dynamics. More general
/// information is available on [GitHub](https://github.com/sybila/biodivine-aeon-py/).
///
/// To explore the library documentation, you can start with one of the core data classes:
/// `RegulatoryGraph`, `BooleanNetwork` and `AsynchronousGraph`. Alternatively, to learn more about the available
/// algorithms, you may want to look at `Attractors`, `TrapSpaces`, `FixedPoints`, `Classification`,
/// or `Control`.
#[pymodule]
fn biodivine_aeon(py: Python, module: &Bound<'_, PyModule>) -> PyResult<()> {
set_log_level(py, module)?;
Expand Down

0 comments on commit 7b1473f

Please sign in to comment.