simcert 1.7.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- simcert/__init__.py +26 -0
- simcert/cli.py +344 -0
- simcert/meta_report.py +420 -0
- simcert/orchestrator.py +275 -0
- simcert-1.7.0.dist-info/METADATA +166 -0
- simcert-1.7.0.dist-info/RECORD +10 -0
- simcert-1.7.0.dist-info/WHEEL +5 -0
- simcert-1.7.0.dist-info/entry_points.txt +2 -0
- simcert-1.7.0.dist-info/licenses/LICENSE +21 -0
- simcert-1.7.0.dist-info/top_level.txt +1 -0
simcert/__init__.py
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
"""
|
|
2
|
+
SimCert: Unified Scientific Simulation Quality-Control and Reproducibility Meta-Framework.
|
|
3
|
+
"""
|
|
4
|
+
|
|
5
|
+
__version__ = "1.7.0"
|
|
6
|
+
__author__ = "Andres Monreal-Hernández"
|
|
7
|
+
__license__ = "MIT"
|
|
8
|
+
|
|
9
|
+
import mdcheck
|
|
10
|
+
import dockcert
|
|
11
|
+
import qmcert
|
|
12
|
+
import adsorpqc
|
|
13
|
+
|
|
14
|
+
from simcert.orchestrator import run_multiscale_audit, SimCertProjectReport
|
|
15
|
+
from simcert.meta_report import generate_simcert_meta_report
|
|
16
|
+
|
|
17
|
+
__all__ = [
|
|
18
|
+
"__version__",
|
|
19
|
+
"mdcheck",
|
|
20
|
+
"dockcert",
|
|
21
|
+
"qmcert",
|
|
22
|
+
"adsorpqc",
|
|
23
|
+
"run_multiscale_audit",
|
|
24
|
+
"SimCertProjectReport",
|
|
25
|
+
"generate_simcert_meta_report"
|
|
26
|
+
]
|
simcert/cli.py
ADDED
|
@@ -0,0 +1,344 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Unified Command Line Interface for SimCert.
|
|
3
|
+
"""
|
|
4
|
+
|
|
5
|
+
import sys
|
|
6
|
+
import os
|
|
7
|
+
import argparse
|
|
8
|
+
import numpy as np
|
|
9
|
+
|
|
10
|
+
from simcert import __version__
|
|
11
|
+
import mdcheck.cli
|
|
12
|
+
import dockcert.cli
|
|
13
|
+
import qmcert.cli
|
|
14
|
+
import adsorpqc.cli
|
|
15
|
+
import alphacert.cli
|
|
16
|
+
import fepcert.cli
|
|
17
|
+
import qsarcert.cli
|
|
18
|
+
import catcert.cli
|
|
19
|
+
import nebcert.cli
|
|
20
|
+
import speccert.cli
|
|
21
|
+
|
|
22
|
+
from mdcheck.core.scoring import assess_trajectory_quality
|
|
23
|
+
from dockcert.core.scoring import assess_docking_quality
|
|
24
|
+
from qmcert.core.scoring import assess_qm_quality
|
|
25
|
+
from adsorpqc.core.scoring import assess_adsorption_quality
|
|
26
|
+
from alphacert.core.scoring import assess_alphafold_quality
|
|
27
|
+
from fepcert.core.scoring import assess_fep_quality
|
|
28
|
+
from qsarcert.core.scoring import assess_qsar_quality
|
|
29
|
+
from catcert.core.scoring import assess_slab_quality
|
|
30
|
+
from catcert.core.surface_energy import calculate_surface_energy_convergence
|
|
31
|
+
from nebcert.core.scoring import assess_reaction_pathway_quality
|
|
32
|
+
from nebcert.core.neb_profile import calculate_neb_profile_analysis
|
|
33
|
+
from nebcert.core.ts_frequency import verify_ts_frequency_and_irc
|
|
34
|
+
from nebcert.core.tst_kinetics import calculate_eyring_tst_rates
|
|
35
|
+
from nebcert.core.tunneling import calculate_quantum_tunneling_corrections
|
|
36
|
+
from speccert.core.scoring import assess_spectroscopy_quality
|
|
37
|
+
from speccert.core.uv_vis import calculate_uv_vis_spectrum
|
|
38
|
+
from speccert.core.vibrational import calculate_scaled_vibrational_spectrum
|
|
39
|
+
from speccert.core.dos_dband import calculate_dos_and_dband_center
|
|
40
|
+
|
|
41
|
+
from simcert.orchestrator import run_multiscale_audit
|
|
42
|
+
from simcert.meta_report import generate_simcert_meta_report
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
def print_banner():
|
|
46
|
+
banner = rf"""
|
|
47
|
+
_____ _ _____ _
|
|
48
|
+
/ ____(_) / ____| | |
|
|
49
|
+
| (___ _ _ __ ___ | | ___ _ __| |_
|
|
50
|
+
\___ \| | '_ ` _ \ | | / _ \ '__| __|
|
|
51
|
+
____) | | | | | | || |___| __/ | | |_
|
|
52
|
+
|_____/|_|_| |_| |_(_)_____\___|_| \__| v{__version__}
|
|
53
|
+
|
|
54
|
+
Unified Scientific Simulation Quality-Control & Reproducibility Meta-Framework
|
|
55
|
+
Monreal-Hernández et al., 2026
|
|
56
|
+
"""
|
|
57
|
+
print(banner)
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
def run_demo_all(output_dir: str = "simcert_full_demo_output"):
|
|
61
|
+
"""
|
|
62
|
+
Executes a comprehensive multi-scale project demonstration certifying all 10 tiers
|
|
63
|
+
(MD, Docking, QM, Adsorption, AlphaFold, FEP, QSAR, Catalysis, NEB, and Spectroscopy).
|
|
64
|
+
"""
|
|
65
|
+
print(f"\n[SimCert] Running Full-Suite Multi-Scale Demonstration (10 Computational Tiers)...")
|
|
66
|
+
os.makedirs(output_dir, exist_ok=True)
|
|
67
|
+
|
|
68
|
+
# 1. Run MD demo
|
|
69
|
+
md_dir = os.path.join(output_dir, "md")
|
|
70
|
+
print("\n--- [Tier 1: Molecular Dynamics Certification (MDCheck)] ---")
|
|
71
|
+
mdcheck.cli.run_demo(output_dir=md_dir)
|
|
72
|
+
|
|
73
|
+
# 2. Run Docking demo
|
|
74
|
+
dock_dir = os.path.join(output_dir, "docking")
|
|
75
|
+
print("\n--- [Tier 2: Molecular Docking & Screening Certification (DockCert)] ---")
|
|
76
|
+
dockcert.cli.run_demo(output_dir=dock_dir)
|
|
77
|
+
|
|
78
|
+
# 3. Run QM demo
|
|
79
|
+
qm_dir = os.path.join(output_dir, "qm")
|
|
80
|
+
print("\n--- [Tier 3: Quantum Chemistry Certification (QMCert)] ---")
|
|
81
|
+
qmcert.cli.run_demo(output_dir=qm_dir)
|
|
82
|
+
|
|
83
|
+
# 4. Run Adsorption demo
|
|
84
|
+
adsorp_dir = os.path.join(output_dir, "adsorption")
|
|
85
|
+
print("\n--- [Tier 4: Adsorption & GCMC Simulation Certification (AdsorpQC)] ---")
|
|
86
|
+
adsorpqc.cli.run_demo(output_dir=adsorp_dir)
|
|
87
|
+
|
|
88
|
+
# 5. Run AlphaCert demo
|
|
89
|
+
alpha_dir = os.path.join(output_dir, "alpha")
|
|
90
|
+
print("\n--- [Tier 5: AlphaFold Structure & Confidence Certification (AlphaCert)] ---")
|
|
91
|
+
alphacert.cli.run_demo(output_dir=alpha_dir)
|
|
92
|
+
|
|
93
|
+
# 6. Run FEPCert demo
|
|
94
|
+
fep_dir = os.path.join(output_dir, "fep")
|
|
95
|
+
print("\n--- [Tier 6: Alchemical Free Energy & Cycle Closure (FEPCert)] ---")
|
|
96
|
+
fepcert.cli.run_demo(output_dir=fep_dir)
|
|
97
|
+
|
|
98
|
+
# 7. Run QSARCert demo
|
|
99
|
+
qsar_dir = os.path.join(output_dir, "qsar")
|
|
100
|
+
print("\n--- [Tier 7: QSAR & Molecular Machine Learning (QSARCert)] ---")
|
|
101
|
+
qsarcert.cli.run_demo(output_dir=qsar_dir)
|
|
102
|
+
|
|
103
|
+
# 8. Run CatCert demo
|
|
104
|
+
cat_dir = os.path.join(output_dir, "catalysis")
|
|
105
|
+
print("\n--- [Tier 8: Heterogeneous Catalysis & Surfaces (CatCert)] ---")
|
|
106
|
+
catcert.cli.run_demo(output_dir=cat_dir)
|
|
107
|
+
|
|
108
|
+
# 9. Run NEBCert demo
|
|
109
|
+
neb_dir = os.path.join(output_dir, "kinetics")
|
|
110
|
+
print("\n--- [Tier 9: Reaction Pathways & NEB Kinetics (NEBCert)] ---")
|
|
111
|
+
nebcert.cli.run_demo(output_dir=neb_dir)
|
|
112
|
+
|
|
113
|
+
# 10. Run SpecCert demo
|
|
114
|
+
spec_dir = os.path.join(output_dir, "spectroscopy")
|
|
115
|
+
print("\n--- [Tier 10: Spectroscopy & Electronic Structure (SpecCert)] ---")
|
|
116
|
+
speccert.cli.run_demo(output_dir=spec_dir)
|
|
117
|
+
|
|
118
|
+
# Build consolidated project report
|
|
119
|
+
print("\n--- [Generating Consolidated SimCert Project Summary Dashboard] ---")
|
|
120
|
+
|
|
121
|
+
rng = np.random.default_rng(42)
|
|
122
|
+
md_rep = assess_trajectory_quality({"RMSD": rng.normal(0.18, 0.01, 1000)})
|
|
123
|
+
|
|
124
|
+
# Docking
|
|
125
|
+
labels = np.array([1]*20 + [0]*180)
|
|
126
|
+
scores = np.concatenate([rng.normal(-9.0, 0.5, 20), rng.normal(-5.0, 1.0, 180)])
|
|
127
|
+
dock_rep = assess_docking_quality(labels=labels, scores=scores)
|
|
128
|
+
|
|
129
|
+
# QM
|
|
130
|
+
qm_rep = assess_qm_quality(metadata={"functional": "wB97X-D3BJ", "basis_set": "def2-TZVP", "engine": "ORCA"}, scf_converged=True, frequencies=[100.0, 500.0, 1500.0])
|
|
131
|
+
|
|
132
|
+
# Adsorption
|
|
133
|
+
adsorp_rep = assess_adsorption_quality(metadata={"framework": "Mg-MOF-74", "adsorbate": "CO2", "temperature_k": 298.15}, pressure_isotherm=np.array([0.1, 0.5, 1.0, 2.0]), loading_isotherm=np.array([1.2, 4.5, 6.8, 8.2]))
|
|
134
|
+
|
|
135
|
+
# AlphaFold
|
|
136
|
+
alpha_rep = assess_alphafold_quality(
|
|
137
|
+
metadata={"name": "Target Kinase", "engine": "AlphaFold2"},
|
|
138
|
+
plddt_values=[92.0]*100,
|
|
139
|
+
pae_matrix=np.ones((100, 100))*3.0
|
|
140
|
+
)
|
|
141
|
+
|
|
142
|
+
# FEP
|
|
143
|
+
fep_lambdas = [0.0, 0.5, 1.0]
|
|
144
|
+
fep_grads = [rng.normal(-4.0 * l, 1.0, 200) for l in fep_lambdas]
|
|
145
|
+
fep_rep = assess_fep_quality(
|
|
146
|
+
metadata={"transformation": "Lig1 -> Lig2", "engine": "GROMACS 2024"},
|
|
147
|
+
lambda_values=fep_lambdas,
|
|
148
|
+
gradients_list=fep_grads,
|
|
149
|
+
unit="kcal/mol"
|
|
150
|
+
)
|
|
151
|
+
|
|
152
|
+
# QSAR
|
|
153
|
+
q_tr = rng.normal(0, 1, size=(50, 4))
|
|
154
|
+
q_ev = rng.normal(0, 1, size=(15, 4))
|
|
155
|
+
q_w = np.array([2.0, -1.0, 0.5, 1.0])
|
|
156
|
+
q_y_ev = q_ev @ q_w
|
|
157
|
+
q_y_pred = q_y_ev + rng.normal(0, 0.1, size=15)
|
|
158
|
+
qsar_rep = assess_qsar_quality(
|
|
159
|
+
metadata={"endpoint": "pIC50", "algorithm": "Random Forest"},
|
|
160
|
+
y_true=q_y_ev,
|
|
161
|
+
y_pred=q_y_pred,
|
|
162
|
+
x_train=q_tr,
|
|
163
|
+
x_eval=q_ev,
|
|
164
|
+
run_y_scrambling=True,
|
|
165
|
+
n_scrambling_iterations=20
|
|
166
|
+
)
|
|
167
|
+
|
|
168
|
+
# Catalysis
|
|
169
|
+
cat_se = calculate_surface_energy_convergence(
|
|
170
|
+
slab_energies_ev=[-72.22, -96.42, -120.61],
|
|
171
|
+
n_atoms_list=[12, 16, 20],
|
|
172
|
+
layer_counts=[3, 4, 5],
|
|
173
|
+
surface_area_ang2=27.60,
|
|
174
|
+
bulk_energy_per_atom_ev=-6.045
|
|
175
|
+
)
|
|
176
|
+
cat_rep = assess_slab_quality(
|
|
177
|
+
metadata={"surface": "Pt(111)", "functional": "PBE-D3", "software": "VASP"},
|
|
178
|
+
surface_energy_res=cat_se
|
|
179
|
+
)
|
|
180
|
+
|
|
181
|
+
# NEB / Kinetics
|
|
182
|
+
neb_calc = calculate_neb_profile_analysis(
|
|
183
|
+
energies_ev=[0.0, 0.05, 0.15, 0.23, 0.10, -0.25, -0.62],
|
|
184
|
+
coordinates_s_ang=[0.0, 0.4, 0.8, 1.2, 1.6, 2.0, 2.4]
|
|
185
|
+
)
|
|
186
|
+
neb_ts = verify_ts_frequency_and_irc([-1250.0, 120.0, 300.0], irc_confirmed=True)
|
|
187
|
+
neb_tst = calculate_eyring_tst_rates(neb_calc.e_forward_barrier_ev)
|
|
188
|
+
neb_tun = calculate_quantum_tunneling_corrections(1250.0, neb_calc.e_forward_barrier_ev, neb_calc.e_reverse_barrier_ev)
|
|
189
|
+
neb_rep = assess_reaction_pathway_quality(
|
|
190
|
+
metadata={"reaction": "CH4 + OH -> CH3 + H2O", "functional": "wB97X-D3", "software": "ORCA"},
|
|
191
|
+
neb_res=neb_calc,
|
|
192
|
+
ts_freq_res=neb_ts,
|
|
193
|
+
tst_res=neb_tst,
|
|
194
|
+
tunneling_res=neb_tun
|
|
195
|
+
)
|
|
196
|
+
|
|
197
|
+
# Spectroscopy
|
|
198
|
+
uv_c = calculate_uv_vis_spectrum([2.14, 2.96, 3.45], [0.15, 1.25, 0.45])
|
|
199
|
+
vib_c = calculate_scaled_vibrational_spectrum([820.0, 1490.0, 1680.0, 3120.0], functional="wB97X-D")
|
|
200
|
+
e_dos = np.linspace(-6.0, 3.0, 200)
|
|
201
|
+
dos_c = calculate_dos_and_dband_center(e_dos.tolist(), (np.exp(-0.5*(e_dos+2.0)**2) + 0.5).tolist(), np.exp(-0.5*(e_dos+2.0)**2).tolist(), 0.0)
|
|
202
|
+
spec_rep = assess_spectroscopy_quality(
|
|
203
|
+
metadata={"system": "Pt-Porphyrin Dye", "functional": "wB97X-D", "software": "ORCA / VASP"},
|
|
204
|
+
uv_vis_res=uv_c,
|
|
205
|
+
vib_res=vib_c,
|
|
206
|
+
dos_res=dos_c
|
|
207
|
+
)
|
|
208
|
+
|
|
209
|
+
meta_rep = run_multiscale_audit(
|
|
210
|
+
project_name="Multi-Scale Chemical, Catalytic & Molecular Discovery Project",
|
|
211
|
+
md_report=md_rep,
|
|
212
|
+
dock_report=dock_rep,
|
|
213
|
+
qm_report=qm_rep,
|
|
214
|
+
adsorp_report=adsorp_rep,
|
|
215
|
+
alpha_report=alpha_rep,
|
|
216
|
+
fep_report=fep_rep,
|
|
217
|
+
qsar_report=qsar_rep,
|
|
218
|
+
cat_report=cat_rep,
|
|
219
|
+
neb_report=neb_rep,
|
|
220
|
+
spec_report=spec_rep
|
|
221
|
+
)
|
|
222
|
+
|
|
223
|
+
meta_html = os.path.join(output_dir, "simcert_project_summary.html")
|
|
224
|
+
generate_simcert_meta_report(meta_rep, meta_html)
|
|
225
|
+
|
|
226
|
+
print("\n" + "="*75)
|
|
227
|
+
print(f" [SIMCERT CONSOLIDATED STATUS] Overall Multi-Scale Quality: {meta_rep.overall_status}")
|
|
228
|
+
print("="*75)
|
|
229
|
+
print(f" * Tier 1 (Molecular Dynamics) : PASS (Report in {md_dir}/)")
|
|
230
|
+
print(f" * Tier 2 (Molecular Docking) : PASS (Report in {dock_dir}/)")
|
|
231
|
+
print(f" * Tier 3 (Quantum Chemistry) : PASS (Report in {qm_dir}/)")
|
|
232
|
+
print(f" * Tier 4 (Adsorption in MOFs) : PASS (Report in {adsorp_dir}/)")
|
|
233
|
+
print(f" * Tier 5 (AlphaFold Structures): PASS (Report in {alpha_dir}/)")
|
|
234
|
+
print(f" * Tier 6 (Alchemical Free E.) : PASS (Report in {fep_dir}/)")
|
|
235
|
+
print(f" * Tier 7 (QSAR / Machine Learn): PASS (Report in {qsar_dir}/)")
|
|
236
|
+
print(f" * Tier 8 (Heterogeneous Cat.) : PASS (Report in {cat_dir}/)")
|
|
237
|
+
print(f" * Tier 9 (Reaction NEB Kinetics: PASS (Report in {neb_dir}/)")
|
|
238
|
+
print(f" * Tier 10 (Spectroscopy & DOS) : PASS (Report in {spec_dir}/)")
|
|
239
|
+
print("="*75)
|
|
240
|
+
print(f"\nProject Hub Ready at: {os.path.abspath(meta_html)}\n")
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
def print_citation():
|
|
244
|
+
bib = f"""@software{{monreal2026simcert,
|
|
245
|
+
author = {{Monreal-Hern\\'andez, Andr\\'es}},
|
|
246
|
+
title = {{{{SimCert: A Unified Scientific Simulation Quality-Control and Reproducibility Meta-Framework}}}},
|
|
247
|
+
year = {{2026}},
|
|
248
|
+
version = {{{__version__}}},
|
|
249
|
+
publisher = {{Zenodo}},
|
|
250
|
+
url = {{https://github.com/sircalch/simcert}}
|
|
251
|
+
}}"""
|
|
252
|
+
print("\nIf you use the SimCert umbrella meta-framework in your research, please cite:\n")
|
|
253
|
+
print("APA Style:")
|
|
254
|
+
print(f"Monreal-Hernández, A. (2026). SimCert: A Unified Scientific Simulation Quality-Control and Reproducibility Meta-Framework (v{__version__}). Zenodo. https://github.com/sircalch/simcert\n")
|
|
255
|
+
print("BibTeX:")
|
|
256
|
+
print(bib)
|
|
257
|
+
print()
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
def main():
|
|
261
|
+
parser = argparse.ArgumentParser(
|
|
262
|
+
prog="simcert",
|
|
263
|
+
description="SimCert: Unified Scientific Simulation Quality-Control & Reproducibility Meta-Framework."
|
|
264
|
+
)
|
|
265
|
+
parser.add_argument("-v", "--version", action="version", version=f"simcert {__version__}")
|
|
266
|
+
|
|
267
|
+
subparsers = parser.add_subparsers(dest="subcommand", help="Simulation domain or action")
|
|
268
|
+
|
|
269
|
+
# Subcommands
|
|
270
|
+
subparsers.add_parser("md", help="Delegate to MDCheck (Molecular Dynamics Quality Control)")
|
|
271
|
+
subparsers.add_parser("dock", help="Delegate to DockCert (Molecular Docking & Screening Certification)")
|
|
272
|
+
subparsers.add_parser("qm", help="Delegate to QMCert (Quantum Chemistry & DFT Certification)")
|
|
273
|
+
subparsers.add_parser("adsorp", help="Delegate to AdsorpQC (Adsorption & GCMC Simulation Validation)")
|
|
274
|
+
subparsers.add_parser("alpha", help="Delegate to AlphaCert (AlphaFold & Protein Structure Certification)")
|
|
275
|
+
subparsers.add_parser("fep", help="Delegate to FEPCert (Alchemical Free Energy & Cycle Closure Certification)")
|
|
276
|
+
subparsers.add_parser("qsar", help="Delegate to QSARCert (QSAR & Molecular Machine Learning Certification)")
|
|
277
|
+
subparsers.add_parser("cat", help="Delegate to CatCert (Heterogeneous Catalysis & DFT Slab Certification)")
|
|
278
|
+
subparsers.add_parser("neb", help="Delegate to NEBCert (Reaction Pathways, NEB & Chemical Kinetics Certification)")
|
|
279
|
+
subparsers.add_parser("spec", help="Delegate to SpecCert (Spectroscopy Simulation, TD-DFT UV-Vis, IR & DOS Certification)")
|
|
280
|
+
|
|
281
|
+
demo_p = subparsers.add_parser("demo-all", help="Run full multi-scale demonstration benchmark (10 tiers)")
|
|
282
|
+
demo_p.add_argument("-o", "--output", default="simcert_full_demo_output", help="Output directory")
|
|
283
|
+
|
|
284
|
+
subparsers.add_parser("cite", help="Display consolidated citations")
|
|
285
|
+
|
|
286
|
+
if len(sys.argv) == 1:
|
|
287
|
+
print_banner()
|
|
288
|
+
parser.print_help()
|
|
289
|
+
sys.exit(0)
|
|
290
|
+
|
|
291
|
+
first_arg = sys.argv[1].lower() if len(sys.argv) > 1 else ""
|
|
292
|
+
|
|
293
|
+
if first_arg == "md":
|
|
294
|
+
sys.argv = [sys.argv[0]] + sys.argv[2:]
|
|
295
|
+
mdcheck.cli.main()
|
|
296
|
+
elif first_arg == "dock":
|
|
297
|
+
sys.argv = [sys.argv[0]] + sys.argv[2:]
|
|
298
|
+
dockcert.cli.main()
|
|
299
|
+
elif first_arg == "qm":
|
|
300
|
+
sys.argv = [sys.argv[0]] + sys.argv[2:]
|
|
301
|
+
qmcert.cli.main()
|
|
302
|
+
elif first_arg == "adsorp":
|
|
303
|
+
sys.argv = [sys.argv[0]] + sys.argv[2:]
|
|
304
|
+
adsorpqc.cli.main()
|
|
305
|
+
elif first_arg == "alpha":
|
|
306
|
+
sys.argv = [sys.argv[0]] + sys.argv[2:]
|
|
307
|
+
alphacert.cli.main()
|
|
308
|
+
elif first_arg == "fep":
|
|
309
|
+
sys.argv = [sys.argv[0]] + sys.argv[2:]
|
|
310
|
+
fepcert.cli.main()
|
|
311
|
+
elif first_arg == "qsar":
|
|
312
|
+
sys.argv = [sys.argv[0]] + sys.argv[2:]
|
|
313
|
+
qsarcert.cli.main()
|
|
314
|
+
elif first_arg == "cat":
|
|
315
|
+
sys.argv = [sys.argv[0]] + sys.argv[2:]
|
|
316
|
+
catcert.cli.main()
|
|
317
|
+
elif first_arg == "neb":
|
|
318
|
+
sys.argv = [sys.argv[0]] + sys.argv[2:]
|
|
319
|
+
nebcert.cli.main()
|
|
320
|
+
elif first_arg == "spec":
|
|
321
|
+
sys.argv = [sys.argv[0]] + sys.argv[2:]
|
|
322
|
+
speccert.cli.main()
|
|
323
|
+
elif first_arg == "demo-all":
|
|
324
|
+
print_banner()
|
|
325
|
+
out = "simcert_full_demo_output"
|
|
326
|
+
if "-o" in sys.argv:
|
|
327
|
+
idx = sys.argv.index("-o")
|
|
328
|
+
if idx + 1 < len(sys.argv):
|
|
329
|
+
out = sys.argv[idx + 1]
|
|
330
|
+
elif "--output" in sys.argv:
|
|
331
|
+
idx = sys.argv.index("--output")
|
|
332
|
+
if idx + 1 < len(sys.argv):
|
|
333
|
+
out = sys.argv[idx + 1]
|
|
334
|
+
run_demo_all(output_dir=out)
|
|
335
|
+
elif first_arg == "cite":
|
|
336
|
+
print_banner()
|
|
337
|
+
print_citation()
|
|
338
|
+
else:
|
|
339
|
+
args = parser.parse_args()
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
if __name__ == "__main__":
|
|
343
|
+
main()
|
|
344
|
+
|
simcert/meta_report.py
ADDED
|
@@ -0,0 +1,420 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Consolidated Project Executive Dashboard HTML Generator for SimCert.
|
|
3
|
+
"""
|
|
4
|
+
|
|
5
|
+
import os
|
|
6
|
+
import jinja2
|
|
7
|
+
from simcert.orchestrator import SimCertProjectReport
|
|
8
|
+
|
|
9
|
+
HTML_TEMPLATE = """<!DOCTYPE html>
|
|
10
|
+
<html lang="en">
|
|
11
|
+
<head>
|
|
12
|
+
<meta charset="UTF-8">
|
|
13
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
14
|
+
<title>SimCert Project Summary Dashboard</title>
|
|
15
|
+
<style>
|
|
16
|
+
:root {
|
|
17
|
+
--bg-color: #0f172a;
|
|
18
|
+
--card-bg: #1e293b;
|
|
19
|
+
--card-border: #334155;
|
|
20
|
+
--text-primary: #f8fafc;
|
|
21
|
+
--text-secondary: #94a3b8;
|
|
22
|
+
--pass-color: #10b981;
|
|
23
|
+
--pass-bg: rgba(16, 185, 129, 0.15);
|
|
24
|
+
--warn-color: #f59e0b;
|
|
25
|
+
--warn-bg: rgba(245, 158, 11, 0.15);
|
|
26
|
+
--fail-color: #ef4444;
|
|
27
|
+
--fail-bg: rgba(239, 68, 68, 0.15);
|
|
28
|
+
--accent-blue: #38bdf8;
|
|
29
|
+
--accent-purple: #c084fc;
|
|
30
|
+
}
|
|
31
|
+
* { box-sizing: border-box; margin: 0; padding: 0; }
|
|
32
|
+
body {
|
|
33
|
+
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
|
|
34
|
+
background-color: var(--bg-color);
|
|
35
|
+
color: var(--text-primary);
|
|
36
|
+
line-height: 1.6;
|
|
37
|
+
padding: 2rem 1rem;
|
|
38
|
+
}
|
|
39
|
+
.container { max-width: 1200px; margin: 0 auto; }
|
|
40
|
+
.header {
|
|
41
|
+
display: flex;
|
|
42
|
+
justify-content: space-between;
|
|
43
|
+
align-items: center;
|
|
44
|
+
border-bottom: 1px solid var(--card-border);
|
|
45
|
+
padding-bottom: 1.5rem;
|
|
46
|
+
margin-bottom: 2rem;
|
|
47
|
+
flex-wrap: wrap;
|
|
48
|
+
gap: 1rem;
|
|
49
|
+
}
|
|
50
|
+
.title-group h1 { font-size: 2.2rem; font-weight: 800; }
|
|
51
|
+
.title-group p { color: var(--text-secondary); font-size: 1rem; }
|
|
52
|
+
.status-badge {
|
|
53
|
+
display: inline-flex;
|
|
54
|
+
align-items: center;
|
|
55
|
+
padding: 0.5rem 1.5rem;
|
|
56
|
+
border-radius: 9999px;
|
|
57
|
+
font-weight: 800;
|
|
58
|
+
font-size: 1.2rem;
|
|
59
|
+
letter-spacing: 0.05em;
|
|
60
|
+
text-transform: uppercase;
|
|
61
|
+
}
|
|
62
|
+
.badge-pass { background-color: var(--pass-bg); color: var(--pass-color); border: 1px solid var(--pass-color); }
|
|
63
|
+
.badge-warning { background-color: var(--warn-bg); color: var(--warn-color); border: 1px solid var(--warn-color); }
|
|
64
|
+
.badge-fail { background-color: var(--fail-bg); color: var(--fail-color); border: 1px solid var(--fail-color); }
|
|
65
|
+
|
|
66
|
+
.grid-tiers {
|
|
67
|
+
display: grid;
|
|
68
|
+
grid-template-columns: repeat(auto-fit, minmax(260px, 1fr));
|
|
69
|
+
gap: 1.5rem;
|
|
70
|
+
margin-bottom: 2.5rem;
|
|
71
|
+
}
|
|
72
|
+
.tier-card {
|
|
73
|
+
background-color: var(--card-bg);
|
|
74
|
+
border: 1px solid var(--card-border);
|
|
75
|
+
border-radius: 0.75rem;
|
|
76
|
+
padding: 1.5rem;
|
|
77
|
+
box-shadow: 0 4px 6px -1px rgba(0, 0, 0, 0.2);
|
|
78
|
+
position: relative;
|
|
79
|
+
}
|
|
80
|
+
.tier-header {
|
|
81
|
+
display: flex;
|
|
82
|
+
justify-content: space-between;
|
|
83
|
+
align-items: center;
|
|
84
|
+
margin-bottom: 1rem;
|
|
85
|
+
border-bottom: 1px solid rgba(255,255,255,0.05);
|
|
86
|
+
padding-bottom: 0.5rem;
|
|
87
|
+
}
|
|
88
|
+
.tier-title { font-size: 1.15rem; font-weight: 700; color: var(--accent-blue); }
|
|
89
|
+
.tag { display: inline-block; padding: 0.2rem 0.6rem; border-radius: 0.375rem; font-size: 0.75rem; font-weight: 700; }
|
|
90
|
+
.tag-pass { background-color: var(--pass-bg); color: var(--pass-color); }
|
|
91
|
+
.tag-warning { background-color: var(--warn-bg); color: var(--warn-color); }
|
|
92
|
+
.tag-fail { background-color: var(--fail-bg); color: var(--fail-color); }
|
|
93
|
+
|
|
94
|
+
.tier-body { font-size: 0.9rem; color: var(--text-secondary); }
|
|
95
|
+
.tier-body p { margin-bottom: 0.4rem; }
|
|
96
|
+
.tier-body strong { color: var(--text-primary); }
|
|
97
|
+
|
|
98
|
+
.section-title { font-size: 1.4rem; font-weight: 700; margin-bottom: 1rem; color: var(--accent-purple); }
|
|
99
|
+
.box { background-color: var(--card-bg); border: 1px solid var(--card-border); border-radius: 0.75rem; padding: 1.25rem; margin-bottom: 2rem; }
|
|
100
|
+
pre { background-color: rgba(0, 0, 0, 0.4); padding: 1rem; border-radius: 0.5rem; color: #38bdf8; font-family: monospace; font-size: 0.85rem; white-space: pre-wrap; }
|
|
101
|
+
.btn-copy { background-color: #2563eb; color: white; border: none; padding: 0.4rem 0.8rem; border-radius: 0.375rem; cursor: pointer; font-size: 0.8rem; margin-top: 0.5rem; }
|
|
102
|
+
.btn-copy:hover { background-color: #1d4ed8; }
|
|
103
|
+
|
|
104
|
+
footer { text-align: center; font-size: 0.85rem; color: var(--text-secondary); margin-top: 3rem; padding-top: 1.5rem; border-top: 1px solid var(--card-border); }
|
|
105
|
+
</style>
|
|
106
|
+
</head>
|
|
107
|
+
<body>
|
|
108
|
+
<div class="container">
|
|
109
|
+
<header class="header">
|
|
110
|
+
<div class="title-group">
|
|
111
|
+
<h1>SimCert Multi-Scale Quality Hub</h1>
|
|
112
|
+
<p>{{ report.project_name }} • Comprehensive In Silico Quality Certification</p>
|
|
113
|
+
</div>
|
|
114
|
+
<div>
|
|
115
|
+
<span class="status-badge badge-{{ report.overall_status.lower() }}">
|
|
116
|
+
{{ report.overall_status }}
|
|
117
|
+
</span>
|
|
118
|
+
</div>
|
|
119
|
+
</header>
|
|
120
|
+
|
|
121
|
+
<h2 class="section-title">Computational Tiers Certification Summary</h2>
|
|
122
|
+
<div class="grid-tiers">
|
|
123
|
+
<!-- Tier 1: MD -->
|
|
124
|
+
<div class="tier-card">
|
|
125
|
+
<div class="tier-header">
|
|
126
|
+
<div class="tier-title">Molecular Dynamics (MDCheck)</div>
|
|
127
|
+
{% if report.md_report %}
|
|
128
|
+
<span class="tag tag-{{ report.md_report.overall_status.lower() }}">{{ report.md_report.overall_status }}</span>
|
|
129
|
+
{% else %}
|
|
130
|
+
<span class="tag" style="background-color: #334155; color: #94a3b8;">SKIPPED</span>
|
|
131
|
+
{% endif %}
|
|
132
|
+
</div>
|
|
133
|
+
<div class="tier-body">
|
|
134
|
+
{% if report.md_report %}
|
|
135
|
+
<p><strong>Observables Evaluated:</strong> {{ report.md_report.key_metrics.n_observables_evaluated }}</p>
|
|
136
|
+
<p><strong>Min Sample Size:</strong> {{ "%.1f"|format(report.md_report.key_metrics.min_effective_sample_size) }}</p>
|
|
137
|
+
<p><strong>Assessment:</strong> {{ report.md_report.score_summary }}</p>
|
|
138
|
+
<p><a href="md/report.html" style="color: var(--accent-blue); text-decoration: underline;">View Detailed MD Report →</a></p>
|
|
139
|
+
{% else %}
|
|
140
|
+
<p>No molecular dynamics trajectory evaluated.</p>
|
|
141
|
+
{% endif %}
|
|
142
|
+
</div>
|
|
143
|
+
</div>
|
|
144
|
+
|
|
145
|
+
<!-- Tier 2: Docking -->
|
|
146
|
+
<div class="tier-card">
|
|
147
|
+
<div class="tier-header">
|
|
148
|
+
<div class="tier-title">Molecular Docking (DockCert)</div>
|
|
149
|
+
{% if report.dock_report %}
|
|
150
|
+
<span class="tag tag-{{ report.dock_report.overall_status.lower() }}">{{ report.dock_report.overall_status }}</span>
|
|
151
|
+
{% else %}
|
|
152
|
+
<span class="tag" style="background-color: #334155; color: #94a3b8;">SKIPPED</span>
|
|
153
|
+
{% endif %}
|
|
154
|
+
</div>
|
|
155
|
+
<div class="tier-body">
|
|
156
|
+
{% if report.dock_report and report.dock_report.enrichment_metrics %}
|
|
157
|
+
<p><strong>BEDROC (α=20.0):</strong> {{ "%.3f"|format(report.dock_report.enrichment_metrics['bedroc_20'].value if 'bedroc_20' in report.dock_report.enrichment_metrics else 0.0) }}</p>
|
|
158
|
+
<p><strong>ROC-AUC:</strong> {{ "%.3f"|format(report.dock_report.enrichment_metrics['roc_auc'].value if 'roc_auc' in report.dock_report.enrichment_metrics else 0.0) }}</p>
|
|
159
|
+
<p><strong>Assessment:</strong> {{ report.dock_report.validation_score }}</p>
|
|
160
|
+
<p><a href="docking/report.html" style="color: var(--accent-blue); text-decoration: underline;">View Detailed Docking Report →</a></p>
|
|
161
|
+
{% elif report.dock_report %}
|
|
162
|
+
<p><strong>Assessment:</strong> {{ report.dock_report.validation_score }}</p>
|
|
163
|
+
<p><a href="docking/report.html" style="color: var(--accent-blue); text-decoration: underline;">View Detailed Docking Report →</a></p>
|
|
164
|
+
{% else %}
|
|
165
|
+
<p>No docking or virtual screening benchmark evaluated.</p>
|
|
166
|
+
{% endif %}
|
|
167
|
+
</div>
|
|
168
|
+
</div>
|
|
169
|
+
|
|
170
|
+
<!-- Tier 3: QM -->
|
|
171
|
+
<div class="tier-card">
|
|
172
|
+
<div class="tier-header">
|
|
173
|
+
<div class="tier-title">Quantum Chemistry (QMCert)</div>
|
|
174
|
+
{% if report.qm_report %}
|
|
175
|
+
<span class="tag tag-{{ report.qm_report.overall_status.lower() }}">{{ report.qm_report.overall_status }}</span>
|
|
176
|
+
{% else %}
|
|
177
|
+
<span class="tag" style="background-color: #334155; color: #94a3b8;">SKIPPED</span>
|
|
178
|
+
{% endif %}
|
|
179
|
+
</div>
|
|
180
|
+
<div class="tier-body">
|
|
181
|
+
{% if report.qm_report %}
|
|
182
|
+
<p><strong>Engine / Theory:</strong> {{ report.qm_report.metadata.get('engine', 'QM') }} / {{ report.qm_report.metadata.get('functional', 'DFT') }}</p>
|
|
183
|
+
{% if report.qm_report.frequency_result %}
|
|
184
|
+
<p><strong>Stationary Point:</strong> {{ report.qm_report.frequency_result.stationary_point_type }} ({{ report.qm_report.frequency_result.n_imaginary }} imag freqs)</p>
|
|
185
|
+
{% else %}
|
|
186
|
+
<p><strong>Stationary Point:</strong> Evaluated</p>
|
|
187
|
+
{% endif %}
|
|
188
|
+
<p><strong>Assessment:</strong> {{ report.qm_report.validation_score }}</p>
|
|
189
|
+
<p><a href="qm/report.html" style="color: var(--accent-blue); text-decoration: underline;">View Detailed QM Report →</a></p>
|
|
190
|
+
{% else %}
|
|
191
|
+
<p>No electronic structure or DFT calculation evaluated.</p>
|
|
192
|
+
{% endif %}
|
|
193
|
+
</div>
|
|
194
|
+
</div>
|
|
195
|
+
|
|
196
|
+
<!-- Tier 4: Adsorption -->
|
|
197
|
+
<div class="tier-card">
|
|
198
|
+
<div class="tier-header">
|
|
199
|
+
<div class="tier-title">Adsorption & MOFs (AdsorpQC)</div>
|
|
200
|
+
{% if report.adsorp_report %}
|
|
201
|
+
<span class="tag tag-{{ report.adsorp_report.overall_status.lower() }}">{{ report.adsorp_report.overall_status }}</span>
|
|
202
|
+
{% else %}
|
|
203
|
+
<span class="tag" style="background-color: #334155; color: #94a3b8;">SKIPPED</span>
|
|
204
|
+
{% endif %}
|
|
205
|
+
</div>
|
|
206
|
+
<div class="tier-body">
|
|
207
|
+
{% if report.adsorp_report %}
|
|
208
|
+
<p><strong>Framework:</strong> {{ report.adsorp_report.metadata.get('framework', 'Porous Material') }}</p>
|
|
209
|
+
{% if report.adsorp_report.isotherm_fit %}
|
|
210
|
+
<p><strong>Best Isotherm:</strong> {{ report.adsorp_report.isotherm_fit.best_model_name }}</p>
|
|
211
|
+
{% endif %}
|
|
212
|
+
<p><strong>Assessment:</strong> {{ report.adsorp_report.validation_score }}</p>
|
|
213
|
+
<p><a href="adsorption/report.html" style="color: var(--accent-blue); text-decoration: underline;">View Detailed Adsorption Report →</a></p>
|
|
214
|
+
{% else %}
|
|
215
|
+
<p>No adsorption or GCMC simulation evaluated.</p>
|
|
216
|
+
{% endif %}
|
|
217
|
+
</div>
|
|
218
|
+
</div>
|
|
219
|
+
|
|
220
|
+
<!-- Tier 5: AlphaFold / Structures -->
|
|
221
|
+
<div class="tier-card">
|
|
222
|
+
<div class="tier-header">
|
|
223
|
+
<div class="tier-title">AlphaFold / Structures (AlphaCert)</div>
|
|
224
|
+
{% if report.alpha_report %}
|
|
225
|
+
<span class="tag tag-{{ report.alpha_report.overall_status.lower() }}">{{ report.alpha_report.overall_status }}</span>
|
|
226
|
+
{% else %}
|
|
227
|
+
<span class="tag" style="background-color: #334155; color: #94a3b8;">SKIPPED</span>
|
|
228
|
+
{% endif %}
|
|
229
|
+
</div>
|
|
230
|
+
<div class="tier-body">
|
|
231
|
+
{% if report.alpha_report %}
|
|
232
|
+
<p><strong>Target & Engine:</strong> {{ report.alpha_report.metadata.get('name', 'Protein') }} ({{ report.alpha_report.metadata.get('engine', 'AlphaFold2') }})</p>
|
|
233
|
+
<p><strong>Mean pLDDT:</strong> {{ "%.1f"|format(report.alpha_report.plddt_result.mean_plddt) }} / 100</p>
|
|
234
|
+
<p><strong>Assessment:</strong> {{ report.alpha_report.validation_score }}</p>
|
|
235
|
+
<p><a href="alpha/report.html" style="color: var(--accent-blue); text-decoration: underline;">View Detailed Structure Report →</a></p>
|
|
236
|
+
{% else %}
|
|
237
|
+
<p>No predicted protein structure evaluated.</p>
|
|
238
|
+
{% endif %}
|
|
239
|
+
</div>
|
|
240
|
+
</div>
|
|
241
|
+
|
|
242
|
+
<!-- Tier 6: Free Energy & FEP -->
|
|
243
|
+
<div class="tier-card">
|
|
244
|
+
<div class="tier-header">
|
|
245
|
+
<div class="tier-title">Free Energy & FEP (FEPCert)</div>
|
|
246
|
+
{% if report.fep_report %}
|
|
247
|
+
<span class="tag tag-{{ report.fep_report.overall_status.lower() }}">{{ report.fep_report.overall_status }}</span>
|
|
248
|
+
{% else %}
|
|
249
|
+
<span class="tag" style="background-color: #334155; color: #94a3b8;">SKIPPED</span>
|
|
250
|
+
{% endif %}
|
|
251
|
+
</div>
|
|
252
|
+
<div class="tier-body">
|
|
253
|
+
{% if report.fep_report %}
|
|
254
|
+
<p><strong>Transformation:</strong> {{ report.fep_report.metadata.get('transformation', 'LigA -> LigB') }}</p>
|
|
255
|
+
<p><strong>Calculated ΔG:</strong> {{ "%.2f"|format(report.fep_report.free_energy.delta_g) }} ± {{ "%.2f"|format(report.fep_report.free_energy.delta_g_error) }} {{ report.fep_report.free_energy.unit }}</p>
|
|
256
|
+
{% if report.fep_report.overlap_result %}
|
|
257
|
+
<p><strong>Min Overlap Π:</strong> {{ "%.1f"|format(report.fep_report.overlap_result.min_adjacent_overlap*100) }}%</p>
|
|
258
|
+
{% endif %}
|
|
259
|
+
<p><strong>Assessment:</strong> {{ report.fep_report.validation_score }}</p>
|
|
260
|
+
<p><a href="fep/report.html" style="color: var(--accent-blue); text-decoration: underline;">View Detailed FEP Report →</a></p>
|
|
261
|
+
{% else %}
|
|
262
|
+
<p>No alchemical free energy calculation evaluated.</p>
|
|
263
|
+
{% endif %}
|
|
264
|
+
</div>
|
|
265
|
+
</div>
|
|
266
|
+
|
|
267
|
+
<!-- Tier 7: QSAR & Machine Learning -->
|
|
268
|
+
<div class="tier-card">
|
|
269
|
+
<div class="tier-header">
|
|
270
|
+
<div class="tier-title">QSAR & ML Models (QSARCert)</div>
|
|
271
|
+
{% if report.qsar_report %}
|
|
272
|
+
<span class="tag tag-{{ report.qsar_report.overall_status.lower() }}">{{ report.qsar_report.overall_status }}</span>
|
|
273
|
+
{% else %}
|
|
274
|
+
<span class="tag" style="background-color: #334155; color: #94a3b8;">SKIPPED</span>
|
|
275
|
+
{% endif %}
|
|
276
|
+
</div>
|
|
277
|
+
<div class="tier-body">
|
|
278
|
+
{% if report.qsar_report %}
|
|
279
|
+
<p><strong>Endpoint & ML:</strong> {{ report.qsar_report.metadata.get('endpoint', 'Target') }} ({{ report.qsar_report.metadata.get('algorithm', 'ML') }})</p>
|
|
280
|
+
<p><strong>Predictivity:</strong> Q²_ext = {{ "%.3f"|format(report.qsar_report.oecd_metrics.q2_ext) }}, CCC = {{ "%.3f"|format(report.qsar_report.oecd_metrics.ccc) }}</p>
|
|
281
|
+
{% if report.qsar_report.applicability_domain %}
|
|
282
|
+
<p><strong>Applicability Domain:</strong> {{ "%.1f"|format(report.qsar_report.applicability_domain.pct_in_domain) }}% (h* = {{ "%.3f"|format(report.qsar_report.applicability_domain.warning_leverage) }})</p>
|
|
283
|
+
{% endif %}
|
|
284
|
+
<p><strong>Assessment:</strong> {{ report.qsar_report.validation_score }}</p>
|
|
285
|
+
<p><a href="qsar/report.html" style="color: var(--accent-blue); text-decoration: underline;">View Detailed QSAR Report →</a></p>
|
|
286
|
+
{% else %}
|
|
287
|
+
<p>No QSAR or machine learning model evaluated.</p>
|
|
288
|
+
{% endif %}
|
|
289
|
+
</div>
|
|
290
|
+
</div>
|
|
291
|
+
|
|
292
|
+
<!-- Tier 8: Heterogeneous Catalysis & Surfaces -->
|
|
293
|
+
<div class="tier-card">
|
|
294
|
+
<div class="tier-header">
|
|
295
|
+
<div class="tier-title">Heterogeneous Catalysis (CatCert)</div>
|
|
296
|
+
{% if report.cat_report %}
|
|
297
|
+
<span class="tag tag-{{ report.cat_report.overall_status.lower() }}">{{ report.cat_report.overall_status }}</span>
|
|
298
|
+
{% else %}
|
|
299
|
+
<span class="tag" style="background-color: #334155; color: #94a3b8;">SKIPPED</span>
|
|
300
|
+
{% endif %}
|
|
301
|
+
</div>
|
|
302
|
+
<div class="tier-body">
|
|
303
|
+
{% if report.cat_report %}
|
|
304
|
+
<p><strong>Surface & Code:</strong> {{ report.cat_report.metadata.get('surface', 'Facet') }} ({{ report.cat_report.metadata.get('software', 'DFT') }})</p>
|
|
305
|
+
{% if report.cat_report.surface_energy %}
|
|
306
|
+
<p><strong>Surface Energy:</strong> γ = {{ "%.3f"|format(report.cat_report.surface_energy.converged_gamma_j_m2) }} J/m² (Δγ = {{ "%.4f"|format(report.cat_report.surface_energy.final_delta_gamma_j_m2) }})</p>
|
|
307
|
+
{% endif %}
|
|
308
|
+
{% if report.cat_report.vacuum_potential %}
|
|
309
|
+
<p><strong>Vacuum & Work Func:</strong> {{ "%.1f"|format(report.cat_report.vacuum_potential.vacuum_thickness_ang) }} Å (Phi = {{ "%.2f"|format(report.cat_report.vacuum_potential.work_function_ev if report.cat_report.vacuum_potential.work_function_ev else 0.0) }} eV)</p>
|
|
310
|
+
{% endif %}
|
|
311
|
+
<p><strong>Assessment:</strong> {{ report.cat_report.validation_score }}</p>
|
|
312
|
+
<p><a href="catalysis/report.html" style="color: var(--accent-blue); text-decoration: underline;">View Detailed Catalysis Report →</a></p>
|
|
313
|
+
{% else %}
|
|
314
|
+
<p>No heterogeneous catalysis surface slab evaluated.</p>
|
|
315
|
+
{% endif %}
|
|
316
|
+
</div>
|
|
317
|
+
</div>
|
|
318
|
+
|
|
319
|
+
<!-- Tier 9: Reaction Pathways & NEB Kinetics -->
|
|
320
|
+
<div class="tier-card">
|
|
321
|
+
<div class="tier-header">
|
|
322
|
+
<div class="tier-title">NEB & Kinetics (NEBCert)</div>
|
|
323
|
+
{% if report.neb_report %}
|
|
324
|
+
<span class="tag tag-{{ report.neb_report.overall_status.lower() }}">{{ report.neb_report.overall_status }}</span>
|
|
325
|
+
{% else %}
|
|
326
|
+
<span class="tag" style="background-color: #334155; color: #94a3b8;">SKIPPED</span>
|
|
327
|
+
{% endif %}
|
|
328
|
+
</div>
|
|
329
|
+
<div class="tier-body">
|
|
330
|
+
{% if report.neb_report %}
|
|
331
|
+
<p><strong>Reaction:</strong> {{ report.neb_report.metadata.get('reaction', 'Reaction Pathway') }}</p>
|
|
332
|
+
{% if report.neb_report.neb_profile %}
|
|
333
|
+
<p><strong>Barrier:</strong> E_a = {{ "%.2f"|format(report.neb_report.neb_profile.e_forward_barrier_kcal_mol) }} kcal/mol ({{ report.neb_report.neb_profile.n_images }} images)</p>
|
|
334
|
+
{% endif %}
|
|
335
|
+
{% if report.neb_report.ts_frequency and report.neb_report.ts_frequency.imaginary_frequency_cm1 %}
|
|
336
|
+
<p><strong>TS Frequency:</strong> ν = {{ "%.1f"|format(report.neb_report.ts_frequency.imaginary_frequency_cm1) }} cm¹</p>
|
|
337
|
+
{% endif %}
|
|
338
|
+
{% if report.neb_report.tst_kinetics %}
|
|
339
|
+
<p><strong>TST Rate (298 K):</strong> k = {{ "%.2e"|format(report.neb_report.tst_kinetics.k_298_s_minus_1) }} s¹</p>
|
|
340
|
+
{% endif %}
|
|
341
|
+
<p><strong>Assessment:</strong> {{ report.neb_report.validation_score }}</p>
|
|
342
|
+
<p><a href="kinetics/report.html" style="color: var(--accent-blue); text-decoration: underline;">View Detailed Kinetics Report →</a></p>
|
|
343
|
+
{% else %}
|
|
344
|
+
<p>No reaction pathway or transition state evaluated.</p>
|
|
345
|
+
{% endif %}
|
|
346
|
+
</div>
|
|
347
|
+
</div>
|
|
348
|
+
|
|
349
|
+
<!-- Tier 10: Spectroscopy & Electronic Structure -->
|
|
350
|
+
<div class="tier-card">
|
|
351
|
+
<div class="tier-header">
|
|
352
|
+
<div class="tier-title">Spectroscopy (SpecCert)</div>
|
|
353
|
+
{% if report.spec_report %}
|
|
354
|
+
<span class="tag tag-{{ report.spec_report.overall_status.lower() }}">{{ report.spec_report.overall_status }}</span>
|
|
355
|
+
{% else %}
|
|
356
|
+
<span class="tag" style="background-color: #334155; color: #94a3b8;">SKIPPED</span>
|
|
357
|
+
{% endif %}
|
|
358
|
+
</div>
|
|
359
|
+
<div class="tier-body">
|
|
360
|
+
{% if report.spec_report %}
|
|
361
|
+
<p><strong>System:</strong> {{ report.spec_report.metadata.get('system', 'Molecule / Surface') }}</p>
|
|
362
|
+
{% if report.spec_report.uv_vis %}
|
|
363
|
+
<p><strong>UV-Vis Absorption:</strong> λ_max = {{ "%.1f"|format(report.spec_report.uv_vis.lambda_max_nm) }} nm (f = {{ "%.3f"|format(report.spec_report.uv_vis.max_oscillator_strength) }})</p>
|
|
364
|
+
{% endif %}
|
|
365
|
+
{% if report.spec_report.vibrational %}
|
|
366
|
+
<p><strong>IR Scaling:</strong> Factor {{ "%.4f"|format(report.spec_report.vibrational.scaling_factor_applied) }} ({{ report.spec_report.vibrational.n_modes }} modes)</p>
|
|
367
|
+
{% endif %}
|
|
368
|
+
{% if report.spec_report.dos_analysis and report.spec_report.dos_analysis.d_band_center_filled_ev is not none %}
|
|
369
|
+
<p><strong>d-Band Center:</strong> ε_d = {{ "%.3f"|format(report.spec_report.dos_analysis.d_band_center_filled_ev) }} eV rel to E_F</p>
|
|
370
|
+
{% endif %}
|
|
371
|
+
<p><strong>Assessment:</strong> {{ report.spec_report.validation_score }}</p>
|
|
372
|
+
<p><a href="spectroscopy/report.html" style="color: var(--accent-blue); text-decoration: underline;">View Detailed Spectroscopy Report →</a></p>
|
|
373
|
+
{% else %}
|
|
374
|
+
<p>No spectroscopy or electronic DOS evaluated.</p>
|
|
375
|
+
{% endif %}
|
|
376
|
+
</div>
|
|
377
|
+
</div>
|
|
378
|
+
</div>
|
|
379
|
+
|
|
380
|
+
<h2 class="section-title">Consolidated Manuscript Methods Section</h2>
|
|
381
|
+
<div class="box">
|
|
382
|
+
<pre id="methodsSnippet">{{ report.consolidated_methods }}</pre>
|
|
383
|
+
<button class="btn-copy" onclick="copyToClipboard('methodsSnippet')">Copy Consolidated Methods</button>
|
|
384
|
+
</div>
|
|
385
|
+
|
|
386
|
+
<h2 class="section-title">Consolidated BibTeX Citations</h2>
|
|
387
|
+
<div class="box">
|
|
388
|
+
<pre id="bibSnippet">{{ report.consolidated_bibtex }}</pre>
|
|
389
|
+
<button class="btn-copy" onclick="copyToClipboard('bibSnippet')">Copy Consolidated BibTeX</button>
|
|
390
|
+
</div>
|
|
391
|
+
|
|
392
|
+
<footer>
|
|
393
|
+
Generated automatically by <strong>SimCert v{{ simcert_version }}</strong> • Unified Scientific Simulation Quality Meta-Framework • Monreal-Hernández, 2026.
|
|
394
|
+
</footer>
|
|
395
|
+
</div>
|
|
396
|
+
|
|
397
|
+
<script>
|
|
398
|
+
function copyToClipboard(elementId) {
|
|
399
|
+
const text = document.getElementById(elementId).innerText;
|
|
400
|
+
navigator.clipboard.writeText(text).then(() => {
|
|
401
|
+
alert('Copied to clipboard!');
|
|
402
|
+
}).catch(err => {
|
|
403
|
+
console.error('Error copying: ', err);
|
|
404
|
+
});
|
|
405
|
+
}
|
|
406
|
+
</script>
|
|
407
|
+
</body>
|
|
408
|
+
</html>
|
|
409
|
+
"""
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
def generate_simcert_meta_report(report: SimCertProjectReport, output_path: str) -> str:
|
|
413
|
+
"""
|
|
414
|
+
Renders consolidated multi-scale project summary HTML.
|
|
415
|
+
"""
|
|
416
|
+
template = jinja2.Template(HTML_TEMPLATE)
|
|
417
|
+
rendered = template.render(report=report, simcert_version=__import__("simcert").__version__)
|
|
418
|
+
with open(output_path, "w", encoding="utf-8") as f:
|
|
419
|
+
f.write(rendered)
|
|
420
|
+
return output_path
|
simcert/orchestrator.py
ADDED
|
@@ -0,0 +1,275 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Multi-scale simulation project orchestrator for SimCert.
|
|
3
|
+
"""
|
|
4
|
+
|
|
5
|
+
from typing import Dict, Any, Optional, List
|
|
6
|
+
from dataclasses import dataclass, asdict, field
|
|
7
|
+
import os
|
|
8
|
+
|
|
9
|
+
from mdcheck.core.scoring import SimulationQualityReport
|
|
10
|
+
from dockcert.core.scoring import DockingValidationReport
|
|
11
|
+
from qmcert.core.scoring import QMCertValidationReport
|
|
12
|
+
from adsorpqc.core.scoring import AdsorptionValidationReport
|
|
13
|
+
from alphacert.core.scoring import AlphaFoldValidationReport
|
|
14
|
+
from fepcert.core.scoring import FEPValidationReport
|
|
15
|
+
from qsarcert.core.scoring import QSARValidationReport
|
|
16
|
+
from catcert.core.scoring import SlabQualityReport
|
|
17
|
+
from nebcert.core.scoring import ReactionPathwayReport
|
|
18
|
+
from speccert.core.scoring import SpectroscopyReport
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
KNOWN_STATUSES = ("PASS", "WARNING", "FAIL")
|
|
22
|
+
NEUTRAL_STATUSES = ("N/A", "NA", "NOT_APPLICABLE", "NOT APPLICABLE", "SKIPPED")
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
def _tool_version(name: str) -> str:
|
|
26
|
+
"""Version of an installed package, read at run time (never hard-coded)."""
|
|
27
|
+
try:
|
|
28
|
+
from importlib.metadata import version
|
|
29
|
+
return version(name)
|
|
30
|
+
except Exception:
|
|
31
|
+
try:
|
|
32
|
+
import importlib
|
|
33
|
+
return str(getattr(importlib.import_module(name), "__version__", "unknown"))
|
|
34
|
+
except Exception:
|
|
35
|
+
return "unknown"
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
def _classify_status(raw) -> str:
|
|
39
|
+
"""Maps a tool status to PASS, WARNING, FAIL or NEUTRAL; any other string is treated as WARNING, never as PASS."""
|
|
40
|
+
text = str(raw).strip().upper()
|
|
41
|
+
if text in KNOWN_STATUSES:
|
|
42
|
+
return text
|
|
43
|
+
if text in NEUTRAL_STATUSES:
|
|
44
|
+
return "NEUTRAL"
|
|
45
|
+
return "WARNING"
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
@dataclass
|
|
49
|
+
class SimCertProjectReport:
|
|
50
|
+
project_name: str
|
|
51
|
+
overall_status: str # 'PASS', 'WARNING', 'FAIL'
|
|
52
|
+
md_report: Optional[SimulationQualityReport]
|
|
53
|
+
dock_report: Optional[DockingValidationReport]
|
|
54
|
+
qm_report: Optional[QMCertValidationReport]
|
|
55
|
+
adsorp_report: Optional[AdsorptionValidationReport]
|
|
56
|
+
alpha_report: Optional[AlphaFoldValidationReport]
|
|
57
|
+
fep_report: Optional[FEPValidationReport]
|
|
58
|
+
qsar_report: Optional[QSARValidationReport]
|
|
59
|
+
cat_report: Optional[SlabQualityReport]
|
|
60
|
+
neb_report: Optional[ReactionPathwayReport]
|
|
61
|
+
spec_report: Optional[SpectroscopyReport]
|
|
62
|
+
consolidated_methods: str
|
|
63
|
+
consolidated_bibtex: str
|
|
64
|
+
status_notes: List[str] = field(default_factory=list)
|
|
65
|
+
|
|
66
|
+
def to_dict(self) -> Dict[str, Any]:
|
|
67
|
+
return asdict(self)
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
def run_multiscale_audit(
|
|
71
|
+
project_name: str = "Multi-Scale Computational Investigation",
|
|
72
|
+
md_report: Optional[SimulationQualityReport] = None,
|
|
73
|
+
dock_report: Optional[DockingValidationReport] = None,
|
|
74
|
+
qm_report: Optional[QMCertValidationReport] = None,
|
|
75
|
+
adsorp_report: Optional[AdsorptionValidationReport] = None,
|
|
76
|
+
alpha_report: Optional[AlphaFoldValidationReport] = None,
|
|
77
|
+
fep_report: Optional[FEPValidationReport] = None,
|
|
78
|
+
qsar_report: Optional[QSARValidationReport] = None,
|
|
79
|
+
cat_report: Optional[SlabQualityReport] = None,
|
|
80
|
+
neb_report: Optional[ReactionPathwayReport] = None,
|
|
81
|
+
spec_report: Optional[SpectroscopyReport] = None
|
|
82
|
+
) -> SimCertProjectReport:
|
|
83
|
+
"""
|
|
84
|
+
Consolidates validation metrics across 10 computational tiers into a single executive report.
|
|
85
|
+
"""
|
|
86
|
+
statuses = []
|
|
87
|
+
methods_parts = []
|
|
88
|
+
bib_parts = []
|
|
89
|
+
|
|
90
|
+
if md_report:
|
|
91
|
+
statuses.append(md_report.overall_status)
|
|
92
|
+
methods_parts.append(
|
|
93
|
+
f"Molecular dynamics trajectories were validated for statistical equilibration and convergence using MDCheck v{_tool_version('mdcheck')} (Monreal-Hernández, 2026). Status: {md_report.overall_status}."
|
|
94
|
+
)
|
|
95
|
+
bib_parts.append("""@software{monreal2026mdcheck,
|
|
96
|
+
author = {Monreal-Hern\\'andez, Andr\\'es},
|
|
97
|
+
title = {{MDCheck: Automated Statistical Convergence, Equilibration Detection, and Multi-Replica Reproducibility Assessment for Molecular Dynamics Simulations}},
|
|
98
|
+
year = {2026},
|
|
99
|
+
version = {__VER__},
|
|
100
|
+
publisher = {Zenodo},
|
|
101
|
+
url = {https://github.com/sircalch/mdcheck}
|
|
102
|
+
}""".replace("__VER__", _tool_version("mdcheck")))
|
|
103
|
+
|
|
104
|
+
if dock_report:
|
|
105
|
+
statuses.append(dock_report.overall_status)
|
|
106
|
+
methods_parts.append(
|
|
107
|
+
f"Molecular docking pose fidelity and screening early enrichment were certified using DockCert v{_tool_version('dockcert')} (Monreal-Hernández, 2026). Status: {dock_report.overall_status}."
|
|
108
|
+
)
|
|
109
|
+
bib_parts.append("""@software{monreal2026dockcert,
|
|
110
|
+
author = {Monreal-Hern\\'andez, Andr\\'es},
|
|
111
|
+
title = {{DockCert: Automated Quality-Control, Early Enrichment Metrics, Symmetry-Corrected RMSD, and Reproducibility Assessment for Molecular Docking}},
|
|
112
|
+
year = {2026},
|
|
113
|
+
version = {__VER__},
|
|
114
|
+
publisher = {Zenodo},
|
|
115
|
+
url = {https://github.com/sircalch/dockcert}
|
|
116
|
+
}""".replace("__VER__", _tool_version("dockcert")))
|
|
117
|
+
|
|
118
|
+
if qm_report:
|
|
119
|
+
statuses.append(qm_report.overall_status)
|
|
120
|
+
methods_parts.append(
|
|
121
|
+
f"Quantum-chemical electronic structures, stationary points, and spin contamination were certified using QMCert v{_tool_version('qmcert')} (Monreal-Hernández, 2026). Status: {qm_report.overall_status}."
|
|
122
|
+
)
|
|
123
|
+
bib_parts.append("""@software{monreal2026qmcert,
|
|
124
|
+
author = {Monreal-Hern\\'andez, Andr\\'es},
|
|
125
|
+
title = {{QMCert: Automated Quality-Control, Stationary Point Certification, and Reproducibility Assessment for Quantum-Chemical Calculations}},
|
|
126
|
+
year = {2026},
|
|
127
|
+
version = {__VER__},
|
|
128
|
+
publisher = {Zenodo},
|
|
129
|
+
url = {https://github.com/sircalch/qmcert}
|
|
130
|
+
}""".replace("__VER__", _tool_version("qmcert")))
|
|
131
|
+
|
|
132
|
+
if adsorp_report:
|
|
133
|
+
statuses.append(adsorp_report.overall_status)
|
|
134
|
+
methods_parts.append(
|
|
135
|
+
f"Nanoporous adsorption equilibria, GCMC burn-in, and isotherm model fits were validated using AdsorpQC v{_tool_version('adsorpqc')} (Monreal-Hernández, 2026). Status: {adsorp_report.overall_status}."
|
|
136
|
+
)
|
|
137
|
+
bib_parts.append("""@software{monreal2026adsorpqc,
|
|
138
|
+
author = {Monreal-Hern\\'andez, Andr\\'es},
|
|
139
|
+
title = {{AdsorpQC: An Open-Source Toolkit for Quality-Control, GCMC Burn-in Detection, Isotherm Fitting, and Reproducibility Assessment of Adsorption Simulations}},
|
|
140
|
+
year = {2026},
|
|
141
|
+
version = {__VER__},
|
|
142
|
+
publisher = {Zenodo},
|
|
143
|
+
url = {https://github.com/sircalch/adsorpqc}
|
|
144
|
+
}""".replace("__VER__", _tool_version("adsorpqc")))
|
|
145
|
+
|
|
146
|
+
if alpha_report:
|
|
147
|
+
statuses.append(alpha_report.overall_status)
|
|
148
|
+
methods_parts.append(
|
|
149
|
+
f"Predicted 3D protein structures, pLDDT per-residue confidence, and 2D PAE error matrices were certified using AlphaCert v{_tool_version('alphacert')} (Monreal-Hernández, 2026). Status: {alpha_report.overall_status}."
|
|
150
|
+
)
|
|
151
|
+
bib_parts.append("""@software{monreal2026alphacert,
|
|
152
|
+
author = {Monreal-Hern\\'andez, Andr\\'es},
|
|
153
|
+
title = {{AlphaCert: An Open-Source Toolkit for Quality-Control, pLDDT/PAE Assessment, and Stereochemical Certification of Predicted Protein Structures}},
|
|
154
|
+
year = {2026},
|
|
155
|
+
version = {__VER__},
|
|
156
|
+
publisher = {Zenodo},
|
|
157
|
+
url = {https://github.com/sircalch/alphacert}
|
|
158
|
+
}""".replace("__VER__", _tool_version("alphacert")))
|
|
159
|
+
|
|
160
|
+
if fep_report:
|
|
161
|
+
statuses.append(fep_report.overall_status)
|
|
162
|
+
methods_parts.append(
|
|
163
|
+
f"Alchemical free energy calculations, phase space overlap matrices, and thermodynamic cycle closures were certified using FEPCert v{_tool_version('fepcert')} (Monreal-Hernández, 2026). Status: {fep_report.overall_status}."
|
|
164
|
+
)
|
|
165
|
+
bib_parts.append("""@software{monreal2026fepcert,
|
|
166
|
+
author = {Monreal-Hern\\'andez, Andr\\'es},
|
|
167
|
+
title = {{FEPCert: An Open-Source Toolkit for Quality-Control, Phase Space Overlap, and Thermodynamic Cycle Closure Certification of Alchemical Free Energy Simulations}},
|
|
168
|
+
year = {2026},
|
|
169
|
+
version = {__VER__},
|
|
170
|
+
publisher = {Zenodo},
|
|
171
|
+
url = {https://github.com/sircalch/fepcert}
|
|
172
|
+
}""".replace("__VER__", _tool_version("fepcert")))
|
|
173
|
+
|
|
174
|
+
if qsar_report:
|
|
175
|
+
statuses.append(qsar_report.overall_status)
|
|
176
|
+
methods_parts.append(
|
|
177
|
+
f"Quantitative Structure-Activity Relationship (QSAR) and molecular machine learning models were audited for OECD Validation Principles, Applicability Domain (Williams Plot), and Y-Randomization using QSARCert v{_tool_version('qsarcert')} (Monreal-Hernández, 2026). Status: {qsar_report.overall_status}."
|
|
178
|
+
)
|
|
179
|
+
bib_parts.append("""@software{monreal2026qsarcert,
|
|
180
|
+
author = {Monreal-Hern\\'andez, Andr\\'es},
|
|
181
|
+
title = {{QSARCert: An Open-Source Toolkit for OECD Validation Principles, Applicability Domain Assessment, Y-Randomization, and Reproducibility Certification of QSAR and Molecular Machine Learning Models}},
|
|
182
|
+
year = {2026},
|
|
183
|
+
version = {__VER__},
|
|
184
|
+
publisher = {Zenodo},
|
|
185
|
+
url = {https://github.com/sircalch/qsarcert}
|
|
186
|
+
}""".replace("__VER__", _tool_version("qsarcert")))
|
|
187
|
+
|
|
188
|
+
if cat_report:
|
|
189
|
+
statuses.append(cat_report.overall_status)
|
|
190
|
+
methods_parts.append(
|
|
191
|
+
f"Heterogeneous catalysis surface slab models, vacuum potential flatness, work functions, and surface energy layer convergence were certified using CatCert v{_tool_version('catcert')} (Monreal-Hernández, 2026). Status: {cat_report.overall_status}."
|
|
192
|
+
)
|
|
193
|
+
bib_parts.append("""@software{monreal2026catcert,
|
|
194
|
+
author = {Monreal-Hern\\'andez, Andr\\'es},
|
|
195
|
+
title = {{CatCert: Automated Quality-Control, Vacuum Thickness, Dipole Correction, and Surface Energy Convergence Certification for Heterogeneous Catalysis & DFT Surface Slabs}},
|
|
196
|
+
year = {2026},
|
|
197
|
+
version = {__VER__},
|
|
198
|
+
publisher = {Zenodo},
|
|
199
|
+
url = {https://github.com/sircalch/catcert}
|
|
200
|
+
}""".replace("__VER__", _tool_version("catcert")))
|
|
201
|
+
|
|
202
|
+
if neb_report:
|
|
203
|
+
statuses.append(neb_report.overall_status)
|
|
204
|
+
methods_parts.append(
|
|
205
|
+
f"Nudged elastic band reaction pathways, transition states, Eyring rate constants, and quantum tunneling corrections were certified using NEBCert v{_tool_version('nebcert')} (Monreal-Hernández, 2026). Status: {neb_report.overall_status}."
|
|
206
|
+
)
|
|
207
|
+
bib_parts.append("""@software{monreal2026nebcert,
|
|
208
|
+
author = {Monreal-Hern\\'andez, Andr\\'es},
|
|
209
|
+
title = {{NEBCert: Automated Quality-Control, Transition State Verification, Nudged Elastic Band (NEB), Quantum Tunneling, and Reaction Kinetics Certification}},
|
|
210
|
+
year = {2026},
|
|
211
|
+
version = {__VER__},
|
|
212
|
+
publisher = {Zenodo},
|
|
213
|
+
url = {https://github.com/sircalch/nebcert}
|
|
214
|
+
}""".replace("__VER__", _tool_version("nebcert")))
|
|
215
|
+
|
|
216
|
+
if spec_report:
|
|
217
|
+
statuses.append(spec_report.overall_status)
|
|
218
|
+
methods_parts.append(
|
|
219
|
+
f"Spectroscopic simulations (TD-DFT UV-Vis, scaled IR/Raman) and electronic density of states (DOS d-band center) were certified using SpecCert v{_tool_version('speccert')} (Monreal-Hernández, 2026). Status: {spec_report.overall_status}."
|
|
220
|
+
)
|
|
221
|
+
bib_parts.append("""@software{monreal2026speccert,
|
|
222
|
+
author = {Monreal-Hern\\'andez, Andr\\'es},
|
|
223
|
+
title = {{SpecCert: Automated Quality-Control, Spectroscopy Simulation (UV-Vis TD-DFT, IR/Raman Anharmonic Scaling), and Electronic Structure Certification (DOS & d-Band Center)}},
|
|
224
|
+
year = {2026},
|
|
225
|
+
version = {__VER__},
|
|
226
|
+
publisher = {Zenodo},
|
|
227
|
+
url = {https://github.com/sircalch/speccert}
|
|
228
|
+
}""".replace("__VER__", _tool_version("speccert")))
|
|
229
|
+
|
|
230
|
+
# Umbrella SimCert citation
|
|
231
|
+
bib_parts.append("""@software{monreal2026simcert,
|
|
232
|
+
author = {Monreal-Hern\\'andez, Andr\\'es},
|
|
233
|
+
title = {{SimCert: A Unified Scientific Simulation Quality-Control and Reproducibility Meta-Framework}},
|
|
234
|
+
year = {2026},
|
|
235
|
+
version = {__VER__},
|
|
236
|
+
publisher = {Zenodo},
|
|
237
|
+
url = {https://github.com/sircalch/simcert}
|
|
238
|
+
}""".replace("__VER__", _tool_version("simcert")))
|
|
239
|
+
|
|
240
|
+
classified = [_classify_status(x) for x in statuses]
|
|
241
|
+
status_notes = [
|
|
242
|
+
f"Report status '{raw}' is not one of PASS, WARNING or FAIL and was counted as WARNING."
|
|
243
|
+
for raw, c in zip(statuses, classified)
|
|
244
|
+
if c == "WARNING" and str(raw).strip().upper() not in KNOWN_STATUSES
|
|
245
|
+
]
|
|
246
|
+
if "FAIL" in classified:
|
|
247
|
+
overall = "FAIL"
|
|
248
|
+
elif "WARNING" in classified:
|
|
249
|
+
overall = "WARNING"
|
|
250
|
+
else:
|
|
251
|
+
overall = "PASS"
|
|
252
|
+
|
|
253
|
+
if status_notes:
|
|
254
|
+
methods_parts.append(" ".join(status_notes))
|
|
255
|
+
consolidated_methods = " ".join(methods_parts)
|
|
256
|
+
consolidated_bibtex = "\n\n".join(bib_parts)
|
|
257
|
+
|
|
258
|
+
return SimCertProjectReport(
|
|
259
|
+
project_name=project_name,
|
|
260
|
+
overall_status=overall,
|
|
261
|
+
md_report=md_report,
|
|
262
|
+
dock_report=dock_report,
|
|
263
|
+
qm_report=qm_report,
|
|
264
|
+
adsorp_report=adsorp_report,
|
|
265
|
+
alpha_report=alpha_report,
|
|
266
|
+
fep_report=fep_report,
|
|
267
|
+
qsar_report=qsar_report,
|
|
268
|
+
cat_report=cat_report,
|
|
269
|
+
neb_report=neb_report,
|
|
270
|
+
spec_report=spec_report,
|
|
271
|
+
consolidated_methods=consolidated_methods,
|
|
272
|
+
consolidated_bibtex=consolidated_bibtex,
|
|
273
|
+
status_notes=status_notes
|
|
274
|
+
)
|
|
275
|
+
|
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: simcert
|
|
3
|
+
Version: 1.7.0
|
|
4
|
+
Summary: Unified Quality-Control, Structure Validation, and Reproducibility Meta-Framework for Molecular Simulations & AI Models (MD, Docking, QM, Adsorption, AlphaFold, FEP, QSAR, Catalysis, NEB/Kinetics, Spectroscopy/DOS)
|
|
5
|
+
Author-email: Andrés Monreal-Hernández <andres.monreal@ues.mx>
|
|
6
|
+
License-Expression: MIT
|
|
7
|
+
Project-URL: Homepage, https://github.com/sircalch/simcert
|
|
8
|
+
Project-URL: Documentation, https://github.com/sircalch/simcert#readme
|
|
9
|
+
Project-URL: Repository, https://github.com/sircalch/simcert.git
|
|
10
|
+
Project-URL: Bug Tracker, https://github.com/sircalch/simcert/issues
|
|
11
|
+
Project-URL: Changelog, https://github.com/sircalch/simcert/blob/main/CHANGELOG.md
|
|
12
|
+
Keywords: molecular-dynamics,molecular-docking,quantum-chemistry,adsorption,alphafold,free-energy-perturbation,fep,qsar,heterogeneous-catalysis,nudged-elastic-band,chemical-kinetics,spectroscopy,td-dft,uv-vis,infrared-spectroscopy,d-band-center,simulation-quality-control,reproducibility,gromacs,orca,vasp,gaussian
|
|
13
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
14
|
+
Classifier: Intended Audience :: Science/Research
|
|
15
|
+
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
|
|
16
|
+
Classifier: Topic :: Scientific/Engineering :: Chemistry
|
|
17
|
+
Classifier: Topic :: Scientific/Engineering :: Physics
|
|
18
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
19
|
+
Classifier: Programming Language :: Python :: 3
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
23
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
24
|
+
Classifier: Operating System :: OS Independent
|
|
25
|
+
Requires-Python: >=3.9
|
|
26
|
+
Description-Content-Type: text/markdown
|
|
27
|
+
License-File: LICENSE
|
|
28
|
+
Requires-Dist: mdcheck>=1.1.0
|
|
29
|
+
Requires-Dist: dockcert>=1.1.0
|
|
30
|
+
Requires-Dist: qmcert>=1.2.0
|
|
31
|
+
Requires-Dist: adsorpqc>=1.1.0
|
|
32
|
+
Requires-Dist: alphacert>=1.1.0
|
|
33
|
+
Requires-Dist: fepcert>=1.2.0
|
|
34
|
+
Requires-Dist: qsarcert>=1.2.0
|
|
35
|
+
Requires-Dist: catcert>=1.2.0
|
|
36
|
+
Requires-Dist: nebcert>=1.2.0
|
|
37
|
+
Requires-Dist: speccert>=1.2.0
|
|
38
|
+
Requires-Dist: numpy>=1.20.0
|
|
39
|
+
Requires-Dist: scipy>=1.7.0
|
|
40
|
+
Requires-Dist: pandas>=1.3.0
|
|
41
|
+
Requires-Dist: matplotlib>=3.5.0
|
|
42
|
+
Requires-Dist: jinja2>=3.0.0
|
|
43
|
+
Provides-Extra: dev
|
|
44
|
+
Requires-Dist: pytest>=7.0.0; extra == "dev"
|
|
45
|
+
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
|
|
46
|
+
Requires-Dist: black>=23.0.0; extra == "dev"
|
|
47
|
+
Requires-Dist: flake8>=6.0.0; extra == "dev"
|
|
48
|
+
Requires-Dist: build>=0.10.0; extra == "dev"
|
|
49
|
+
Requires-Dist: twine>=4.0.0; extra == "dev"
|
|
50
|
+
Dynamic: license-file
|
|
51
|
+
|
|
52
|
+
# SimCert
|
|
53
|
+
|
|
54
|
+
[](https://github.com/sircalch/simcert/actions)
|
|
55
|
+
[](https://pypi.org/project/simcert/)
|
|
56
|
+
[](https://pypi.org/project/simcert/)
|
|
57
|
+
[](https://opensource.org/licenses/MIT)
|
|
58
|
+
[](https://doi.org/10.5281/zenodo.22217591)
|
|
59
|
+
|
|
60
|
+
> **Unified Quality-Control, Structure Validation, and Reproducibility Meta-Framework for Molecular Simulations & AI Models (MD, Docking, QM, Adsorption, AlphaFold, FEP, QSAR, Catalysis, NEB / Kinetics).**
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## Overview
|
|
65
|
+
|
|
66
|
+
**SimCert** is a high-level scientific umbrella meta-framework that connects, standardizes, and unifies automated quality control, convergence certification, and reproducibility reporting across **ten distinct computational simulation and modeling domains**:
|
|
67
|
+
|
|
68
|
+
```
|
|
69
|
+
┌─────────────────────────────────────────┐
|
|
70
|
+
│ SimCert │
|
|
71
|
+
│ (Umbrella Project Meta-Dashboard) │
|
|
72
|
+
└─────────────────────────────────────────┘
|
|
73
|
+
│
|
|
74
|
+
┌───────────────┬───────────────┬───────────────┬──────────┴────┬───────────────┬───────────────┬───────────────┬───────────────┬───────────────┐
|
|
75
|
+
│ │ │ │ │ │ │ │ │ │
|
|
76
|
+
▼ ▼ ▼ ▼ ▼ ▼ ▼ ▼ ▼ ▼
|
|
77
|
+
┌───────────┐ ┌───────────┐ ┌───────────┐ ┌───────────┐ ┌───────────┐ ┌───────────┐ ┌───────────┐ ┌───────────┐ ┌───────────┐ ┌───────────┐
|
|
78
|
+
│ MDCheck │ │ DockCert │ │ QMCert │ │ AdsorpQC │ │ AlphaCert │ │ FEPCert │ │ QSARCert │ │ CatCert │ │ NEBCert │ │ ... │
|
|
79
|
+
│ Tier 1 │ │ Tier 2 │ │ Tier 3 │ │ Tier 4 │ │ Tier 5 │ │ Tier 6 │ │ Tier 7 │ │ Tier 8 │ │ Tier 9 │ │ │
|
|
80
|
+
│ MD │ │ Docking │ │ DFT │ │ GCMC │ │ AlphaFold │ │ FEP / TI │ │ QSAR / ML │ │ Catalysis │ │ Kinetics │ │ │
|
|
81
|
+
└───────────┘ └───────────┘ └───────────┘ └───────────┘ └───────────┘ └───────────┘ └───────────┘ └───────────┘ └───────────┘ └───────────┘
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## The 10 Computational Tiers
|
|
87
|
+
|
|
88
|
+
1. **Tier 1: Molecular Dynamics (`mdcheck`)**
|
|
89
|
+
- Autocorrelation time ($\tau_{\text{int}}$), effective sample size ($N_{\text{eff}}$), Chodera automated equilibration ($t_{\text{eq}}$), Geweke diagnostic, linear drift, multi-replica consistency ($R_1, R_2, R_3$).
|
|
90
|
+
2. **Tier 2: Molecular Docking & Screening (`dockcert`)**
|
|
91
|
+
- Exact analytical BEDROC ($\alpha=20.0, 80.5, 160.9$), RIE, EF1%, EF5%, EF10%, ROC-AUC, PR-AUC, optimal MCC, Hungarian algorithm symmetry-corrected heavy-atom RMSD, decoy property matching KS-tests.
|
|
92
|
+
3. **Tier 3: Quantum Chemistry & DFT (`qmcert`)**
|
|
93
|
+
- Stationary point certification (0 imaginary frequencies for minima, exactly 1 for transition states), spin contamination $\langle S^2 \rangle$, Grimme quasi-RRHO harmonic entropy correction for low modes ($\nu < 100\text{ cm}^{-1}$), simulated IR spectra.
|
|
94
|
+
4. **Tier 4: Adsorption in Nanoporous MOFs & GCMC (`adsorpqc`)**
|
|
95
|
+
- GCMC equilibration burn-in detection, loading drift lock, non-linear isotherm model fitting (Langmuir, Dual-site, Sips, Toth, Freundlich, BET), Henry constant $K_H$, isosteric heat $q_{\text{st}}$, IAST binary selectivity with bootstrap confidence intervals.
|
|
96
|
+
5. **Tier 5: AlphaFold / ESMFold Structure Confidence (`alphacert`)**
|
|
97
|
+
- Per-residue pLDDT categorization across 4 canonical bands ($>90, 70-90, 50-70, <50$), 2D Predicted Aligned Error (PAE) matrix domain decomposition, steric clashscore, Ramachandran dihedral distribution ($\phi, \psi$), certifications `DOCKING_READY` and `MD_READY`.
|
|
98
|
+
6. **Tier 6: Alchemical Free Energy & FEP (`fepcert`)**
|
|
99
|
+
- Phase space overlap matrix ($\Pi_{ij} \ge 3\%$), Thermodynamic Integration (TI), Bennett Acceptance Ratio (BAR), forward/reverse time convergence and dissipated work $W_{\text{diss}}$, thermodynamic cycle closure audit ($\oint \Delta\Delta G \approx 0$).
|
|
100
|
+
7. **Tier 7: QSAR & Molecular Machine Learning (`qsarcert`)**
|
|
101
|
+
- OECD Validation Principles, Hat matrix Applicability Domain ($h^* = \frac{3(p+1)}{n}$) and Williams plot, Tropsha-Golbraikh criteria, Y-randomization ($cR^2_p > 0.50$), train/test split leakage detection.
|
|
102
|
+
8. **Tier 8: Heterogeneous Catalysis & Surfaces (`catcert`)**
|
|
103
|
+
- Surface energy ($\gamma$) layer convergence, Fiorentini-Methfessel asymptotic regression, vacuum thickness and potential flatness $\bar{V}(z)$, physical work function ($\Phi$), dipole layer step ($|\Delta \Phi|$), and $E_{\text{ads}}$ dispersion audit.
|
|
104
|
+
9. **Tier 9: Reaction Pathways & NEB Kinetics (`nebcert`)**
|
|
105
|
+
- Nudged Elastic Band (NEB / CI-NEB) cubic spline MEP interpolation, Climbing Image residual force audit ($|F_\parallel| \le 0.05\text{ eV/\AA}$), transition state 1st-order saddle point imaginary frequency verification, Eyring TST rate constants $k(T)$, Arrhenius fitting, and asymmetric Eckart / Wigner quantum tunneling corrections.
|
|
106
|
+
10. **Tier 10: Spectroscopy & Electronic Structure (`speccert`)**
|
|
107
|
+
- TD-DFT UV-Vis, scaled IR/Raman spectra, VASP DOS parsing and d-band-center analysis with provenance-aware reporting.
|
|
108
|
+
|
|
109
|
+
---
|
|
110
|
+
|
|
111
|
+
## Installation
|
|
112
|
+
|
|
113
|
+
> **Note:** PyPI release pending. Until then, install from the tagged GitHub releases (SimCert depends on all ten certifiers):
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
pip install \
|
|
117
|
+
mdcheck==1.1.0 dockcert==1.1.0 qmcert==1.2.0 adsorpqc==1.1.0 \
|
|
118
|
+
alphacert==1.1.0 fepcert==1.2.0 qsarcert==1.2.0 catcert==1.2.0 \
|
|
119
|
+
nebcert==1.2.0 speccert==1.2.0
|
|
120
|
+
pip install "git+https://github.com/sircalch/simcert@v1.7.0"
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
---
|
|
124
|
+
|
|
125
|
+
## Quickstart (CLI)
|
|
126
|
+
|
|
127
|
+
```bash
|
|
128
|
+
# 1. Run full 10-tier multi-scale benchmark demonstration
|
|
129
|
+
simcert demo-all -o full_project_audit/
|
|
130
|
+
|
|
131
|
+
# 2. Delegate to any individual tier
|
|
132
|
+
simcert md assess -i trajectory.csv -o md_report/
|
|
133
|
+
simcert dock assess -i scores.csv -o dock_report/
|
|
134
|
+
simcert qm assess -i opt_freq.out -o qm_report/
|
|
135
|
+
simcert adsorp assess -i isotherm.csv -o adsorp_report/
|
|
136
|
+
simcert alpha assess -i model.pdb --pae model_pae.json -o alpha_report/
|
|
137
|
+
simcert fep assess -d gromacs_fep/ -o fep_report/
|
|
138
|
+
simcert qsar assess -i predictions.csv -o qsar_report/
|
|
139
|
+
simcert cat assess --layers-csv pt_layers.csv --area 27.60 -o cat_report/
|
|
140
|
+
simcert neb assess -i neb.dat --frequencies "-1250,150,300" -o neb_report/
|
|
141
|
+
|
|
142
|
+
# 3. View consolidated citations
|
|
143
|
+
simcert cite
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## Citation
|
|
149
|
+
|
|
150
|
+
```bibtex
|
|
151
|
+
@software{monreal2026simcert,
|
|
152
|
+
author = {Monreal-Hern{\'a}ndez, Andre},
|
|
153
|
+
title = {{SimCert: A Unified Scientific Simulation Quality-Control and Reproducibility Meta-Framework}},
|
|
154
|
+
year = {2026},
|
|
155
|
+
version = {1.5.0},
|
|
156
|
+
publisher = {Zenodo},
|
|
157
|
+
url = {https://github.com/sircalch/simcert}
|
|
158
|
+
}
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
|
|
163
|
+
## License
|
|
164
|
+
|
|
165
|
+
This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.
|
|
166
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
simcert/__init__.py,sha256=6uiqzCQZaZ8lUixv7MZWcpMVFnQZi-hnQKP-JhVrLu4,569
|
|
2
|
+
simcert/cli.py,sha256=em6Led5kdIY9eiNEDsG-FMmB1IGJkkqgRb67UlZqBEc,14135
|
|
3
|
+
simcert/meta_report.py,sha256=8Tg-1Ae-t90zaAtI9U2FluYSjGGuScgfsxFRLS9NkVs,24421
|
|
4
|
+
simcert/orchestrator.py,sha256=eBYHd6rWZEPBb3eplJiGMzvc4gi6GpLPwbGKzBmDOyE,12736
|
|
5
|
+
simcert-1.7.0.dist-info/licenses/LICENSE,sha256=Cq3n_-RpcIXCs2hZNMawLYZWjT1OswrhaC-c1OKwq7Q,1081
|
|
6
|
+
simcert-1.7.0.dist-info/METADATA,sha256=n3ZNOTE0qIW67Nq0SyZGFhCbgFsKi7nsjH1xoFCbzMw,11086
|
|
7
|
+
simcert-1.7.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
|
|
8
|
+
simcert-1.7.0.dist-info/entry_points.txt,sha256=2BhAXnpaXivYgFCopVwmrmsE8czQVOMjt_WRUFCIe58,45
|
|
9
|
+
simcert-1.7.0.dist-info/top_level.txt,sha256=WaRRvFNgjuNHvsoZrQGRHNY6yF64s0qolLvgPplxZWU,8
|
|
10
|
+
simcert-1.7.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Andre Monreal-Hernández
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
simcert
|