.. _backbone-label:

##########
 Fastspar
##########

**************
 Introduction
**************

FastSpar is a C++ implementation of the SparCC algorithm which is up to
several thousand times faster than the original Python2 release and uses
much less memory. The FastSpar implementation provides threading support
and a p-value estimator which accounts for the possibility of
repetitious data permutations.

**********
 Versions
**********

-  1.0.0

**********
 Commands
**********

-  fastspar
-  fastspar_bootstrap
-  fastspar_pvalues
-  fastspar_reduce

*************
 Example job
*************

Adjust slurm options based on job requirements (`slurm cheat sheet
<https://slurm.schedmd.com/pdfs/summary.pdf>`_):

.. code::

   #!/bin/bash
   #SBATCH -p partitionName  # batch, gpu, preempt, mpi or your group's own partition
   #SBATCH -t 1:00:00  # Runtime limit (D-HH:MM:SS)
   #SBATCH -N 1   # Number of nodes
   #SBATCH -n 1   # Number of tasks per node
   #SBATCH -c 4   # Number of CPU cores per task
   #SBATCH --mem=8G       # Memory required per node
   #SBATCH --job-name=fastspar    # Job name
   #SBATCH --mail-type=FAIL,BEGIN,END     # Send an email when job fails, begins, and finishes
   #SBATCH --mail-user=your.email@tufts.edu       # Email address for notifications
   #SBATCH --error=%x-%J-%u.err   # Standard error file: <job_name>-<job_id>-<username>.err
   #SBATCH --output=%x-%J-%u.out  # Standard output file: <job_name>-<job_id>-<username>.out

   module purge   ### Optional, but highly recommended.
   module load fastspar/XXXX      ### Latest version is recommended.