Shell bootloader for bioinformatics.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
functions Improve script to follow symlink Aug 29, 2018
login
profile
workflows
.gitignore
.travis.yml
LICENSE
README.md
koopa.sh

README.md

koopa 🐢

Build Status Project Status: Active – The project has reached a stable, usable state and is being actively developed.

Shell bootloader for bioinformatics.

Installation

Linux and macOS are currently supported. Koopa also integrates with schedulers in a high-performance computing (HPC) environment, including slurm and LSF, if they are available.

First, clone our git repository:

git clone https://github.com/steinbaugh/koopa.git ~/koopa

Then add these lines to your .bashrc file:

# koopa shell
# https://github.com/steinbaugh/koopa
if [[ -n "$PS1" ]] && [[ -f ~/koopa/koopa.sh ]]; then
    . ~/koopa/koopa.sh
fi

To also load koopa on a login node, we recommend symlinking your .bashrc file to .bash_profile:

ln -s ~/.bashrc ~/.bash_profile

Interactive session

To launch an interactive session, simply run:

koopa interactive -c <cores> -m <memory> -t <time>

For example, here's how to start an interactive session for 6 hours using 2 cores and 8 GB of RAM per core, on an HPC using the slurm scheduler:

koopa interactive -c 2 -m 8 -t 0-06:00