Skip to main content

Software and system setup

When you set up Bases2FastqDx on a system, you must install a static binary executable or use a Docker container. Additionally, to set up Docker or a static binary compute environment that meets system requirements, you must configure the compute environment to transfer files.

System requirements​

Operating system​

Bases2FastqDx is compatible with various operating systems (OS). Review the following compatibility matrix to determine the appropriate Bases2FastqDx distribution for your OS:

Operating SystemDocker CompatibilityStatic Binary CompatibilityOS Notes
Linux OSYes, Green CheckmarkYes, Green CheckmarkThe static binary executable is compatible with any Linux OS on an x86 architecture that uses glibc v2.19 or later.
To verify the glibc version for static binary, run the following command: ldd --version
Windows OSYes, Green CheckmarkNo, Red XWindows OS is not directly compatible with the static binary executable. Install Docker and run using Docker. Make sure to review the system requirements. Element recommends enabling the WSL 2 backend feature.
Windows OS with Windows Subsystem for Linux (WSL)Yes, Green CheckmarkYes, Green CheckmarkIf you install WSL on Windows OS, you can use the static binary executable in the WSL environment.
Mac OSYes, Green CheckmarkNo, Red XMacOS is not compatible with the static binary executable. Install Docker and run using Docker.
Note:

Bases2FastqDx is not supported on ARM processors.

Memory and performance​

Software performance is based on the resources that are dedicated to the processing environment. For optimal performance, make sure that you have at least 16 CPU cores available and enable threading Bases2FastqDx with the -p argument. The following memory requirements apply to both Docker and static binary distributions:

  • A 2 x 75 or 2 x 150 AVITI Dx System run requires 4 GB RAM per concurrent thread.
  • A 2 x 300 AVITI Dx System run requires 6 GB RAM per concurrent thread.

The following benchmarks estimate the time Bases2FastqDx takes to execute a 2 x 150 sequencing run:

SetupTime Estimate
A non-volatile memory express (NVMe) solid-state drive (SSD) that uses 8 threads60 minutes
An NVMe SSD that uses 20 threads30 minutes
An Amazon m5.12xlarge EC2 instance with 48 virtual CPUs and onboard SSD storage< 30 minutes

Temporary directory​

When you use cloud storage, Bases2FastqDx downloads input files and stages output files in a temporary directory. Intermediate files that are generated during analysis are also stored in the temporary directory. After an execution completes, the temporary directory is cleared.

The temporary directory typically uses 400–500 GB for a 2 x 150 run (approximately 1 billion reads). For some applications, a run can use up to 800 GB. The necessary amount of scratch space is based on on the number of polonies and cycles in the run and the optional arguments in the Bases2FastqDx execution.

By default, Bases2FastqDx uses the temporary directory of the OS. To change the location of the temporary directory, set the environment variable TMPDIR. Use the following example command and replace /path/to/scratch with the desired directory:

Set TMPDIR in Linux env
export TMPDIR="/path/to/scratch"

File transfer and storage setup​

To transfer files, Bases2FastqDx requires paths to input and output locations. You can store input and output files in a local location or the cloud. For cloud storage, the following providers are compatible:

  • Amazon Simple Storage Service (Amazon S3)
  • Google Cloud Storage (GCS)
  • Any rclone-compatible provider

Amazon S3 and GCS storage connections require credential configuration for Bases2FastqDx execution. For more information, see Execute with Amazon S3 and Execute with GCS.

Rclone requirements​

Rclone is a command-line program to manage files on cloud storage. Rclone provides the ability to mount any local, cloud, or virtual file system. Rclone allows Bases2FastqDx to access many cloud storage providers. However, Element has not tested every available rclone provider.

To download and install rclone, follow the instructions at rclone.org/install. To communicate with your cloud storage, configure an rclone remote setup. For more information, see the provider-specific instructions at rclone.org/#providers.

Bases2FastqDx installation​

To set up Bases2FastqDx, use Docker or static binary. Current and previous versions are available for installation.

NOTE

The static binary executable for Bases2FastqDx is only compatible with specific OS configurations. Before installation, review the OS requirements.

Install the current version​

  1. Follow the OS-specific instructions at docs.docker.com/get-docker/.

  2. To pull the latest version of the Bases2FastqDx image from the Element public registry at Docker Hub, run the following command:

    docker pull elembio/bases2fastqdx

  3. To confirm that Bases2FastqDx is operational, run the following commands to display the software version and help content:

    docker run elembio/bases2fastqdx bases2fastq --version
    docker run elembio/bases2fastqdx bases2fastq --help

  4. To test the software, you can download simulated data and complete the Getting Started with Bases2FastqDx tutorial.

Install a previous version​

Bases2FastqDx follows the semantic versioning specification. All major, minor, and patch versions are available by tag for both the Docker and static binary.

  1. To review information for previous versions of Bases2FastqDx, see Release Notes and Version Compatibility.

  2. To complete the instructions for Bases2FastqDx installation use a command to download a previous version. See the following code examples:

# Get the latest of version 2
docker pull elembio/bases2fastqdx:2

# Get the latest minor 2.4 version
docker pull elembio/bases2fastqdx:2.4

# Get a specific major, minor, patch version
docker pull elembio/bases2fastqdx:2.4.1

Verifying Bases2FastqDx binary via signature​

The Bases2FastqDx binary is digitally signed by DigiCert to ensure security. The release archive includes a matching bases2fastq.sig file. To verify the signature, use the extracted binary and signature files:

openssl cms -verify -binary -inform DER -in bases2fastq.sig -content ./bases2fastq -CApath /etc/ssl/certs -purpose any > /dev/null && echo "OK: signature valid"

You should receive a response verifying the binary is the same image Element published.

OK: signature valid
Last updated on