<commit_before>## Coracle

Welcome to Coracle, a consensus algorithm simulator for heterogeneous networks.

______

#### Installation

Compile from source as follows:

```
# get source & deps
git clone https://github.com/heidi-ann/coracle
opam install cstruct ipaddr lwt sexplib
cd coracle
# build
ocaml setup.ml -configure
ocaml setup.ml -build
ocaml setup.ml -install
```

______

#### Usage<commit_msg>tidying install instructions:<commit_after>## Coracle

Welcome to Coracle, a consensus algorithm simulator for heterogeneous networks.

______

#### Installation

Start off by installing OPAM/OCaml, here's some helpful links:
* https://opam.ocaml.org/doc/Install.html
* https://github.com/realworldocaml/book/wiki/Installation-Instructions

Using OPAM we can get the project dependencies:
```
opam update
opam upgrade
opam install cstruct ipaddr lwt sexplib
```

Compile from source as follows:

```
git clone https://github.com/heidi-ann/coracle
cd coracle

ocaml setup.ml -configure
ocaml setup.ml -build
ocaml setup.ml -install
```

______

#### Usage
{'fraction_non_alphanumeric': 0.09820585457979225, 'fraction_numerical': 0.0, 'mean_word_length': 4.760869565217392, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1389783', 'n_tokens_mistral': 342, 'n_tokens_neox': 322, 'n_words': 106}