Skip to content
/ dxflow Public

Transform any machine into a computational powerhouse with dxflow

Notifications You must be signed in to change notification settings

diphyx/dxflow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

74 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

dxflow Engine

A powerful workflow engine for Docker, Slurm and more, providing both CLI and API interfaces for seamless integration. Transform any accessible machine into a first-class member of your computational fleet.

License Platform Architecture

Overview

dxflow provides a unified interface for orchestrating workflows across different computing environments with enterprise-grade security and scalability. Originally developed at DiPhyX for scientific computing, it has evolved into a production-grade engine for any distributed computing need.

Key Features

  • Universal Deployment - Deploy on any infrastructure: cloud VMs, GPU nodes, HPC clusters, or laptops
  • Unified Interface - Consistent CLI, REST API, and intuitive web UI across all environments
  • Container Orchestration - Native Docker Compose integration with real-time monitoring
  • Secure by Design - RSA key-pair authentication with fine-grained access control
  • Real-time Monitoring - Live logs, metrics, and workflow status tracking
  • Multi-Scheduler Support - Works with Docker, Kubernetes, Slurm, PBS, and other schedulers
  • Secure Tunneling - Expose services through authenticated WebSocket bridges
  • Bridge Mode - Secure proxy connections for remote access and federation

Quick Start

Installation

πŸš€ Quick Install (Linux/macOS):

wget -qO- https://raw.githubusercontent.com/diphyx/dxflow/main/assets/install.sh | sudo bash

πŸ“¦ Manual Installation:

  1. Download the latest release for your platform:

    # Visit https://github.com/diphyx/dxflow/releases
    # Or use curl for latest version:
    curl -L -o dxflow.tar.gz "https://github.com/diphyx/dxflow/releases/latest/download/dxflow-$(uname -s)-$(uname -m).tar.gz"
  2. Extract and install:

    tar -xzf dxflow.tar.gz
    sudo mv dxflow /usr/local/bin/
    chmod +x /usr/local/bin/dxflow
  3. Verify installation:

    dxflow --version
    dxflow --help

Get Started in 30 Seconds

# Start the dxflow engine
dxflow boot up

# Access the web interface
open http://localhost

# Check engine status
dxflow engine ping

# Get system information
dxflow engine info

# Update to latest version
dxflow engine update

Architecture

dxflow operates as a lightweight 4-layer architecture that integrates seamlessly with existing infrastructure:

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚    Your Applications        β”‚  ← Run workloads unchanged
β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€
β”‚    Native Schedulers        β”‚  ← Docker, K8s, Slurm, PBS
β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€
β”‚      dxflow Engine          β”‚  ← Unified access layer
β”œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€
β”‚   Your Infrastructure       β”‚  ← Any compute resource
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

Deployment Patterns:

  • Single Node: All-in-one development and testing
  • Hub-Node: Centralized control with distributed execution
  • Federated: Multiple interconnected dxflow instances
  • Bridge Mode: Secure tunneling for remote access

Use Cases

πŸ”¬ Scientific Research

  • Computational Chemistry: GROMACS, Quantum ESPRESSO, custom solvers
  • Bioinformatics: Genomics pipelines, protein folding simulations
  • Physics: CFD simulations, materials science modeling
  • Machine Learning: Multi-GPU training, distributed inference

πŸ’Ό Enterprise & DevOps

  • Data Processing: Large-scale ETL and analytics pipelines
  • CI/CD: Distributed testing and deployment workflows
  • Edge Computing: IoT data processing and edge-to-cloud workflows
  • Development: Multi-environment testing and staging

πŸŽ“ Academic & Research Institutions

  • Course Labs: Consistent computational environments for students
  • Research Groups: Shared access to GPU clusters and HPC resources
  • Collaboration: Multi-institutional research projects

Documentation

Comprehensive documentation is available in the following sections:

πŸ“š Core Documentation

🎯 Advanced Topics

❓ Help & Support

  • FAQs - Common questions and solutions

Workflow Hub

Pre-configured workflows and applications ready to deploy:

πŸ“– Getting Started

🧬 Scientific Computing

  • Genomics - DNA/RNA sequencing analysis workflows
  • Molecular - Molecular simulation tools (GROMACS, Amber)
  • Structural - Cryo-EM and structure prediction workflows

πŸ“Š Data Science & Engineering

Each workflow includes complete Docker Compose configurations, setup guides, and best practices. Browse the hub to find production-ready solutions for your research domain.

System Requirements

Minimum Requirements

  • OS: Linux (any distribution), macOS 10.14+, Windows 10+
  • Architecture: x86_64 (AMD64) or ARM64
  • Memory: 512MB RAM
  • Storage: 100MB disk space
  • Network: Internet connection for installation

Recommended Requirements

  • Memory: 2GB+ RAM for production workloads
  • Storage: 1GB+ for logs and temporary files
  • Network: Stable connection for distributed deployments

Platform Support

Platform Status Notes
Linux βœ… Full Support All distributions, containers, HPC
macOS βœ… Full Support Intel and Apple Silicon
Windows βœ… Full Support Native and WSL2

Licensing

dxflow includes a General License that provides:

  • βœ… Free until 2030 - No cost for core functionality
  • βœ… Full Feature Access - All core modules included
  • βœ… No Registration Required - Start using immediately
  • βœ… Production Ready - No limitations for real workloads

For advanced features like bridge connections or custom licensing, see the licensing documentation.

Getting Help

πŸ†˜ Support Channels

  • Documentation: Start with our comprehensive guides above
  • Issues: GitHub Issues for bugs and feature requests
  • Direct Support: info@diphyx.com for enterprise needs

πŸ“ž Enterprise Contact

About DiPhyX

dxflow is developed by DiPhyX, a company founded by scientists with over 20 years of combined experience on national supercomputers and more than 50 published papers. We understand the challenges of computational research and build tools to accelerate scientific discovery.

Our Journey

dxflow began as an internal initiative at DiPhyX to streamline sprawling scripts, clusters, and ad-hoc logs that slow down scientific progress. Initially a weekend hack intended to create a "MLFlow for physics and chemistry," it has evolved through numerous projects in bioinformatics, CFD, and materials science into a robust, production-grade engine available for everyone.

Our Mission

To accelerate scientific innovation by providing unified, scalable, and intuitive cloud platforms for end-to-end computational pipelines.

Our Approach

  • Scientific-First: Built for real research needs, not just enterprise IT
  • No Vendor Lock-in: Runs on your existing infrastructure
  • Researcher-Friendly: Designed by scientists who understand computational workflows and the pain of failed overnight runs

About

Transform any machine into a computational powerhouse with dxflow

Topics

Resources

Stars

Watchers

Forks

Contributors 2

  •  
  •