Move forward simulation to examples/. Closes #83 (#85)

Move simplification tests to this example, thus making
it an integration test.

Update GitHub actions.

Streamline Birth struct in forward_simulation.rs

Replace GSL with rand. Closes #80.

Author: molpopgen

.github/workflows/tests.yml

@@ -29,11 +29,12 @@ jobs:
           toolchain: ${{ matrix.rust }}
           override: true
       - run: cargo check
-      - name: run tests
-        run: cargo test
       - name: check examples
-        working-directory: forrustts_examples
-        run: cargo check
+        run: cargo check --examples
+      - name: run tests
+        run: | 
+            cargo test
+            cargo test --examples
 
   build-osx:
     runs-on: macos-latest
@@ -56,11 +57,12 @@ jobs:
           toolchain: ${{ matrix.rust }}
           override: true
       - run: cargo check
-      - name: run tests
-        run: cargo test 
       - name: check examples
-        working-directory: forrustts_examples
-        run: cargo check
+        run: cargo check --examples
+      - name: run tests
+        run: |
+            cargo test 
+            cargo test --examples
 
   fmt:
     name: rust fmt
@@ -88,9 +90,4 @@ jobs:
           override: true
       - run: rustup component add clippy
       - run: |
-          cargo clippy -- -D warnings
-      - run: |
-          cargo clippy --tests -- -D warnings
-      - name: Run clippy on the examples
-        working-directory: forrustts_examples
-        run: cargo clippy -- -D warnings
+          cargo clippy --all-targets -- -D warnings

Cargo.toml

@@ -14,5 +14,12 @@ keywords = ["simulation", "tree_sequences", "tskit", "population_genetics"]
 [dependencies]
 bitflags = "1.2.1"
 thiserror = "1.0"
-GSL = "4.0.0"
 tskit = "=0.2.0"
+
+[dev-dependencies]
+clap = "~2.27.0"
+rand = "0.8.3"
+rand_distr = "0.4.0"
+
+[[example]]
+name = "forward_simulation"

README.md

@@ -13,32 +13,26 @@ 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
+cargo build
+cargo test
 ```
 
-You may use `conda` or `brew` as you see fit.
-
-[Install rust](https://www.rust-lang.org/learn/get-started)
-
-Then:
+Example programs are in the subdirectory `examples/`:
 
 ```
-cargo build
-cargo test
+cargo build --examples
 ```
 
-Example programs are in the subdirectory `forrustts_examples`:
+The binaries will then be found in `target/debug/examples`.
+
+To build optimized examples:
 
 ```
-cd forrustts_examples
-cargo build --release
+cargo build --release --examples
 ```
 
-The binaries will then be found in `target/release/`.
+The binaries will then be found in `target/release/examples`.
 
 These programs use [clap](https://crates.io/crates/clap) for command-line options.
 Pass ``--help`` to any of them for usage information.