Metadata-Version: 1.0
Name: simplefsapp-moc
Version: 1.0.2
Summary: A demo/testing simplefsapp for the MOC compute environment.
Home-page: http://wiki
Author: FNNDSC
Author-email: dev@babyMRI.org
License: MIT
Description: pl-simplefsapp_moc
        ================================
        
        .. image:: https://badge.fury.io/py/simplefsapp_moc.svg
            :target: https://badge.fury.io/py/simplefsapp_moc
        
        .. image:: https://travis-ci.org/FNNDSC/simplefsapp_moc.svg?branch=master
            :target: https://travis-ci.org/FNNDSC/simplefsapp_moc
        
        .. image:: https://img.shields.io/badge/python-3.5%2B-blue.svg
            :target: https://badge.fury.io/py/pl-simplefsapp_moc
        
        .. contents:: Table of Contents
        
        
        Abstract
        --------
        
        A demo/testing simplefsapp for the MOC compute environment.
        
        
        Synopsis
        --------
        
        .. code::
        
            python simplefsapp_moc.py                                       \
                [-v <level>] [--verbosity <level>]                          \
                [--version]                                                 \
                [--man]                                                     \
                [--meta]                                                    \
                <outputDir> 
        
        
        Description
        ------------
        
        
        `simplefsapp_moc.py` is a testing/demo application for an FS-type application on the Massachusetts Open Cloud (MOC) remote computing environment.
        
        The application simply "touches" new files in its output directory which are the names of the files in the '--dir <path>' target  directory.
        
        Arguments
        ---------
        
        .. code::
        
            [-v <level>] [--verbosity <level>]
            Verbosity level for app. Not used currently.
        
            [--version]
            If specified, print version number. 
                
            [--man]
            If specified, print (this) man page.
        
            [--meta]
            If specified, print plugin meta data.
        
            [--dir <path>]
            A directory on the process filesystem (if run outside ChRIS) or a 
            path inside openstorage (if run within ChRIS) to examine.
        
            [--sleepLength <sleepLength>]
            If specified, sleep for <sleepLength> seconds before starting
            script processing. This is to simulate a possibly long running 
            process.
        
        Run
        ----
        
        This ``plugin`` can be run in two modes: natively as a python package or as a containerized docker image.
        
        Using PyPI
        ~~~~~~~~~~
        
        To run from PyPI, simply do a 
        
        .. code:: bash
        
            pip install simplefsapp_moc
        
        and run with
        
        .. code:: bash
        
            simplefsapp_moc.py --man /tmp
        
        to get inline help. The app should also understand being called with only two positional arguments
        
        .. code:: bash
        
            simplefsapp_moc.py /destination/directory
        
        
        Using ``docker run``
        ~~~~~~~~~~~~~~~~~~~~
        
        To run using ``docker``, be sure to assign an output directory to ``/outgoing``. *Make sure that the* ``$(pwd)/out`` *directory is world writable!*
        
        Now, prefix all calls with 
        
        .. code:: bash
        
            docker run --rm -v $(pwd)/out:/outgoing                             \
                    fnndsc/pl-simplefsapp_moc simplefsapp_moc.py                        \
        
        Thus, getting inline help is:
        
        .. code:: bash
        
            mkdir in out && chmod 777 out
            docker run --rm -v $(pwd)/in:/incoming -v $(pwd)/out:/outgoing      \
                    fnndsc/pl-simplefsapp_moc simplefsapp_moc.py                        \
                    --man                                                       \
                    /outgoing
        
        Examples
        --------
        
        
        
        
        
        
Platform: UNKNOWN
