Skip to content

Commit

Permalink
doc: Source-sink mention in README
Browse files Browse the repository at this point in the history
  • Loading branch information
Ondrej DRAGANOV committed Jun 18, 2024
1 parent 3a6195b commit e169bf5
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ In the notebook, you will find how to:

Additionally, we provide some **visualization** features for the quiver and its intervals.

By default "total (tot)" compression system is used. To use "source-sink (ss)" insted, add a `compression` argument: `L.int_replacement(interval, compression='ss')`.

## Installation

This implementation is built from scratch and does not depend on any external Python libraries, except NumPy and IPython for visualization purpose in the tutorial. You can install them with `pip` by running the following commands:
Expand Down

0 comments on commit e169bf5

Please sign in to comment.