Conda is a package manager application that quickly installs, runs, and updates packages and their dependencies. It is designed to be Python agnostic and to manage complex dependencies. It can essentially handle any type of packages and their dependencies in an isolated virtual environment.
This repository hosts conda recipes for various biocore packages or dependencies. The idea is to make bioinformatics tools readily installable and host them on anaconda cloud.
This will make software installation much easier for users with or without much command line experience.
Currently, the following packages (and their versions) are built and available on the anaconda organization named biocore:
To install a package, you just need to run:
conda install -c https://conda.anaconda.org/biocore <package-name>
No endless headache of time-consuming compilation and missing dependecies any more!
To add a new package to the pool, you need to create a recipe to tell conda how to build it.
How to create a recipe is documented on conda's website.
You can also borrow from the examples located in this repository: recipes. There are also lots of examples in conda's conda-recipes repository.
If you modified an existing recipe in this repository and would like to merge it back, you should increment the build number by one in order to trigger a package rebuild. This is not necessary if the package version is changing, and you will need to add the build number section to the meta.yaml
file if it doesn't already exist.
For example, if the current recipe has this in the meta.yaml
:
build:
number: 1
you should change it to the following after you modify it:
build:
number: 2
If there is no such section in meta.yaml
, the build number defaults to zero. You should set it to 1 after modifying it. Please see the documentation here
You need to install the following mandatory toolset before building a package.
conda install anaconda-client
conda install conda-build
Once you install the toolset and create your recipe, you can build the package with the following command:
conda build <recipe-directory>
Please see the conda build docs for further information.
To upload your built package to anaconda for others to download and install, you need to create an account here.
You will need to login with your account credentials you just created:
anaconda login
And use this command to upload:
anaconda upload <path-to-your-conda-package.tar.bz2>
You can find the path to the built package with following commands:
cd <recipe-directory>
conda build . --output
Now other people can download and install your package (given it is public):
conda install -c <your-channel> <package-name>
We encourage you to add your new recipe into this repo. Each recipe should be in its own directory under recipes. Once you issue a pull request to merge your recipe into this repo, a Travis continuous integration (CI) will run and test your recipe by building the package and uploading it to biocore. If the Travis build succeeds, congrats! Your package will be available to download and install from biocore.