Installation

ncfp can be installed in any of several ways.

Using pip

The most recent release of ncfp is available at the PyPI warehouse, and can be installed using pip:

pip install ncfp

Using bioconda

ncfp is available through the bioconda channel of the conda package management system. To install ncfp, you will need Anaconda or miniconda, and to set up the bioconda channel. Then you can use the conda install ncfp command to install the package:

conda install -c bioconda ncfp

Alternatively:

conda config --add channels defaults
conda config --add channels conda-forge
conda config --add channels bioconda
conda install ncfp

From source (most recent release)

ncfp releases are available at the GitHub releases page. To install from source:

  1. Download the .tar.gz or .zip file containing the package (click the link, use curl or wget).
  2. Uncompress the archive.
  3. Change to the newly-expanded directory.
  4. Install Python module requirements with pip.
  5. Install ncfp with setup.py
$ wget https://github.com/widdowquinn/ncfp/archive/v0.2.0.tar.gz
$ tar -zxvf v0.2.0.tar.gz
$ cd ncfp
$ pip install -r requirements.txt
$ python setup.py install

From source (bleeding edge)

To get the very latest development version of ncfp, you can clone the repository from the GitHub project page

  1. Clone the repository from git@github.com:widdowquinn/ncfp.git
  2. Change to the repository root directory.
  3. Install Python module requirements with pip.
  4. Install ncfp with setup.py
$ git clone git@github.com:widdowquinn/ncfp.git
$ cd ncfp
$ pip install -r requirements.txt
$ pip install -e .  # for development installation
$ python setup.py install  # for installation as a package/script