{% extends "base.html" %} {% set active_page = 'docs' %} {% block title %}Documentation - Ursa Customer Portal{% endblock %} {% block content %}

Overview

Ursa is a cloud-based genomics processing platform that enables you to run bioinformatics pipelines at scale. The platform handles:

  • Workset Management - Submit, monitor, and manage analysis jobs
  • File Registry - Track and organize your sequencing data files
  • Pipeline Execution - Run germline, somatic, RNA-seq, and other analyses
  • Cost Tracking - Monitor compute and storage costs in real-time

Quick Start Guide

1. Register Your Files

Navigate to Files and link your S3 bucket or upload files directly.

2. Create a File Set

Group related files (e.g., paired-end reads for a sample) into a File Set.

3. Submit a Workset

Go to Submit New Workset, select your file set, choose a pipeline, and submit.

4. Monitor Progress

Track your workset status on the Dashboard or Worksets page.

Key Concepts

Workset

A batch of analysis inputs processed together through a pipeline. Contains one or more samples.

File Set

A logical grouping of files with shared metadata (e.g., all files for a biosample).

Manifest

A TSV file (stage_samples.tsv) that defines sample metadata and file mappings.

Pipeline

A bioinformatics workflow (germline, somatic, RNA-seq, etc.) that processes your data.

Creating Worksets

There are several ways to create a workset:

  1. From File Set (Recommended) - Select a pre-configured file set
  2. Upload Files - Upload FASTQ files directly
  3. S3 Path - Point to existing data in S3
  4. Manifest Upload - Upload a stage_samples.tsv file

Dashboard Guide

The Dashboard provides a quick overview of your account activity and status:

Workset Status Tiles

View counts of worksets in different states: In Progress, Ready/Queued, Completed, and Errors. Click any tile to filter worksets by status.

File Statistics

See your registered file count and total storage used. Click to navigate to the File Registry.

Cost Tracking

Monitor your monthly costs and 30-day cost breakdown. Click to view detailed usage analytics.

Activity Chart

View processing activity over the last 30 days with metrics for submitted, completed, and failed worksets.

File Registry UI

The File Registry helps you manage and organize your genomics data files.

Search & Filtering

Use the search bar to find files by filename, sample ID, or subject ID. Click the "Advanced" button to access additional filters:

  • Format - Filter by file type (FASTQ, BAM, CRAM, VCF)
  • Sample Type - Filter by sample type (Blood, Saliva, Tissue, etc.)
  • Subject ID - Find all files for a specific subject
  • Biosample ID - Find files for a specific biosample
  • Tags - Filter by custom tags
  • Sequencing Platform - Filter by sequencing platform
  • Date Range - Filter by registration date

File Registration Methods

Register files using one of three methods:

  1. Single File - Register one file with full metadata
  2. Bulk Import - Upload a CSV/TSV file with multiple files and metadata
  3. Auto-Discover - Scan a linked S3 bucket to automatically discover and register files

File Detail Page

Click on any file to view detailed information including:

  • File metadata (size, format, checksum)
  • Subject and biosample information
  • Sequencing details (platform, instrument, run date)
  • Tags and file sets
  • Workset history

From the detail page, you can:

  • Add Tags - Click "Add Tag" to add custom tags for organization
  • Find Similar Files - Discover other files from the same subject
  • View Subject's Files - See all files registered for a subject

Worksets UI

The Worksets page allows you to create, monitor, and manage analysis jobs.

Creating a Workset

Click "Submit New Workset" to create a new analysis job. You can:

  • Select files from your File Registry
  • Upload FASTQ files directly
  • Provide an S3 path to existing data
  • Upload a manifest file (stage_samples.tsv)

Monitoring Worksets

The Worksets list shows all your analysis jobs with their current status:

  • READY - Queued and waiting to start
  • IN_PROGRESS - Currently running
  • COMPLETE - Successfully finished
  • ERROR - Failed with an error

Click on any workset to view detailed information, logs, and results.

Usage & Cost Tracking

The Usage page provides detailed insights into your compute and storage costs.

Cost Breakdown

View your costs broken down by:

  • Compute - EC2 instance costs for running worksets
  • Storage - S3 storage costs for your data
  • Data Transfer - Costs for data egress
  • Other - Additional AWS service costs

Daily Cost Tracking

View your daily costs over the last 30 days to identify trends and optimize spending.

API Authentication

The Ursa API supports two authentication methods:

JWT Token (Recommended)

Include your JWT token in the Authorization header:

Authorization: Bearer <your-jwt-token>

API Key

Generate an API key from your Account Settings and include it in requests:

X-API-Key: <your-api-key>

Need Help?

Can't find what you're looking for? Contact our support team.

Email: John@dyly.bio

{% endblock %}