From 774a19f68941b5e182c1d30d9fbb982c693efde5 Mon Sep 17 00:00:00 2001 From: ZhuBry Date: Thu, 1 Feb 2024 10:02:28 -0500 Subject: [PATCH] updated prerequisites --- website/docs/getting_started.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/website/docs/getting_started.md b/website/docs/getting_started.md index b77f3aaa..c6b3bc12 100644 --- a/website/docs/getting_started.md +++ b/website/docs/getting_started.md @@ -29,24 +29,29 @@ To check for a successful install: lancet2 --version ``` -### Requirements & Dependencies +### Prerequisites to compile from source -* CMake >= 3.14.x -* C++ compiler with support for ISO C++17 standard -* zlib, bzip2, liblzma, cURL and OpenSSL (Needed to build htslib) +* Linux +* x86-64 +* CMake (3.25 or greater) +* GCC (12.x or greater) +* BZip2 +* LibLZMA +* Git +* Make ### Docker Pre-built docker images for Lancet2 are available [here](https://console.cloud.google.com/artifacts/docker/nygc-app-c-148c/us-central1/lancet-public/lancet). Note that the public docker image requires [Cascade Lake CPU](https://en.wikichip.org/wiki/intel/microarchitectures/cascade_lake) or newer -You can also build a new image from the Dockerfile provided in the repository: +You can also build a new image from the Dockerfile provided in the repository. ## Basic Usage Here is a basic run of the Lancet tool from the newly created build directory: ```bash -lancet2 pipeline \ +Lancet2 pipeline \ -t /path/to/tumor.bam \ -n /path/to/normal.bam \ -r /path/to/ref.fasta \