Supernova1.0, printed on 11/13/2024
Supernova is delivered as a single, self-contained tar file that can be unpacked anywhere on your system. It bundles all of its own required software dependencies, which are pre-compiled to run on a range of Linux distributions.
Step 1 – Download and unpack the Supernova file in any location. In this example we use /opt.
$ cd /opt [ download file from downloads page ] $ tar -xzvf supernova-1.0.0.tar.gz
This unpacks Supernova, its dependencies, and the supernova script into a new directory called supernova-1.0.0.
Step 2 – Prepend the Supernova directory to your $PATH. This will allow you to invoke the supernova command.
$ export PATH=/opt/supernova-1.0.0:$PATH
You may wish to add this command to your .bashrc for convenience.
Next, please run the bundled site check script and send the output to 10x. We will review the information to ensure that Supernova will run smoothly once you have generated your own Chromium data. Assuming you have installed Supernova as described above, please run the following commands:
$ supernova sitecheck > sitecheck.txt $ supernova upload your@email.edu sitecheck.txt
If your system does not have direct Internet connectivity, please send the output files as attachments to support@10xgenomics.com.
To ensure that the Supernova pipeline is working, you will use the supernova run command in
--test mode. This test can take up to 20 minutes on a sixteen-core workstation. Assuming you
installed Supernova into /opt, the necessary commands would look like:
$ export PATH=/opt/supernova-1.0.0:$PATH $ supernova run --test --id=tiny supernova run 1.0.0 Copyright (c) 2016 10x Genomics, Inc. All rights reserved. ----------------------------------------------------------------------------- Running Supernova in test mode. Martian Runtime - 2.0.0 Running preflight checks (please wait)... 2016-05-03 11:17:00 [runtime] (ready) ID.tiny.ASSEMBLER_CS._ASSEMBLER_PREP.SETUP_CHUNKS 2016-05-03 11:17:03 [runtime] (split_complete) ID.tiny.ASSEMBLER_CS._ASSEMBLER_PREP.SETUP_CHUNKS 2016-05-03 11:17:03 [runtime] (run:local) ID.tiny.ASSEMBLER_CS._ASSEMBLER_PREP.SETUP_CHUNKS.fork0.chnk0.main ... 2016-05-03 11:20:36 [runtime] (run:local) ID.tiny.ASSEMBLER_CS.ASSEMBLER_CP.fork0.join 2016-05-03 11:20:39 [runtime] (join_complete) ID.tiny.ASSEMBLER_CS.ASSEMBLER_CP Outputs: - assembly: /home/jdoe/tiny/outs/assembly - summary: /home/jdoe/tiny/outs/summary.csv - report: /home/jdoe/tiny/outs/report.txt Pipestance completed successfully!
Whether the test pipestance succeeds or fails, you will then see:
Saving pipestance info to tiny/tiny.mri.tgz
This tiny.mri.tgz file contains diagnostic information 10x can use to help resolve any problems. It is generated whether the pipeline succeeds or fails. If the pipeline fails and you need troubleshooting assistance, you can send this file directly to us from the command line:
$ supernova upload your@email.edu tiny/tiny.mri.tgz
If your system does not have direct Internet connectivity, you can also send the file as an attachment to support@10xgenomics.com.