Metadata-Version: 1.1
Name: brainy-mind
Version: 0.1.12
Summary: brainy is a nimble workflow managing tool which is a part of iBRAIN framework for scientific computation primarily applied for BigData analysis in context of HPC and HTS
Home-page: https://github.com/pelkmanslab/brainy
Author: Yauhen Yakimovich
Author-email: yauhen.yakimovich@uzh.ch
License: MIT
Download-URL: https://github.com/pelkmanslab/brainy/tarball/master
Description: <p align="center"><img src="https://github.com/pelkmanslab/brainy/raw/master/ui/web/assets/images/brainy_logo.png" alt="logo" height="121" width="121"></p>
        
        ##About *brainy*
        
        *brainy* is a nimble workflow managing tool, at the core of [iBRAIN](https://github.com/pelkmanslab/iBRAIN/) functionality. It allows creation of projects according to the expected framework layout. It also oversees the execution of the projects and provides monitoring of any relevant progress of the conducted computation.
        
        ##iBRAIN
        
        iBRAIN is a software framework for scientific computation primarily applied for BigData extraction and analysis in context of HPC and HTS as well as large bioinformatical analysis.
        
        ##Documentation
        
        A really good place to understand what is `brainy` is to read the *user manual*:
        
          * [User manual](https://github.com/pelkmanslab/brainy/wiki/User-Manual)
          * [Developer Documentation](https://github.com/pelkmanslab/brainy/wiki/Developer-Documentation)
           
          > Tip: get help about the commands you need by saying `brainy help` or `brainy help project`
        
        
        ##Getting started
        
        Create you first project
        
        ```
        brainy create project PureAwesomeness --from demo
        ```
        
        Go inside the project folder and adjust settings in your pipelines. Afterwards run the project.
        
        ```
        cd PureAwesomeness
        # Adjust settings in .brainy <project settings> and hello.br <pipe description> YAML files
        brainy run project
        ```
        
        To see the report in your local web browser, do 
        ```
        brainy ui serve
        ```
        
        If things are looking good, continue by submitting your project into the *cloud*. Find out how to do this in the [Cloud](https://github.com/pelkmanslab/brainy/wiki/User-Manual#Cloud) section of the brainy's User Manual. 
        
        ##Installation
        
        > On Ubuntu (debian): sudo apt-get install python-setuptools git && sudo easy_install pip
        
        > On Mac: brew install libyaml
        
        >It is recommended to use [conda](http://conda.pydata.org/docs/) as python 2.7+ environment.
        
        The package is available on [PyPI](https://pypi.python.org/pypi/brainy-mind/).
        
        
        ```
        pip install brainy-mind
        ```
        
        For developer mode 
        
        ```
        cd && git clone https://github.com/pelkmanslab/brainy
        cd brainy && pip install -e .
        ```
        
        Once installed, inspect the state of configuration in `~/.brainy/` folder.
        
        Remember that you can generate `~/.brainy/config` from the template again by
        
        ```
        brainy init config
        ```
        
        You will have to edit the template that has been copied according to your cluster scheduler settings and so on.
        
        > Supported OS/platforms are **Linux** and **Mac OSX**.
        
        ##Tests
        
        To run nose tests navigate into
        
        ```
        cd tests && nosetests -s
        ```
        
Platform: Linux
Platform: OS-X
Classifier: Topic :: System :: Distributed Computing
Classifier: Topic :: Scientific/Engineering :: Image Recognition
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: System :: Emulators
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Programming Language :: Python
Classifier: Programming Language :: Unix Shell
Classifier: Programming Language :: Ruby
Classifier: Programming Language :: Java
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
