.. _`parallel-tar`:

============================
Parallel Tar With Validation
============================

.. contents::
   :depth: 1
   :local:

.. admonition:: Compute Resources

    - Have questions or need help with compute, including activation or issues?
      Follow `this link. <https://washu.atlassian.net/servicedesk/customer/portal/2/group/6/create/43>`__
    - :ref:`User Agreement <compute-user-agreement>`

.. _`parallel-tar-overview`:

Overview
--------

The purpose of this document is to demonstrate steps required to parallel tar
using RIS-hosted image `gcr.io/ris-registry-shared/parallel-tar`. Input variable
and process execution validation included.

Interactive Command-Line Session
--------------------------------

.. code::

  bsub -n 2 -Is -q general-interactive -a 'docker(gcr.io/ris-registry-shared/parallel-tar)' /bin/bash

.. code::

  parallel-tar.py -s path/to/source_dir/ -d path/to/dest_dir/

Non-Interactive Session
-----------------------

.. code::

  bsub -n 2 -q general -a 'docker(gcr.io/ris-registry-shared/parallel-tar)' "parallel-tar.py -s path/to/source_dir/ -d path/to/dest_dir/"

Expected Output
---------------

.. code::

  Running tar with parameters
  source directory: path/to/source_dir/
  destination directory: path/to/dest_dir/
  threads: 4
  tar file name: path/to/dest_dir/source_dir.tar.gz
  remove source directory: False

  Validating tar contents

  Parallel-tar completed successfully

Script Variables
----------------

- -s --source-dir         source directory to tar and compress
- -d --dest-dir           destination directory to place tar compressed file
- -t --threads            number of threads for the compress algorithm, default 4
- -n --tar-file-name      name of tar file with out the .tar.gz extension
- -r --remove-source-dir  Remove the source directory when tar process completes, default False