Skip to main content

Trailblazer is a tool to manage and track state of analyses

Project description

Trailblazer Coverage Status

Monitor the progress of analysis workflows submitted to SLURM

Trailblazer is a tool that aims to provide:

  • Monitoring of processes that require submission to a workflow manager
  • Display metadata for each analysis within a web based user interface

Here you can find a simple web UI for Trailblazer that helps you keep track of the status of multiple runs

Installation

Trailblazer is written in Python 3.11 and is available on the Python Package Index (PyPI).

pip install trailblazer

If you would like to install the latest development version:

git clone https://github.com/Clinical-Genomics/trailblazer
cd trailblazer
pip install --editable .

With each push to GitHub your files will be automatically verified using Black . If you would like to automatically Black format your commits on your local machine:

pre-commit install

Contributing

Trailblazer uses the GitHub flow branching model as described in Atlas GitHub Flow.

Documentation

Here's a brief documentation. Trailblazer functionality can be accessed from the command line interface (CLI), the monitoring web interface, the supporting REST API, as well as using the Python API.

Command line interface

Command: trailblazer init

Setup (or reset) a Trailblazer database. The command will set up all the tables in the database. You can reset an existing database by using the --reset option.

trailblazer --database "sqlite:///tb.sqlite3" init --reset
Delete existing tables? [analysis, info, job, user] [y/N]: y
Success! New tables: analysis, info, job, user

Command: trailblazer user

This command can be used both to add a new user to the database (and give them access to the web interface) and view information about an existing user.

# add a new user
trailblazer user --name "Paul Anderson" paul.anderson@magnolia.com
New user added: paul.anderson@magnolia.com (2)

# check an existing user
trailblazer user paul.anderson@magnolia.com
{'created_at': datetime.datetime(2017, 6, 22, 8, 49, 44, 685977), 'google_id': None, 'name': 'Paul Anderson', 'email': 'paul.anderson@magnolia.com', 'avatar': None, 'id': 2}

Command: trailblazer archive-user

This command archives a user in the database (and removes their access to the web interface).

# archive a user
trailblazer archive-user paul.anderson@magnolia.com
User archived: paul.anderson@magnolia.com

Command: trailblazer users

This command can be used both to list all users in the database and get a filtered list of users.

# list all users
trailblazer users
Listing users in database:
{'created_at': datetime.datetime(2017, 6, 22, 8, 49, 44, 685977), 'google_id': None, 'name': 'Paul Anderson', 'email': 'paul.anderson@magnolia.com', 'avatar': None, 'id': 2}

# list all users named 'Anderson' that has an email with 'magnolia' in it
trailblazer users --name Anderson --email magnolia
Listing users in database:
{'created_at': datetime.datetime(2017, 6, 22, 8, 49, 44, 685977), 'google_id': None, 'name': 'Paul Anderson', 'email': 'paul.anderson@magnolia.com', 'avatar': None, 'id': 2}

Command: trailblazer log

Logs the status of a run to the supporting database. You need to point to the analysis config of a specific run.

trailblazer log path/to/case/analysis/case_config.yaml

You can point to the same analysis multiple times, Trailblazer will detect if the same analysis has been added before and skip it if no information has been updated. If an analysis has been added previously as "running" or "pending", those entries will automatically be removed as soon as the same analysis is logged as either "completed" or "failed".

Command: trailblazer scan

Convenience command to scan an entire directory structure for all analyses and update their status in one go. Assumes the base directory consists of individual case folders:

trailblazer scan /path/to/analyses/dir/

This command can easily be setup in a crontab to run e.g. every hour and keep the analysis statuses up-to-date!

Command: trailblazer ls

Prints the case id for the most recently completed analyses to the console.

trailblazer ls
F0013487
F0013362
F0006106
17083
F0013469
17085

Command: trailblazer delete

Deletes an analysis log from the database. The input is the unique analysis id which is printed ones the analysis is initially logged. It's also displayed in the web interface.

trailblazer delete 4

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

trailblazer-21.5.7.tar.gz (77.0 kB view details)

Uploaded Source

Built Distribution

trailblazer-21.5.7-py3-none-any.whl (66.7 kB view details)

Uploaded Python 3

File details

Details for the file trailblazer-21.5.7.tar.gz.

File metadata

  • Download URL: trailblazer-21.5.7.tar.gz
  • Upload date:
  • Size: 77.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.19

File hashes

Hashes for trailblazer-21.5.7.tar.gz
Algorithm Hash digest
SHA256 54aa8b2a4aefc0ae6e867c57258fbe40ab9057aedd707538c25c6fb30293f15b
MD5 7c9ac8c4352d5de8019eb6250b5eeba5
BLAKE2b-256 9e805e456324344ee14052046920b3b9f69a728c707312e45b86efc48731e619

See more details on using hashes here.

File details

Details for the file trailblazer-21.5.7-py3-none-any.whl.

File metadata

File hashes

Hashes for trailblazer-21.5.7-py3-none-any.whl
Algorithm Hash digest
SHA256 a9cd3b0d847e0aa30b6fd5c22d266b5b815fef60188e6a59ffcbbf3d6504e477
MD5 c15713a1cbf99415871a2701b771792d
BLAKE2b-256 f06d9abff036b404ec573ba9adc500f8ae7b68f45dbba64a1727a4ea3acb7a66

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page