Skip to content

Install

Check the requirements first if you have not, in particular that you are on Linux, and that conda is available.

1. Get PoolSeqFlow

curl -LO https://github.com/ozankiratli/PoolSeqFlow/releases/latest/download/PoolSeqFlow.tar.gz
tar -xzf PoolSeqFlow.tar.gz
cd PoolSeqFlow-*/

This is the recommended route. The archive is the pipeline, the analysis frame and this manual: no site sources, no CI config, no test suite, and no analysis modules. Every module is published on its own timetable and installed from the catalogue, so a new installation starts with an empty module store and you choose what goes into it. It extracts into a versioned directory, so you always know which release a working copy came from.

Verify it if you like: download SHA256SUMS from the same release and run sha256sum -c SHA256SUMS.

All releases

git clone https://github.com/ozankiratli/PoolSeqFlow.git
cd PoolSeqFlow
chmod +x PoolSeqFlow

Use this if you want to track development, work from a branch, or send a pull request. main is not guaranteed to be a released state, and the chmod is needed because a clone does not always preserve the executable bit; the release archive does.

2. Install it

./PoolSeqFlow install

This does several things:

  • It creates a conda environment named PoolSeqFlow-<version>.
  • It copies the pipeline itself to ~/.local/opt/PoolSeqFlow-<version>.
  • Commands are then linked into ~/.local/bin, each under two names:
  • PoolSeqFlow-<version>, which always means that exact release, and
  • plain PoolSeqFlow, which points at the newest version you have installed.
  • Releases install alongside each other rather than over each other, so an old project can keep running under the version that produced its results. A later one is installed the same way; see Upgrading.
  • PoolSeqFlow list shows what is installed; PoolSeqFlow uninstall removes one.

The analysis layer is reached through the same command but not installed by default. To install it:

PoolSeqFlow analysis install
  • This creates a conda environment named PoolSeqFlow-<version>-analysis.

To install somewhere else, such as a shared location for a group, set POOLSEQFLOW_PREFIX:

POOLSEQFLOW_PREFIX=/opt/shared ./PoolSeqFlow install

3. After the install

  • Make sure the bin directory it installed into is on your PATH: ~/.local/bin, or $POOLSEQFLOW_PREFIX/bin if you set one.
  • Installing takes a while the first time; later installs reuse the conda package cache.
  • It finishes by verifying itself and fails if anything is missing.

Once this is done the folder you downloaded has served its purpose. Everything from here uses the installed command, from your own project directory.

Tab completion

Installing writes a completion for each shell, under XDG_DATA_HOME or ~/.local/share:

~/.local/share/bash-completion/completions/PoolSeqFlow    for bash
~/.local/share/zsh/site-functions/_PoolSeqFlow            for zsh

The installer prints whichever of these applies to your shell:

  • bash needs nothing, as long as bash-completion is installed; that is what reads the directory. The installer checks and says which case you are in.
  • zsh needs one line in ~/.zshrc, before the line that runs compinit or sources oh-my-zsh, because every directory on its default $fpath belongs to root:

    fpath=(~/.local/share/zsh/site-functions $fpath)
    

Both complete every command, the two targets check takes, the analysis commands, and the modules that installation has in its store. analysis modules install <TAB> offers all and no module name, because those names come from the catalogue over the network. The zsh one also shows what each command is for.

They go with the last installed version removed; another version left installed keeps them.


Next

  • Set up your project and run it


    Make the project directory, fill in the three files that describe your data, and start the pipeline.

    Quick Start →

  • Coming from an earlier version


    Your existing parameters.config can be missing parameters the new code expects, and a project belongs to the release that produced its results.

    Upgrading →