Skip to content

BPM Documentation

Welcome to the Bioinformatics Project Manager (BPM) documentation! BPM is a flexible, template-driven CLI tool designed to streamline bioinformatics project management.

🚀 Quick Start

Get up and running with BPM in minutes:

# Install BPM
pip install bpm

# Set up cache directory
export BPM_CACHE="/path/to/bpm_cache"

# Initialize your first project
bpm init 230101_MyProject_Institute_Application

# Add a repository
bpm repo add /path/to/repository

# Generate files from a template
bpm generate template_name --project project.yaml

✨ Key Features

🗂️ Project Management

Create and manage bioinformatics projects with standardized naming conventions. Keep your projects organized and consistent across your team.

Learn more →

📋 Template System

Generate project files from customizable templates. Save time and ensure consistency across all your bioinformatics workflows.

Learn more →

⚡ Workflow Execution

Run predefined bioinformatics workflows with ease. Execute complex pipelines with simple commands.

Learn more →

📚 Repository Management

Manage template and workflow repositories. Share and collaborate on templates across your organization.

Learn more →

🎯 Use Cases

BPM is designed for bioinformatics professionals who need to:

  • Standardize project structure across multiple research projects
  • Automate repetitive tasks in bioinformatics workflows
  • Share templates and workflows within research teams
  • Manage complex pipeline configurations efficiently
  • Ensure reproducibility in bioinformatics research

📖 Documentation Sections

Getting Started

New to BPM? Start here to learn the basics.

User Guide

Learn how to use BPM effectively in your daily workflow.

Admin Guide

For administrators and template creators.

Examples

Real-world examples and use cases.

🔧 Installation

BPM is available on PyPI and can be installed with pip:

pip install bpm

For detailed installation instructions, see our Installation Guide.

🤝 Contributing

We welcome contributions! Whether you're fixing bugs, adding features, or improving documentation, your help is appreciated.

📄 License

BPM is released under the MIT License. See the LICENSE file for details.

Need Help?

  • Check our FAQ for common questions
  • Look at Common Issues for solutions
  • Open an issue for bugs or feature requests