Skip to content

Latest commit

 

History

History
229 lines (174 loc) · 12.9 KB

README.md

File metadata and controls

229 lines (174 loc) · 12.9 KB
Raw

Quanformer

README last updated: Nov 28 2018

Quanformer is a Python-based pipeline for generating conformers, preparing quantum mechanical (QM) calculations, and processing QM results for a set of input molecules. This pipeline is robust enough to use with hundreds of conformers per molecule and tens or hundreds of molecules. You will need access to either Psi4 or Turbomole for running QM calculations.

For each molecule, conformers are generated and optimized with the MM94S force field. Then input files for QM calculations are prepared for geometry optimizations, single point energy (SPE) calculations, or Hessian calculations. The user can specify any QM method and basis set that is supported in the QM software package. After the calculations have finished, this pipeline will extract final energies and geometries as well as collect job-related details such as calculation time and number of optimization steps. Analysis scripts are provided for comparing conformer energies from different QM methods, comparing calculation times from different methods, and generating nicely-formatted plots.

Example application:

  • Input five molecules and generate conformations for each one.
  • Then run QM geometry optimizations using the MP2/def2-SV(P) level of theory as a relatively quick fine-tuning of the geometries.
  • Take those QM results and run a second geometry optimization stage using the more intensive B3LYP-D3MBJ/def2-TZVP method.
  • Consider questions such as, "What is the spread of the conformer energies for molecule x?", "How does method a compare to method b for this molecule?", etc.

In concept, this example would look like:
initialize_confs.py → confs_to_psi.py → filter_confs.py → [QM jobs] → filter_confs.py → analysis

In practice, the executor.py code provides the interface for the various stages and components. That being said, each component was written to be able to run independently of the others so variations of this pipeline can be conducted. Instructions are provided below for following this example workflow.

I. Python Dependencies

II. Repository contents

Pipeline components and description:

Script Stage Brief description
avgTimeEne.py analysis analyze calculation stats and relative energies for a single batch of mols
confs_to_psi.py setup generate Psi4 input files for each conformer/molecule
confs2turb.py setup generate Turbomole input files for each conformer/molecule
opt_vs_spe.py analysis compare how diff OPT energy is from pre-OPT single point energy
executor.py N/A main interface connecting "setup" and "results" scripts for Psi4
filter_confs.py setup/results remover conformers of molecules that may be same structure
get_psi_results.py results get job results from Psi4
getTurbResults.py results get job results from Turbomole
match_minima.py analysis match conformers from sets of different optimizations
match_plot.py analysis additional plots that can be used from match_minima.py results
plotTimes.py analysis plot calculation time averaged over the conformers for each molecule
proc_tags.py results store QM energies & conformer details as data tags in SDF molecule files
quan2modsem.py analysis interface with modified Seminario Python code
initialize_confs.py setup generate molecular structures and conformers for input SMILES string
stitchSpe.py analysis calculate relative conformer energies from sets of different SPEs

There are other scripts in this repository that are not integral to the pipeline. These are found in the tools directory. See the README file there.

III. Files that are generated throughout the pipeline

A. Directory setup for QM calculations

The input (SMILES or SDF) file must be in the main directory.
The layout is mainDirectory/moleculeName/conformerNumber/[qm_job_here].

B. Molecules files generated by Quanformer

SDF files are numbered with the following code system. Let's say the pipeline starts with a file called basename.smi
and contains the list of SMILES strings.

  1. The first file generated will be basename.sdf. This contains all molecules and all conformers of each molecule.
  2. The next file will be basename-100.sdf, where -100 means all molecules have been MM-optimized.
  3. Then comes basename-200.sdf, in which the MM-optimized molecules are filtered to remove any redundant structures (i.e., duplicate minima).
  4. After that is basename-210.sdf, which contains the QM-calculated molecules of the -200 file.
  5. The QM molecules are filtered analogously to step 3 to yield basename-220.sdf.

This process can go through a second round of QM calculations. QM calculations can be either geometry optimizations or
single point energy calculations. If the basename-200.sdf is fed into both routes, then each route will have its own
basename-210.sdf file. Don't do this in the same directory obviously, else one file will be overwritten. The endmost
product will be basename-222.sdf though one could certainly stop before QM stage 2.

Why bother keeping the -221 files? They can be used to compare relative energies of single point energy calculations,
or geometry optimizations, since (mol1,confA) will start from the same structure of the compared files. After filtering,
the number of conformers may be reduced, so it can be hard to compare one to one.

An -f prefix means that the Omega-generated conformers were filtered based on their structures, but that these have not
been MM-optimized. For example, basename-f020.sdf means filtered from OpenEye Omega, no MM opt/filter, yes QM opt/filter, no QM stage 2.

In summary,

  • no suffix = original file with all omega conformers
  • 1xx = MM opt but no filter
  • 2xx = MM opt and filter
  • x1x = QM opt but no filter
  • x2x = QM opt and filter
  • xx1 = either QM second opt or SPE and no filter
  • xx2 = either QM second opt or SPE and filter

IV. Instructions

The instructions below describe how to take a set of molecules from their starting SMILES strings to:

  • Generate conformers
  • MM minimize those conformers using the MMFF94S force field
  • Filter out potentially redundant structures
    • Output: file-200.sdf
  • Create Psi4 input files for MP2/def2-SV(P) geometry optimizations
  • Extract results from completed Psi4 jobs
    • Output: file-210.sdf
  • Filter out potentially redundant structures
    • Output: file-220.sdf
  • Create new Psi4 input files for B3LYP/def2-TZVP geometry optimizations
  • Extract results from completed Psi4 jobs
    • Output: file-221.sdf
  • Filter out potentially redundant structures
    • Output: file-222.sdf

  1. Create input file with SMILES strings and names for each molecule. See subsections below on "Naming molecules in the input SMILES file" and "File name limitations".

  2. Generate conformers, perform quick MM optimization, and create Psi4 input files.

    • python executor.py -f file.smi --setup -m 'mp2' -b 'def2-sv(p)'

  3. Run Psi4 QM calculations.

    • The jobcount.sh script in the tools directory can be helpful for counting number of total/remaining jobs.
    • You can check the geometry for some optimization with the xyzByStep.sh script in the tools directory.
      E.g., xyzByStep.sh 10 output.dat view.xyz

  4. Get Psi4 results.

    • python executor.py -f file-200.sdf --results

  5. In a different directory (e.g., subdirectory), set up Psi4 OPT2 calculations from last results.

    • [for stage 2 OPT]
      python executor.py -f file-220.sdf --setup -t 'opt' -m 'b3lyp-d3mbj' -b 'def2-tzvp'
    • [for stage 2 SPE]
      python executor.py -f file-220.sdf --setup -t 'spe' -m 'b3lyp-d3mbj' -b 'def2-tzvp'

  6. Run Psi4 jobs. (See notes on step 3.)

  7. Get Psi4 results from second-level calculations.

    • [for stage 2 OPT]
      python executor.py -f file-220.sdf --results -t 'opt'
    • [for stage 2 SPE]
      python executor.py -f file-220.sdf --results -t 'spe'

  8. (opt.) Get wall clock times, num opt steps, relative energies.

    • python avgTimeEne.py --relene -f file.sdf -m 'b3lyp-d3mbj' -b 'def2-tzvp' -- [TODO recheck]

  9. Combine results from various job types to calculate model uncertainty.

    • See file analysis.md

A. Quanformer assumptions

  • Input molecules have spin multiplicity equal to one (i.e., no unpaired electrons)
  • SCF algorithm is density-fitted (DF)
    • There exists -JKFIT auxiliary set for your orbital basis/atom type

B. Limitations for file names

Base names (e.g. basename.smi, basename.sdf) can contain underscores but no dash (-) and no pound sign (#).

  • Dashes should not be used in the base filename because this is a delimiter for the SDF numbering code (see above).
  • Pound signs should not be used in the base filename because this is used to extract the file information such as file extension.
  • Examples:
    • Bad: basename-set1.smi
    • Bad: basename#set1.smi
    • Good: basename_set1.smi

C. Limitations on molecule names

Smiles file should contain, in each line: SMILES_STRING molecule_title and be named in format of basename.smi.

  • Molecule titles are required, as these are used to create subdirectories for the QM jobs. So don't have a space or strange characters in your molecule names.
  • Molecule title should have no dashes, as Psi4 will raise an error.
  • Molecule title should NOT start with a number, as Psi4 will raise error.
  • Example:
CC(C(C(C)O)O)O AlkEthOH_c42
CCCC AlkEthOH_c1008
CCOC(C)(C)C(C)(C)O AlkEthOH_c1178

D. File types supported by Quanformer

This pipeline is meant to be used with SDF files because it can store multiple molecules as well as data tags associated with each molecule. That being said, it has been applied in a few scenarios with MOL2 files (one molecule and all its conformers). If you try a non-SDF file, do check that the molecule name and the total charge are listed correctly in the Psi4 input files.

E. Preset parameters in Quanformer

This pipeline uses some preset parameters, which can be modified in the function calls of executor.py or in the parent code. Descriptions coming soon. [TODO]

  • initialize_confs.py: resolve_clash=True, for resolving steric clashes
  • initialize_confs.py: do_opt=True, for performing quick steepest descent optimization

V. Some terms and references

Pertaining to software packages:

Pertaining to files and formatting:

Pertaining to QM method:

  • MP2 - second order Moller-Plesset perturbation theory (adds electron correlation effects upon Hartree-Fock)
  • B3LYP - DFT hybrid functional, (Becke, three-parameter, Lee-Yang-Parr) exchange-correlation functional
  • PBE0 - DFT functional hybrid functional, (Perdew–Burke-Ernzerhof)
  • D3 - Grimme et al. dispersion correction method, (ref)
  • D3BJ - D3 with Becke-Johnson damping, (ref)
  • D3MBJ - Sherrill et al. modifications to D3BJ approach, (ref)

Pertaining to basis set:

  • def2 - 'default' basis sets with additional polarization fx compared to 'def-'
  • SV(P) - double zeta valence with polarization on all non-hydrogen atoms
  • TZVP - triple zeta valence with polarization on all atoms

VI. Contributors

  • Victoria Lim (UCI)
  • Chris Bayly (OpenEye)
  • Caitlin Bannan (UCI)
  • Jessica Maat (UCI)
  • David Mobley (UCI)