Skip to content

BioMedAI-UCSC/CGML_Driver

Repository files navigation

Driver Repository

This is the Driver repository for our entire molecular dynamics and machine learning pipeline, providing a coordinated and seamless workflow for simulation, training, and analysis.

Overview

This repository contains scripts and tools that integrate multiple components of our computational pipeline:

  • Regular OpenMM All Atom MD Programs and Scripts (openmm_generate)
    Standard molecular dynamics simulations using OpenMM for all-atom representations

  • Training CGSchNet-based Models (base_model)
    Machine learning model training infrastructure for coarse-grained molecular representations using CGSchNet

  • WESTPA for Data Generation (westpa_prop)
    Weighted Ensemble Simulation Toolkit with Parallelization and Analysis (WESTPA) integration supporting:

    • ML-driven simulations
    • Regular MD simulations
    • Custom progress coordinates
    • Enhanced sampling workflows
  • Benchmark Suite (benchmark)
    Qualitative and quantitative comparison tools for evaluating and validating models

  • Shared Modules (module)
    Repository containing all code and functions shared between base model, benchmark, openmm_generate, and westpa_prop.

Status

⚠️ IMPORTANT: Our code is currently being ported and refactored from private repositories for public release. The full codebase with documentation and tutorials will be provided within one to two weeks.

Contributing

We welcome contributions, feature requests, and bug reports! Please use GitHub Issues to:

  • Request new features
  • Report bugs
  • Suggest improvements
  • Ask questions about the pipeline

Installation

Installation instructions will be added soon.

Prerequisites

System requirements and dependencies will be listed here.

Building the Environment

Instructions for setting up the computational environment will be added soon.

Getting Started

Quick start guide will be added as modules are released.

Tutorials

Step-by-step tutorials for common workflows will be provided soon.

Documentation

Comprehensive documentation will be available soon.

License

License information will be added soon.

About

Driver class for all of CGML benchmark and model

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •