11# Portello user guide
22
3+ ## Table of Contents
4+
5+ * [ Overview] ( #overview )
6+ * [ Getting started] ( #getting-started )
7+ * [ Inputs] ( #inputs )
8+ * [ Outputs] ( #outputs )
9+ * [ Other Notes] ( #other-notes )
10+
311## Overview
412
513Portello is a method to liftover reads from sample assembly to reference
@@ -14,7 +22,36 @@ The expected workflow to use it is:
1422- Align sample reads directly to consolidated assembly contigs using pbmm2
1523- Run portello on the above two alignment outputs to lift sample read mappings from the assembly to the reference.
1624
17- ## Usage Example:
25+ ## Getting Started
26+
27+ ### Installation
28+
29+ Portello binaries are available for 64-bit Linux platforms. These can be installed either directly from the GitHub
30+ release tarball, or via conda as described below.
31+
32+ #### Install from GitHub
33+
34+ To install portello from github, download the latest release tarball compiled for 64-bit Linux on the [ github release
35+ channel] ( https://github.com/PacificBiosciences/portello/releases/latest ) , then unpack the tar file. Using v0.6.1 as an
36+ example, the tar file can be downloaded and unpacked as follows:
37+
38+ wget https://github.com/PacificBiosciences/portello/releases/download/v0.6.1/portello-v0.6.1-x86_64-unknown-linux-gnu.tar.gz
39+ tar -xzf portello-v0.6.1-x86_64-unknown-linux-gnu.tar.gz
40+
41+ The portello binary is found in the ` bin/ ` directory of the unpacked file distribution. This can be run with the help
42+ option to test the binary and review latest usage details:
43+
44+ portello-v0.6.1-x86_64-unknown-linux-gnu/bin/portello --help
45+
46+ #### Install from conda
47+
48+ For [ conda] ( https://github.com/conda/conda ) users, installing portello on conda may be a more convenient option. Portello
49+ is available for conda on Linux from the ` bioconda ` channel. A new conda environment with the latest portello release can
50+ be created as follows:
51+
52+ conda create -n portello -c bioconda portello
53+
54+ ### Usage Example
1855
1956Portello requires a reference genome and two alignment file inputs:
20571 . Assembly contig to reference alignments
@@ -170,7 +207,6 @@ typically created by minimap2 at regions meeting its Z-drop criteria indicating
170207reference. Note that due to this joining step, the 'split read index' shown in the portello ` PS ` tag output refers to
171208the index of the joined split alignment segments.
172209
173-
174210### MAPQ
175211
176212The MAPQ value of liftover read alignment segments is taken form the contig split alignment segment that that read
0 commit comments