Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arc-hugo/debt_calculator
Implementation project of an algorithm computing the max-flow of a flow graph and apply it in a debt calculator app.
https://github.com/arc-hugo/debt_calculator
flow ford-fulkerson-algorithm functional-programming graph ocaml
Last synced: about 2 months ago
JSON representation
Implementation project of an algorithm computing the max-flow of a flow graph and apply it in a debt calculator app.
- Host: GitHub
- URL: https://github.com/arc-hugo/debt_calculator
- Owner: arc-hugo
- License: gpl-3.0
- Created: 2021-11-12T08:37:30.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-08T13:32:13.000Z (about 3 years ago)
- Last Synced: 2023-03-08T23:40:13.943Z (almost 2 years ago)
- Topics: flow, ford-fulkerson-algorithm, functional-programming, graph, ocaml
- Language: OCaml
- Homepage:
- Size: 68.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OCaml Graph Project : Debt calculator
Implementation project of an algorithm computing the max-flow of a flow graph and apply it in a debt calculator app.
Our application behavior is based on [this article](https://hackernoon.com/max-flow-algorithm-in-real-life-551ebd781b25).
## Requierements
- [opam](https://opam.ocaml.org/) package manager to install ocaml
- [dune](https://dune.build/) build system to build, test and execute this app
- [Graphviz](https://graphviz.org/) visualization software to generate image files from app results
## Getting started
### Installation
```bash
git clone https://github.com/arc-hugo/debt_calculator/
cd debt_calculator
dune build
```
### Test
```bash
dune test -f
```
### Usage
```bash
dune exec bin/debt.exe infile outfile
```
Given infile need to follow this format.
```
Name1 MoneyPaid1\n
Name2 MoneyPaid2\n
....
NameN MoneyPaidN
```
Resulting output file will be in [DOT language](https://www.graphviz.org/doc/info/lang.html).
It can then be converted in an image by the [dot layout engine](https://www.graphviz.org/docs/layouts/dot/) or an equivalent.
### Example
As an example, you can pick the [debt record](graphs/debt1) in graphs folder.
```
John 40
Kate 10
Ann 10
```
The resulting image will be this :
## Maintainers
- [Hugo Barral](https://github.com/arc-hugo/)
- [Aubry Dubois](https://github.com/adubois31/)