forrustts 0.1.0

Tools for forward simulation with tree sequence recording
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

# Forward simulation with tree sequence recording in rust

This package is currently "experimental"!

`forrustts` (pronounced "forests") is a port of many ideas from the [fwdpp](https://github.com/molpopgen/fwdpp) library from C++ to rust.

It is licensed under the GNU General Public License, version 3 or later ("GPL3+").

## Getting started

Install the GNU Scientific Library.
For example:

```
apt install libgsl-dev
```

You may use `conda` or `brew` as you see fit.

[Install rust](https://www.rust-lang.org/learn/get-started)

Then:

```
cargo build
cargo test
```

Example programs are in the subdirectory `forrustts_examples`:

```
cd forrustts_examples
cargo build --release
```

The binaries will then be found in `target/release/`.

These programs use [clap](https://crates.io/crates/clap) for command-line options.
Pass ``--help`` to any of them for usage information.

## Development information

## CI

CI testing is done using GitHub actions for both `Linux` and `macOS`.
These actions include using [clippy](https://crates.io/crates/clippy/0.0.211), which is a very strict code linter.
The actions also check code format using [rustfmt](https://crates.io/crates/rustfmt-nightly).

### Code coverage

Use [tarpaulin](https://docs.rs/crate/cargo-tarpaulin/0.3.12).
The documentation for that crate is excellent.
The short version is:

```
cargo tarpaulin -o html
```

This command will run the tests and generate a nice `html` report.