Metadata-Version: 1.1
Name: chmutil
Version: 0.5.0
Summary: Utility package to run CHM jobs on clusters
Home-page: https://github.com/CRBS/chmutil
Author: Christopher Churas
Author-email: churas@ncmir.ucsd.edu
License: UNKNOWN
Description: ===============================
        chmutil
        ===============================
        
        
        
        .. image:: https://pyup.io/repos/github/coleslaw481/chmutil/shield.svg
             :target: https://pyup.io/repos/github/coleslaw481/chmutil/
             :alt: Updates
        
        .. image:: https://travis-ci.org/CRBS/chmutil.svg?branch=master
               :target: https://travis-ci.org/CRBS/chmutil
        
        .. image:: https://coveralls.io/repos/github/CRBS/chmutil/badge.svg?branch=master
           :target: https://coveralls.io/github/CRBS/chmutil?branch=master
        
        Utility package to run `Cascaded Hierarchical Model (CHM) <https://www.sci.utah.edu/software/chm.html>`_ jobs on clusters.
        
        `For more information visit our wiki page <https://github.com/CRBS/chmutil/wiki>`_
        
        Tools
        --------
        
        * **chmrunner.py** -- Runs CHM job with specific jobid
        
        * **createchmjob.py** -- Creates a set of CHM jobs to process a set of images
        
        * **checkchmjob.py** -- Generates script that can be used to run CHM jobs created by **createchmjob.py** on various compute clusters (Gordon, Comet, & Rocce)
        
        
        Dependencies
        --------------
        
        * `argparse <https://pypi.python.org/pypi/argparse>`_
        
        * `configparser <https://pypi.python.org/pypi/configparser>`_
        
        * `Pillow <https://pypi.python.org/pypi/Pillow>`_
        
        * `CHM singularity image <https://github.com/crbs/chm_singularity>`_ (not required to build this software, but is needed to run the jobs)
        
        Compatibility
        -------------
        
        * Should work on Python 2.7 & 3+ on Linux distributions
        
        Installation
        ------------
        
        Try one of these:
        
        ::
        
          pip install chmutil
        
        Usage
        --------
        
        ::
        
          # creates a job assuming images are in ./images and ./trainedmodel has
          # chm model
          createchmjob.py ./images ./trainedmodel myrun --cluster rocce
        
        License
        -------
        
        See LICENSE.txt_
        
        
        Bugs
        -----
        
        Please report them `here <https://github.com/CRBS/chmutil/issues>`_
        
        
        Credits
        ---------
        
        This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        .. _NCMIR: https://ncmir.ucsd.edu/
        .. _LICENSE.txt: https://github.com/CRBS/chmutil/blob/master/LICENSE.txt
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        
        
        =======
        History
        =======
        
        0.5.0 (2017-01-11)
        ------------------
        
        * First release on PyPI.
        
        
Keywords: chmutil
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
