Sign inSign up

fnndsc/pl-sys_info

By fnndsc

•Updated almost 5 years ago

An app to display systen information

Image
Networking
Operating systems
Monitoring & observability
0

6.9K

fnndsc/pl-sys_info repository overview

⁠pl-sys_info

.. image:: https://img.shields.io/docker/v/fnndsc/pl-sys_info?sort=semver⁠ :target: https://hub.docker.com/r/fnndsc/pl-sys_info⁠

.. image:: https://img.shields.io/github/license/fnndsc/pl-sys_info⁠ :target: https://github.com/FNNDSC/pl-sys_info/blob/master/LICENSE⁠

.. image:: https://github.com/FNNDSC/pl-sys_info/workflows/ci/badge.svg⁠ :target: https://github.com/FNNDSC/pl-sys_info/actions⁠

.. contents:: Table of Contents

⁠Abstract

An app to display systen information

⁠Description

sys_info is a ChRIS ds-type application that takes in ... as ... files and produces ...

⁠Usage

.. code::

docker run --rm fnndsc/pl-sys_info sys_info
    [-h|--help]
    [--json] [--man] [--meta]
    [--savejson <DIR>]
    [-v|--verbosity <level>]
    [--version]
    <inputDir> <outputDir>

Arguments


.. code::

    [-h] [--help]
    If specified, show help message and exit.
    
    [--json]
    If specified, show json representation of app and exit.
    
    [--man]
    If specified, print (this) man page and exit.

    [--meta]
    If specified, print plugin meta data and exit.
    
    [--savejson <DIR>] 
    If specified, save json representation file to DIR and exit. 
    
    [-v <level>] [--verbosity <level>]
    Verbosity level for app. Not used currently.
    
    [--version]
    If specified, print version number and exit. 


Getting inline help is:

.. code:: bash

    docker run --rm fnndsc/pl-sys_info sys_info --man

Run
~~~

You need to specify input and output directories using the `-v` flag to `docker run`.


.. code:: bash

    docker run --rm -u $(id -u)                             \
        -v $(pwd)/in:/incoming -v $(pwd)/out:/outgoing      \
        fnndsc/pl-sys_info sys_info                        \
        /incoming /outgoing


Development
-----------

Build the Docker container:

.. code:: bash

    docker build -t local/pl-sys_info .

Run unit tests:

.. code:: bash

    docker run --rm local/pl-sys_info nosetests

Examples
--------

Put some examples here!


.. image:: https://raw.githubusercontent.com/FNNDSC/cookiecutter-chrisapp/master/doc/assets/badge/light.png
    :target: https://chrisstore.co

Tag summary

Content type

Image

Digest

Size

44.2 MB

Last updated

almost 5 years ago

docker pull fnndsc/pl-sys_info