A comprehensive bioinformatics platform for running pipelines, with CLI, GUI, and web interfaces.
- Project Management: Create and manage bioinformatics projects with organized directory structures
- Advanced Pipelines: Support for complex workflows with dependencies and parallel execution
- Multiple Interfaces: CLI, Desktop GUI (BioBuntu Studio), and Web Dashboard
- Remote Lab Support: API endpoints for remote pipeline execution with job tracking
- Packaging: Available as .deb packages, PPA, and Conda packages
- Workflow Support: RNA-seq, variant calling, metagenomics, and QC pipelines
- Tool Integration: Wrappers for FastQC, BWA, GATK, HISAT2, Samtools
git clone https://github.com/biobuntu/biobuntu.git
cd biobuntu
pip install -e .sudo dpkg -i biobuntu_0.1.0_all.deb
sudo apt-get install -f # Install dependenciessudo add-apt-repository ppa:biobuntu/biobuntu
sudo apt-get update
sudo apt-get install biobuntuconda install -c biobuntu biobuntu-
Create a project:
biobuntu create-project myproject --description "RNA-seq analysis" -
Run a pipeline:
biobuntu run workflows/rnaseq.yaml --project myproject --input sample.fastq
-
Start web interface:
biobuntu web
Open: http://localhost:5000
BioBuntu provides a comprehensive CLI with 8 commands:
biobuntu --help # Show all commands
biobuntu create-project <name> # Create new project
biobuntu list-projects # List all projects
biobuntu delete-project <name> # Delete project
biobuntu list # List workflows
biobuntu validate <workflow> # Validate workflow
biobuntu run <workflow> [options] # Run pipeline
biobuntu web # Start web dashboard
biobuntu gui # Start GUI applicationAccess the web interface at http://localhost:5000 with features:
- Create and manage projects
- Run pipelines locally or remotely
- Monitor remote jobs with real-time updates
- Download results and intermediate files
Launch BioBuntu Studio with biobuntu gui featuring:
- Project selection and creation
- Drag-and-drop file input
- Real-time progress tracking
- Workflow validation
Projects are automatically organized:
~/biobuntu/projects/myproject/
├── raw_data/ # Input files
├── qc/ # Quality control results
├── processed/ # Intermediate processing files
├── results/ # Final analysis results
├── reports/ # Summary reports
├── logs/ # Execution logs
└── config/ # Project configuration
- Dependencies: Steps can depend on previous steps
- Parallel Execution: Independent steps run concurrently
- Parameterization: Configurable tool arguments
- Validation: Check workflow structure before execution
name: RNA-seq Pipeline
description: Complete RNA-seq analysis
steps:
- name: qc
tool: fastqc
args:
input_file: raw_data/sample.fastq
output_dir: qc/
- name: align
tool: hisat2
depends_on: [qc]
args:
index: genome_index
input_fastq1: raw_data/sample.fastq
output_sam: processed/sample.samPOST /api/remote/run- Submit remote jobsGET /api/remote/status/<job_id>- Check job statusGET /api/remote/jobs- List all remote jobs- Webhook callbacks for job completion
import requests
# Submit job
response = requests.post('http://localhost:5000/api/remote/run', json={
'workflow': 'rnaseq.yaml',
'project': 'myproject',
'callback_url': 'https://myapp.com/webhook'
})
job_id = response.json()['job_id']- Getting Started - Quick start guide
- Pipelines - Pipeline creation and management
- GUI Guide - Desktop application usage
- Web Dashboard - Web interface documentation
- API Reference - Complete API documentation
- Development - Contributing and development guide
- Python 3.8+
- Bioinformatics tools (optional, for testing)
git clone https://github.com/biobuntu/biobuntu.git
cd biobuntu
pip install -e .
pip install pytest black flake8 # Development dependenciespytest # Run tests
black . # Format code
flake8 . # Check style./scripts/build_deb.sh # Debian package
./scripts/build_ppa.sh # PPA package
./scripts/build_conda.sh # Conda packageWe welcome contributions! Please see our Development Guide for details.
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests
- Submit a pull request
This project is licensed under the MIT License - see the LICENSE file for details.
- Built with Python, Flask, Click, and tkinter
- Inspired by bioinformatics community needs
- Thanks to all contributors and users
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Documentation: Full Docs
BioBuntu - Making bioinformatics accessible through modern interfaces and powerful automation.
