Skip to content

Latest commit

 

History

History
33 lines (30 loc) · 1.64 KB

building.md

File metadata and controls

33 lines (30 loc) · 1.64 KB

Installing Tachyon

Dependencies

You will need to have installed the following dependencies:

  • zstd: A compression library developed at Facebook
  • openssl: An open-source library for encryption/decryption
  • htslib: C library for high-throughput sequencing data formats

Building from source

If the required external dependencies listed above are installed then building is trivial. Note the added --recursive flag to the clone request. This flag is required to additionally pull down the latest third-party dependencies.

git clone --recursive https://github.com/mklarqvist/tachyon
cd tachyon
make

Installation

For Ubuntu, Debian, and Mac systems, installation is easy: just run

git clone --recursive https://github.com/mklarqvist/tachyon
cd tachyon
./install.sh

Note the added --recursive flag to the clone request. This flag is required to additionally pull down the latest third-party dependencies. The install.sh file depends extensively on apt-get, so it is unlikely to run without extensive modifications on non-Debian-based systems. If you do not have super-user (administrator) privileges required to install new packages on your system then run the local installation:

./install.sh local

When installing locally the required dependencies are downloaded and built in the current directory. This approach will require additional effort if you intend to move the compiled libraries to a different directory.