Metadata-Version: 1.1
Name: birdhousebuilder.recipe.conda
Version: 0.2.4
Summary: A Buildout recipe to install anaconda packages
Home-page: https://github.com/bird-house/birdhousebuilder.recipe.conda
Author: Birdhouse
Author-email: UNKNOWN
License: BSD
Description: *****************************
        birdhousebuilder.recipe.conda
        *****************************
        
        .. contents::
        
        Introduction
        ************
        
        ``birdhousebuilder.recipe.conda`` is a `Buildout`_ recipe to install `Anaconda`_ packages. This recipe is used by the `Birdhouse`_ project. 
        
        .. _`Buildout`: http://buildout.org/
        .. _`Anaconda`: http://www.continuum.io/
        .. _`Birdhouse`: http://bird-house.github.io/
        
        Usage
        *****
        
        The recipe requires that Anaconda is already installed. It assumes that the default Anaconda location is in your home directory ``~/anaconda``. Otherwise you need to set the ``ANACONDA_HOME`` environment variable.
        
        
        Supported options
        =================
        
        This recipe supports the following options:
        
        ``anaconda-home``
           Buildout option with the root folder of the Anaconda installation. Default: ``$HOME/anaconda``.
           The default location can also be set with the environment variable ``ANACONDA_HOME``. Example::
        
             export ANACONDA_HOME=/opt/anaconda
        
           Search priority is:
        
           1. ``anaconda-home`` in ``buildout.cfg``
           2. ``$ANACONDA_HOME``
           3. ``$HOME/anaconda``
          
        ``conda-channels``
           Buildout option (optional) with additional channels of conda packages. 
          
        ``pkgs``
           A list of packages to install separated by space.
        
        ``channels``
           A list of space separated conda channels (optional). These channels are merged with conda-channels option.
        
        ``env``
           Name of conda environment used for installation (optional). If environment is missing then all packages are installed in the birdhouse environment (``birdhouse``).
        
        ``default-pkgs``
           A list of packages to install when creating environment separated by space (optional). Default: ``python``
        
        ``on-update``
           If set to false conda will not check for updates when running buildout update. Default: ``false``.
        
        Example usage
        =============
        
        The following example ``buildout.cfg`` installs the conda packages lxml, nose and matplotlib::
        
          [buildout]
          parts = conda_pkgs
        
          conda-channels = birdhouse
        
          [conda_pkgs]
          recipe = birdhousebuilder.recipe.conda
          pkgs = lxml nose matplotlib owslib
          channels = birdhouse asmeurer
          env = mytest
          default-pkgs = python
          on-update = false
        
        
        Authors
        *******
        
        Carsten Ehbrecht ehbrecht at dkrz.de
        
        Changes
        *******
        
        0.2.4444 (2015-08-05)
        ==================
        
        * use CONDA_ENVS_DIR to overwrite base dir of conda environments. 
        
        0.2.2 (2015-02-25)
        ==================
        
        * sets buildout:prefix option as installation default directory for birdhouse.
        
        0.2.1 (2015-02-24)
        ==================
        
        * setting ``anaconda-home`` with environment variable ``$ANACONDA_HOME``.
        * separation of install prefix and anaconda-home.
        
        0.2.0 (2015-02-23)
        ==================
        
        * conda environments can be created now.
        * added channels option.
        
        0.1.4 (2015-01-09)
        ==================
        
        * added https://conda.binstar.org/birdhouse to default channels.
        
        0.1.3 (2015-01-08)
        ==================
        
        * added https://conda.binstar.org/scitools to default channels.
        
        0.1.2 (2014-12-02)
        ==================
        
        * added on on-update buildout option. 
        
        0.1.1 (2014-07-31)
        ==================
        
        * Updated documentation.
        
        0.1.0 (2014-07-10)
        ==================
        
        * Initial Release.
        
Keywords: buildout recipe conda anaconda birdhouse
Platform: UNKNOWN
Classifier: Framework :: Buildout
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: BSD License
