Installation

BSBolt and dependencies need to be compiled during the installation process. Pre-compiled binaries are available for macOS >= 10.15 and linux distributions released after 2010 according to the manylinux2010 python enhancement proposal. If a precompiled binary is unavailable for the target OS, binaries will be built from source. Compilation on macOS requires xcode-command line utilities and autoconf.

PyPi Installation

The easiest installation method is installing pre-compiled binaries using PyPi. Binaries are available for python >=3.6 on unix like systems (macOS and linux).

pip3 install bsbolt --user

Conda Installation

BSBolt can be installed using the conda package manager using the instructions below.

conda config --add channels bioconda
conda config --add channels conda-forge
conda install -c cpfarrell bsbolt

Installing from Source

Dependencies

• zlib-devel >= 1.2.3-29
• GCC >= 8.3.1

# clone the repository
git clone https://github.com/NuttyLogic/BSBolt.git
cd BSBolt
# compile and install package
pip3 install .

Installing from Source on macOS

Dependencies * autoconf * homebrew * xcode

Installation from source requires xcode command line utilities, homebrew macOS package manager, autoconf, python (>=3.6), and automake.The full installation process is outlined below.

# install xcode utilities
xcode-select --install
# install homebrew
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
# install autoconf
brew install autoconf
# install automake
brew install automake
# optionally install python >= 3.6
brew install python3.8
# clone the repository
git clone https://github.com/NuttyLogic/BSBolt.git
cd bsbolt
# compile and install package
pip3 install -e .