gdock 2.0.0

Information-driven protein-protein docking using a genetic algorithm
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
use colored::*;
use indicatif::{ProgressBar, ProgressStyle};
use rand::rngs::StdRng;
use rand::SeedableRng;
use std::fs;
use std::io::Write;
use std::path::PathBuf;

use crate::chromosome;
use crate::constants::{
    self, EnergyWeights, CONVERGENCE_THRESHOLD, CONVERGENCE_WINDOW, MAX_GENERATIONS,
    POPULATION_SIZE,
};
use crate::evaluator;
use crate::population;
use crate::restraints;
use crate::runner::{run_ga, select_models};
use crate::scoring;
use crate::structure::{self, read_pdb};
use crate::utils;

/// Configuration for a docking run
pub struct RunConfig {
    pub receptor_file: String,
    pub ligand_file: String,
    pub restraint_pairs: Vec<(i32, i32)>,
    pub reference_file: Option<String>,
    pub weights: EnergyWeights,
    pub debug_mode: bool,
    pub output_dir: Option<String>,
    pub no_clustering: bool,
}

/// Re-exported for use by tests and other modules that imported from here.
pub use crate::structure::combine_molecules;

// ============================================================================

/// Run the genetic algorithm docking
pub fn run(config: RunConfig) {
    let RunConfig {
        receptor_file,
        ligand_file,
        restraint_pairs,
        reference_file,
        weights,
        debug_mode,
        output_dir,
        no_clustering,
    } = config;
    const VERSION: &str = env!("CARGO_PKG_VERSION");
    println!(
        "\n{} {}",
        "🧬 GDock".bold().cyan(),
        format!("v{}", VERSION).bright_black()
    );
    println!(
        "{}",
        "   Protein-Protein Docking with Genetic Algorithm".bright_black()
    );
    if debug_mode {
        println!(
            "{}",
            "   ⚠️  DEBUG MODE: Using DockQ as fitness function"
                .yellow()
                .bold()
        );
    }
    println!(
        "{}",
        "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━".bright_black()
    );
    println!("{}", "📁 Input Files".bold());
    println!("  {}  {}", "Receptor: ".green(), receptor_file);
    println!("  {}    {}", "Ligand: ".green(), ligand_file);
    if let Some(ref_file) = &reference_file {
        println!(
            "  {} {} {}",
            "Reference:".green(),
            ref_file,
            "(DockQ mode)".bright_black()
        );
    } else {
        println!(
            "  {} {}",
            "Reference:".green(),
            "None (score-only mode)".yellow()
        );
    }
    println!(
        "\n{} {} pairs",
        "🎯 Restraints:".bold(),
        restraint_pairs.len().to_string().cyan()
    );
    for (rec, lig) in restraint_pairs.iter() {
        println!("  {} {}:{}", "".bright_blue(), rec, lig);
    }
    println!("\n{}", "⚙️  Energy Weights".bold());
    println!(
        "  {}={:.2}{}={:.2}{}={:.2}{}={:.2}",
        "VDW".green(),
        weights.vdw,
        "Elec".green(),
        weights.elec,
        "Desolv".green(),
        weights.desolv,
        "AIR".green(),
        weights.air
    );
    println!(
        "{}\n",
        "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━".bright_black()
    );

    let receptor_model = read_pdb(&receptor_file);
    let ligand_model = read_pdb(&ligand_file);

    // For docking mode, use the first model
    let receptor = receptor_model.0[0].clone();
    let ligand = ligand_model.0[0].clone();

    // Create restraints from user-specified residue pairs
    let restraints_list =
        restraints::create_restraints_from_pairs(&receptor, &ligand, &restraint_pairs);
    let num_restraints = restraints_list.len();
    println!(
        "{} Created {} distance restraints\n",
        "".green(),
        num_restraints.to_string().cyan()
    );

    // Clone the original molecule for potential RMSD calculations
    let orig = ligand.clone();

    let ligand = utils::position_ligand(&receptor, ligand);

    // Start the evaluator (only if reference is provided)
    let eval = if let Some(ref_file) = &reference_file {
        let (_, reference_ligand) = scoring::read_complex(ref_file);
        Some(evaluator::Evaluator::new(
            receptor.clone(),
            reference_ligand,
        ))
    } else {
        None
    };

    // In debug mode, we use the evaluator as the fitness function
    let debug_evaluator = if debug_mode { eval.clone() } else { None };

    // Clone molecules before moving them into population (needed for PDB output later)
    let receptor_clone = receptor.clone();
    let ligand_clone = ligand.clone();

    // Create progress bar
    let progress = ProgressBar::new(MAX_GENERATIONS);
    progress.set_style(
        ProgressStyle::default_bar()
            .template("{spinner:.green} [{bar:40.cyan/blue}] {pos}/{len} gens | {msg}")
            .unwrap()
            .progress_chars("█▓░"),
    );

    // Create the initial population
    let mut pop = population::Population::new(
        Vec::new(),
        receptor,
        ligand,
        orig,
        restraints_list,
        weights,
        debug_evaluator,
    );
    let mut rng = StdRng::seed_from_u64(constants::RANDOM_SEED);
    for _ in 0..POPULATION_SIZE {
        let c = chromosome::Chromosome::new(&mut rng);
        pop.chromosomes.push(c);
    }

    // Evolve the population
    let mut best_score_history: Vec<f64> = Vec::new();

    println!(
        "{} Starting evolution for {} generations",
        "🧬".bold(),
        MAX_GENERATIONS
    );

    let ga_result = run_ga(pop, &mut rng, MAX_GENERATIONS, |gen, pop| {
        // Calculate metrics for all chromosomes (only if reference is available)
        let metric_vec = eval.as_ref().map(|e| pop.eval_metrics(e));

        // Find the best fitness chromosome
        let best_fitness_idx = pop
            .chromosomes
            .iter()
            .enumerate()
            .min_by(|(_, a), (_, b)| a.fitness.partial_cmp(&b.fitness).unwrap())
            .map(|(idx, _)| idx)
            .unwrap();

        let best_fitness = pop.chromosomes[best_fitness_idx].fitness;
        let best_chr = &pop.chromosomes[best_fitness_idx];

        best_score_history.push(best_fitness);

        let improvement_since_last = if gen > 0 {
            let prev = best_score_history[gen as usize - 1];
            if prev.abs() < f64::EPSILON {
                0.0
            } else {
                ((prev - best_fitness) / prev.abs()) * 100.0
            }
        } else {
            0.0
        };

        // Calculate population averages
        let mean_fitness = pop.get_mean_fitness();
        let mean_rest: f64 = 100.0
            * (pop
                .chromosomes
                .iter()
                .map(|c| 1.0 - c.restraint_penalty / num_restraints as f64)
                .sum::<f64>()
                / pop.chromosomes.len() as f64);
        let best_rest = 100.0 * (1.0 - best_chr.restraint_penalty / num_restraints as f64);

        // Update progress bar and print output
        progress.set_position(gen);

        if let Some(ref metrics) = metric_vec {
            let mean_dockq: f64 =
                metrics.iter().map(|m| m.dockq).sum::<f64>() / metrics.len() as f64;
            let best_metrics = &metrics[best_fitness_idx];

            let dockq_color = if best_metrics.dockq >= 0.8 {
                "green"
            } else if best_metrics.dockq >= 0.5 {
                "yellow"
            } else if best_metrics.dockq >= 0.23 {
                "bright_yellow"
            } else {
                "red"
            };

            let score_label = if debug_mode { "DockQ" } else { "Score" };
            let score_value = if debug_mode {
                -best_fitness
            } else {
                best_fitness
            };
            progress.set_message(format!(
                "DockQ: {:.3} | {}: {:.3}",
                best_metrics.dockq, score_label, score_value
            ));

            let mean_score_display = if debug_mode {
                -mean_fitness
            } else {
                mean_fitness
            };
            let best_score_display = if debug_mode {
                -best_fitness
            } else {
                best_fitness
            };
            progress.println(format!("  [{}] {} score={:>8.3} dockq={} rest={}% │ {} score={:>8.3} dockq={} rest={}% rmsd={:.2}Å fnat={:.3} irmsd={:.2}Å │ Δ={}%",
                format!("{:>3}", gen).bright_black(),
                "📊".bright_blue(),
                mean_score_display,
                format!("{:.3}", mean_dockq).cyan(),
                format!("{:>3.0}", mean_rest).bright_black(),
                "🎯".bright_green(),
                best_score_display,
                match dockq_color {
                    "green" => format!("{:.3}", best_metrics.dockq).green(),
                    "yellow" => format!("{:.3}", best_metrics.dockq).yellow(),
                    "bright_yellow" => format!("{:.3}", best_metrics.dockq).bright_yellow(),
                    _ => format!("{:.3}", best_metrics.dockq).red()
                },
                format!("{:>3.0}", best_rest).bright_black(),
                best_metrics.rmsd,
                best_metrics.fnat,
                best_metrics.irmsd,
                if improvement_since_last > 0.0 {
                    format!("{:>+5.2}", improvement_since_last).green()
                } else {
                    format!("{:>+5.2}", improvement_since_last).bright_black()
                }
            ));
        } else {
            progress.set_message(format!("Score: {:.0}", best_fitness));
            progress.println(format!(
                "  [{}] {} score={:>8.1} rest={}% │ {} score={:>8.1} rest={}% │ Δ={}%",
                format!("{:>3}", gen).bright_black(),
                "📊".bright_blue(),
                mean_fitness,
                format!("{:>3.0}", mean_rest).bright_black(),
                "🎯".bright_green(),
                best_fitness,
                format!("{:>3.0}", best_rest).bright_black(),
                if improvement_since_last > 0.0 {
                    format!("{:>+5.2}", improvement_since_last).green()
                } else {
                    format!("{:>+5.2}", improvement_since_last).bright_black()
                }
            ));
        }
    });

    // Finish progress bar
    if ga_result.converged_early {
        progress.finish_with_message(format!(
            "{} Converged at generation {} (no improvement larger than {}% for {} gens)",
            "".green(),
            ga_result.generations_run,
            CONVERGENCE_THRESHOLD * 100.0,
            CONVERGENCE_WINDOW
        ));
        println!();
    } else {
        progress.finish();
    }

    let hall_of_fame = ga_result.hall_of_fame;
    let pop = ga_result.final_population;

    // Determine output directory
    let out_dir = match &output_dir {
        Some(dir) => {
            let path = PathBuf::from(dir);
            fs::create_dir_all(&path).expect("Failed to create output directory");
            path
        }
        None => PathBuf::from("."),
    };

    if no_clustering {
        // =====================================================================
        // No clustering: Output best_by_score and best_by_dockq (old behavior)
        // =====================================================================

        let best_fitness_idx = pop
            .chromosomes
            .iter()
            .enumerate()
            .min_by(|(_, a), (_, b)| a.fitness.partial_cmp(&b.fitness).unwrap())
            .map(|(idx, _)| idx)
            .unwrap();

        let final_best_score = &pop.chromosomes[best_fitness_idx];

        println!("\n{}", "💾 Saving Results".bold().cyan());

        // Save best-by-score model
        let best_score_ligand = final_best_score.apply_genes(&ligand_clone);
        let best_score_complex = combine_molecules(&receptor_clone, &best_score_ligand);
        let best_score_path = out_dir.join("best_by_score.pdb");
        structure::write_pdb(
            &best_score_complex,
            best_score_path.to_string_lossy().as_ref(),
        );

        if let Some(ref e) = eval {
            let final_metrics = pop.eval_metrics(e);
            let best_dockq_idx = final_metrics
                .iter()
                .enumerate()
                .max_by(|(_, a), (_, b)| a.dockq.partial_cmp(&b.dockq).unwrap())
                .map(|(idx, _)| idx)
                .unwrap();

            let final_best_dockq = &pop.chromosomes[best_dockq_idx];
            let best_dockq_ligand = final_best_dockq.apply_genes(&ligand_clone);
            let best_dockq_complex = combine_molecules(&receptor_clone, &best_dockq_ligand);
            let best_dockq_path = out_dir.join("best_by_dockq.pdb");
            structure::write_pdb(
                &best_dockq_complex,
                best_dockq_path.to_string_lossy().as_ref(),
            );

            // Write metrics.tsv
            let best_score_metrics = &final_metrics[best_fitness_idx];
            let best_dockq_metrics = &final_metrics[best_dockq_idx];

            println!("\n{}", "📊 Final Metrics".bold().cyan());
            println!(
                "  {} DockQ={:.3} RMSD={:.2}Å iRMSD={:.2}Å FNAT={:.3}",
                "Best by score:".green(),
                best_score_metrics.dockq,
                best_score_metrics.rmsd,
                best_score_metrics.irmsd,
                best_score_metrics.fnat
            );
            println!(
                "  {} DockQ={:.3} RMSD={:.2}Å iRMSD={:.2}Å FNAT={:.3}",
                "Best by DockQ:".green(),
                best_dockq_metrics.dockq,
                best_dockq_metrics.rmsd,
                best_dockq_metrics.irmsd,
                best_dockq_metrics.fnat
            );

            let metrics_path = out_dir.join("metrics.tsv");
            let mut metrics_file =
                fs::File::create(&metrics_path).expect("Failed to create metrics file");
            writeln!(metrics_file, "model\tdockq\trmsd\tirmsd\tfnat\tscore").unwrap();
            writeln!(
                metrics_file,
                "best_by_score\t{:.4}\t{:.4}\t{:.4}\t{:.4}\t{:.4}",
                best_score_metrics.dockq,
                best_score_metrics.rmsd,
                best_score_metrics.irmsd,
                best_score_metrics.fnat,
                final_best_score.fitness
            )
            .unwrap();
            writeln!(
                metrics_file,
                "best_by_dockq\t{:.4}\t{:.4}\t{:.4}\t{:.4}\t{:.4}",
                best_dockq_metrics.dockq,
                best_dockq_metrics.rmsd,
                best_dockq_metrics.irmsd,
                best_dockq_metrics.fnat,
                final_best_dockq.fitness
            )
            .unwrap();

            println!("  {} {}", "".green(), best_score_path.display());
            println!("  {} {}", "".green(), best_dockq_path.display());
            println!("  {} {}", "".green(), metrics_path.display());
        } else {
            println!("  {} {}", "".green(), best_score_path.display());
        }
    } else {
        // =====================================================================
        // Clustering: Select diverse representative structures
        // =====================================================================

        // Report Hall of Fame status
        println!(
            "\n{} Collected {} diverse structures in Hall of Fame",
            "📦".bold(),
            hall_of_fame.len().to_string().cyan()
        );

        println!(
            "\n{}",
            "🔬 Clustering Hall of Fame structures".bold().cyan()
        );

        let hof_entries = hall_of_fame.entries();
        let selected = select_models(hof_entries, &receptor_clone, &ligand_clone);

        // Save output models and metrics
        println!("\n{}", "💾 Saving Results".bold().cyan());

        let metrics_path = out_dir.join("metrics.tsv");
        let mut metrics_file =
            fs::File::create(&metrics_path).expect("Failed to create metrics file");

        if eval.is_some() {
            writeln!(
                metrics_file,
                "model\tcluster_size\tscore\tdockq\trmsd\tirmsd\tfnat"
            )
            .unwrap();
        } else {
            writeln!(metrics_file, "model\tcluster_size\tscore").unwrap();
        }

        println!("\n{}", "📊 Output Models (FCC Clustered)".bold().cyan());

        for (model_num, (hof_idx, cluster_size)) in selected.clustered.iter().enumerate() {
            let entry = &hof_entries[*hof_idx];
            let model_name = format!("model_{}", model_num + 1);

            let ligand = ligand_clone
                .clone()
                .rotate(entry.genes[0], entry.genes[1], entry.genes[2])
                .displace(entry.genes[3], entry.genes[4], entry.genes[5]);
            let complex = combine_molecules(&receptor_clone, &ligand);

            let pdb_path = out_dir.join(format!("{}.pdb", model_name));
            structure::write_pdb(&complex, pdb_path.to_string_lossy().as_ref());

            if let Some(ref e) = eval {
                let metrics = e.calc_metrics(&ligand);

                writeln!(
                    metrics_file,
                    "{}\t{}\t{:.4}\t{:.4}\t{:.4}\t{:.4}\t{:.4}",
                    model_name,
                    cluster_size,
                    entry.fitness,
                    metrics.dockq,
                    metrics.rmsd,
                    metrics.irmsd,
                    metrics.fnat
                )
                .unwrap();

                let dockq_str = if metrics.dockq >= 0.80 {
                    format!("{:.3}", metrics.dockq).green()
                } else if metrics.dockq >= 0.49 {
                    format!("{:.3}", metrics.dockq).yellow()
                } else if metrics.dockq >= 0.23 {
                    format!("{:.3}", metrics.dockq).bright_yellow()
                } else {
                    format!("{:.3}", metrics.dockq).red()
                };

                println!(
                    "  {}: cluster={} score={:.1} DockQ={}",
                    model_name.green(),
                    format!("{:>3}", cluster_size).cyan(),
                    entry.fitness,
                    dockq_str
                );
            } else {
                writeln!(
                    metrics_file,
                    "{}\t{}\t{:.4}",
                    model_name, cluster_size, entry.fitness
                )
                .unwrap();

                println!(
                    "  {}: cluster={} score={:.1}",
                    model_name.green(),
                    format!("{:>3}", cluster_size).cyan(),
                    entry.fitness
                );
            }

            println!("    {} {}", "".bright_black(), pdb_path.display());
        }

        // =====================================================================
        // Also output top 5 by score (ranked_*.pdb)
        // =====================================================================

        println!("\n{}", "📊 Output Models (Ranked by Score)".bold().cyan());

        for (rank, hof_idx) in selected.ranked.iter().enumerate() {
            let entry = &hof_entries[*hof_idx];
            let model_name = format!("ranked_{}", rank + 1);

            let ligand = ligand_clone
                .clone()
                .rotate(entry.genes[0], entry.genes[1], entry.genes[2])
                .displace(entry.genes[3], entry.genes[4], entry.genes[5]);
            let complex = combine_molecules(&receptor_clone, &ligand);

            let pdb_path = out_dir.join(format!("{}.pdb", model_name));
            structure::write_pdb(&complex, pdb_path.to_string_lossy().as_ref());

            if let Some(ref e) = eval {
                let metrics = e.calc_metrics(&ligand);

                writeln!(
                    metrics_file,
                    "{}\t-\t{:.4}\t{:.4}\t{:.4}\t{:.4}\t{:.4}",
                    model_name,
                    entry.fitness,
                    metrics.dockq,
                    metrics.rmsd,
                    metrics.irmsd,
                    metrics.fnat
                )
                .unwrap();

                let dockq_str = if metrics.dockq >= 0.80 {
                    format!("{:.3}", metrics.dockq).green()
                } else if metrics.dockq >= 0.49 {
                    format!("{:.3}", metrics.dockq).yellow()
                } else if metrics.dockq >= 0.23 {
                    format!("{:.3}", metrics.dockq).bright_yellow()
                } else {
                    format!("{:.3}", metrics.dockq).red()
                };

                println!(
                    "  {}: score={:.1} DockQ={}",
                    model_name.green(),
                    entry.fitness,
                    dockq_str
                );
            } else {
                writeln!(metrics_file, "{}\t-\t{:.4}", model_name, entry.fitness).unwrap();

                println!("  {}: score={:.1}", model_name.green(), entry.fitness);
            }

            println!("    {} {}", "".bright_black(), pdb_path.display());
        }

        println!("    {} {}", "".bright_black(), metrics_path.display());
    }

    println!("\n{}", "✨ Done!".bold().green());
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_combine_molecules() {
        let receptor_model = read_pdb(&"data/2oob_A.pdb".to_string());
        let ligand_model = read_pdb(&"data/2oob_B.pdb".to_string());

        let receptor = &receptor_model.0[0];
        let ligand = &ligand_model.0[0];

        let combined = combine_molecules(receptor, ligand);

        assert_eq!(
            combined.0.len(),
            receptor.0.len() + ligand.0.len(),
            "Combined molecule should have all atoms from both"
        );
    }
}