1 unstable release

0.1.0 Aug 31, 2023

#247 in Science

MIT license

200KB
5K SLoC

sfs

sfs is a tool for creating and working with the site frequency spectra.

The README is currently under construction. Usage and examples will be added soon.

Contents

  1. Installation
    1. From source
      1. Latest release
      2. Current git
    2. Pre-built

Installation

From source

A recent Rust toolchain is required to build sfs from source. Currently, the Rust toolchain can be installed by running:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source $HOME/.cargo/env

See instructions for more details.

sfs can now be build from source, using either the latest released version, or the current git head, as described below.

Latest release

The following will install the latest released version of sfs:

cargo install sfs-cli

This will install the sfs binary to $HOME/.cargo/bin by default, which should be in the $PATH after installing cargo. Alternatively:

cargo install sfs-cli --root $HOME

Will install to $HOME/bin.

Current git

The latest git version may include more (potentially experimental) features, and can be installed using:

cargo install --git https://github.com/malthesr/sfs

Pre-built

Pre-built binaries are available from the releases page (linux, mac, windows).

Dependencies

~6MB
~118K SLoC