You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Update README examples to match current output format and file paths
- Add --radii, --sambvca, and uv install instructions to README
- Resize images to 50% width
- Add --measure CLI option for explicit classic/grid sterimol selection
- Auto-switch to grid mode for sterimol scans (sterimol2vec)
- Add Atom2 column to sterimol-only table output
- Fix grid sterimol L for VDW: recompute grid bounds after rotation
- Fix density grid sterimol: rotate occ_grid to match molecular orientation
* Exclude atoms from steric measurement with `--exclude [atom indices]` option (no spaces, separated by commas)
22
-
* Steric parameters can be computed from van der Waals radii or using a three dimensional grid (default is grid).
23
-
* Change measurement type with `--measure ['classic' or 'grid']` where classic will use vdw radii.
24
-
* Grid point spacing can be adjusted (default spacing is 0.05 Angstrom), adjust with `--grid [# in Angstrom]`
21
+
* Sterimol parameters can be computed using the classic (Verloop) definition from van der Waals radii, or using a three-dimensional grid (default is classic).
22
+
* Change measurement type with `--measure ['classic' or 'grid']`. Grid-based measurement is automatically used for scans and density surfaces.
23
+
* Grid point spacing can be adjusted (default spacing is 0.1 Angstrom), adjust with `--grid [# in Angstrom]`
24
+
* Two sets of VDW radii are available:
25
+
*`--radii bondi` (default) - Bondi radii
26
+
*`--radii charry-tkatchenko` - Charry-Tkatchenko free-atom radii derived from dipole polarizability
25
27
* Steric parameters can be measured from electron density .cube files generated by Gaussian (see [Gaussian cubegen](https://gaussian.com/cubegen/) for information on how to generate these)
26
28
* The `--surface density` command (default vdw) with a .cube input file will measure sterics from density values read in from the file.
27
29
* Density values read from the cube file greater than a default cutoff of 0.002 determine if a molecule is occupying that point in space, this can be changed with `--isoval [number]`
28
30
*`--noH` - exclude hydrogen atoms from steric measurements
29
31
*`--nometals` - exclude metal atoms from steric measurements
32
+
*`--sambvca` - SambVca 2.1 mode (Bondi radii scaled by 1.17, H atoms excluded)
30
33
31
34
### 2-D Graph contribution features (Requires RDKit and Pandas packages to be installed):
32
-
* Compute graph-based steric contributions in layers spanning outward from a reference functional group with the following input options:
35
+
* Compute graph-based steric contributions in layers spanning outward from a reference functional group with the following input options:
33
36
*`--2d` - Toggle 2D measurements on
34
-
*`--fg` - Specify an atom or functional group to use as a reference as a SMILES string
35
-
*`--maxpath` - The number of layers to measure. A connectivity matrix is used to compute the shortest path to each atom from the reference functional group.
37
+
*`--fg` - Specify an atom or functional group to use as a reference as a SMILES string
38
+
*`--maxpath` - The number of layers to measure. A connectivity matrix is used to compute the shortest path to each atom from the reference functional group.
36
39
*`--2d-type` - The type of steric contributions to use. Options include Crippen molar refractivities or McGowan volume
After installation, the `dbstep` command is available directly on the command line, or run as a module with `python -m dbstep`.
51
59
60
+
#### Development install
61
+
```
62
+
git clone https://github.com/patonlab/DBSTEP.git
63
+
cd DBSTEP
64
+
uv sync --extra dev
65
+
```
66
+
52
67
## Citing DBSTEP
53
68
Please reference the DOI of our Zenodo repository with:
54
69
```
55
70
Luchini, G.; Patterson, T.; Paton, R. S. DBSTEP: DFT Based Steric Parameters. 2022, DOI: 10.5281/zenodo.4702097
56
71
```
57
72
58
-
## Usage
73
+
## Usage
59
74
File parsing is done by the [cclib module](https://onlinelibrary.wiley.com/doi/abs/10.1002/jcc.20823), which can parse many quantum chemistry output files along with other common chemical structure file formats (sdf, xyz, pdb). For a full list of acceptable cclib file types, see their documentation [here](https://cclib.github.io/). Additionally, if used in a Python script, DBSTEP can also read coordinate information from [RDKit](https://www.rdkit.org/) mol objects if three-dimensional coordinates are present along with Gaussian 16 cube files containing volumetric density information.
60
75
61
76
To execute the program:
62
77
- Run as a command line module with: `python -m dbstep file --atom1 a1idx --atom2 a2idx`
63
78
64
79
- Run in a Python program by importing: `import dbstep.Dbstep as db` (example below)
DBSTEP currently takes a coordinate file (see information on appropriate file types above) along with reference atoms and other input options for steric measurement. Sterimol parameters are measured and output to the user using the `--sterimol` argument, volume parameters can be requested with the `--volume` option.
92
+
DBSTEP currently takes a coordinate file (see information on appropriate file types above) along with reference atoms and other input options for steric measurement. Sterimol parameters are measured and output to the user using the `--sterimol` argument, volume parameters can be requested with the `--vbur` option.
78
93
79
94
Atoms are specified by referring to the index of an atom in a coordinate file, (ex: "2", referencing the second atom in the file, with indexing starting at 1).
80
95
81
-
For Sterimol parameters, two atoms need to be specified using the arguments `--atom1 [atom1idx]` and `--atom2 [atom2idx]`. The L parameter is measured starting from the specified atom1 coordinates, extending through the atom1-atom2 axis until the end of the molecule is reached. The Bmin and Bmax molecular width parameters are measured on the axis perpendicular to L.
96
+
For Sterimol parameters, two atoms need to be specified using the arguments `--atom1 [atom1idx]` and `--atom2 [atom2idx]`. The L parameter is measured starting from the specified atom1 coordinates, extending through the atom1-atom2 axis until the end of the molecule is reached. The Bmin and Bmax molecular width parameters are measured on the axis perpendicular to L.
82
97
83
-
For buried volume parameters, only the `--atom1 [atom]` argument is necessary to specify.
98
+
For buried volume parameters, only the `--atom1 [atom]` argument is necessary to specify.
84
99
85
-
If no atoms are specified, the first two atoms in the file will be used as reference.
100
+
If no atoms are specified, the first two atoms in the file will be used as reference.
86
101
87
102
### Examples
88
-
Examples for obtaining Sterimol, Sterimol2Vec, Percent Buried Volume and Vol2Vec parameter sets are shown below (all example files found in examples/ directory).
103
+
Examples for obtaining Sterimol, Sterimol2Vec, Percent Buried Volume and Vol2Vec parameter sets are shown below (all example files found in dbstep/data/ directory).
89
104
90
105
1. Sterimol Parameters for Ethane
91
-
106
+
92
107
Obtain the Sterimol parameters for an ethane molecule along the C2-C5 bond on the command line:
A visualization of these parameters can be shown in the program PyMOL using the two output files created by DBSTEP, showing the L parameter in blue, Bmin parameter in green and Bmax parameter in red.
117
+
A visualization of these parameters can be shown in PyMOL using the two output files created by DBSTEP, showing the L parameter in blue, Bmin parameter in green and Bmax parameter in red.
113
118
114
-
119
+
<imgsrc="images/Example1.png"width="50%">
115
120
116
121
2. Sterimol2Vec Parameters for Ph
117
122
118
123
The `--scan` argument is formatted as `rmin:rmax:interval` where rmin is the distance from the center along the L axis to start measurements, rmax dictates when to stop measurements, and interval is the frequency of measurements. In this case the length of the molecule (~6A) is measured in 1.0A intervals
Displayed in PyMOL, each new Bmin and Bmax axis is added along the L axis.
130
143
131
-
L parameter is 5.95 Ang
144
+
<imgsrc="images/Example2.png"width="50%">
145
+
146
+
3. Percent Buried Volume
132
147
133
-
```
134
-
135
-
Displayed in PyMOL, each new Bmin and Bmax axis is added along the L axis.
136
-
137
-
138
-
139
-
3. Percent Buried Volume
140
-
141
148
%Vb is measured by constructing a sphere (typically with a 3.5A radius) around the center atom and measuring how much of the sphere is occupied by the molecule. Output will include the sphere radius, percent buried volume (%V_Bur) and percent buried shell volume (%S_Bur) (zero in all cases unless a scan is being done simultaneously).
For percent buried volume, the PyMOL script will overlay an appropriate sized sphere where measurement took place.
159
+
160
+
<imgsrc="images/Example3.png"width="50%">
161
+
152
162
4. Vol2Vec Parameters
153
-
154
-
When invoking the --volume and --scan parameters simultaneously, vol2vec parameters can be obtained. In this case, a scan is performed using spheres with radii from 2.0A to 4.0A in 0.5A increments.
To calculate 2d graph-based additive sterics, the arguments --2d --fg --maxpath and --2d-type can be used. An input file listing SMILES strings of desired molecule measurements is necessary for calculation. The --fg argument specifies a SMILES string that is common in all provided SMILES inputs to use as a reference point for layer 0. A connectivity matrix will then be used to find atoms 1, 2, 3... N bonds away where N is the max path length specified with the --maxpath argument. One of two types of measurements will be summed at each layer, either Crippen molar refractivities or McGowan volumes, computed for each atom. This can be changed with the --2d-type argument.
169
-
163
+
164
+
When invoking the --vbur and --scan parameters simultaneously, vol2vec parameters can be obtained. In this case, a scan is performed using spheres with radii from 2.0A to 4.0A in 0.5A increments.
To calculate 2d graph-based additive sterics, the arguments --2d --fg --maxpath and --2d-type can be used. An input file listing SMILES strings of desired molecule measurements is necessary for calculation. The --fg argument specifies a SMILES string that is common in all provided SMILES inputs to use as a reference point for layer 0. A connectivity matrix will then be used to find atoms 1, 2, 3... N bonds away where N is the max path length specified with the --maxpath argument. One of two types of measurements will be summed at each layer, either Crippen molar refractivities or McGowan volumes, computed for each atom. This can be changed with the --2d-type argument.
This work is developed by Guilian Luchini, Toby Patterson and Robert Paton and is supported by the [NSF Center for Computer-Assisted Synthesis](https://ccas.nd.edu/), grant number [CHE-1925607](https://www.nsf.gov/awardsearch/showAward?AWD_ID=1925607&HistoricalAwards=false)
1. Verloop, A., Drug Design. Ariens, E. J., Ed. Academic Press: New York, **1976**; Vol. III
202
-
2. Hillier, A. C.; Sommer, W. J.; Yong, B. S.; Petersen, J. L.; Cavallo, L.; Nolan, S. P. *Organometallics***2003**, *22*, 4322-4326.
198
+
|4.55|11.68|0|0|0|CC(O)=O|
199
+
|4.55|8.21|11.68|0|0|CCC(O)=O|
200
+
|4.55|8.21|8.21|11.68|0|CCCC(O)=O|
201
+
|4.55|8.21|8.21|8.21|11.68|CCCCC(O)=O|
202
+
|4.55|4.74|23.36|0|0|CC(C)C(O)=O|
203
+
|4.55|4.74|19.89|11.68|0|CCC(C)C(O)=O|
204
+
205
+
### Acknowledgements
206
+
207
+
This work is developed by Guilian Luchini, Toby Patterson and Robert Paton and is supported by the [NSF Center for Computer-Assisted Synthesis](https://ccas.nd.edu/), grant number [CHE-1925607](https://www.nsf.gov/awardsearch/showAward?AWD_ID=1925607&HistoricalAwards=false)
0 commit comments