{% extends "base.html" %} {% set active_page = 'docs' %} {% block title %}Documentation - Ursa Customer Portal{% endblock %} {% block content %}
Learn how to use the Ursa genomics processing platform
Ursa is a cloud-based genomics processing platform that enables you to run bioinformatics pipelines at scale. The platform handles:
Navigate to Files and link your S3 bucket or upload files directly.
Group related files (e.g., paired-end reads for a sample) into a File Set.
Go to Submit New Workset, select your file set, choose a pipeline, and submit.
Track your workset status on the Dashboard or Worksets page.
A batch of analysis inputs processed together through a pipeline. Contains one or more samples.
A logical grouping of files with shared metadata (e.g., all files for a biosample).
A TSV file (stage_samples.tsv) that defines sample metadata and file mappings.
A bioinformatics workflow (germline, somatic, RNA-seq, etc.) that processes your data.
There are several ways to create a workset:
The Dashboard provides a quick overview of your account activity and status:
View counts of worksets in different states: In Progress, Ready/Queued, Completed, and Errors. Click any tile to filter worksets by status.
See your registered file count and total storage used. Click to navigate to the File Registry.
Monitor your monthly costs and 30-day cost breakdown. Click to view detailed usage analytics.
View processing activity over the last 30 days with metrics for submitted, completed, and failed worksets.
The File Registry helps you manage and organize your genomics data files.
Use the search bar to find files by filename, sample ID, or subject ID. Click the "Advanced" button to access additional filters:
Register files using one of three methods:
Click on any file to view detailed information including:
From the detail page, you can:
The Worksets page allows you to create, monitor, and manage analysis jobs.
Click "Submit New Workset" to create a new analysis job. You can:
The Worksets list shows all your analysis jobs with their current status:
Click on any workset to view detailed information, logs, and results.
The Usage page provides detailed insights into your compute and storage costs.
View your costs broken down by:
View your daily costs over the last 30 days to identify trends and optimize spending.
The Ursa API supports two authentication methods:
Include your JWT token in the Authorization header:
Authorization: Bearer <your-jwt-token>
Generate an API key from your Account Settings and include it in requests:
X-API-Key: <your-api-key>