Skip to content

Commit 04506c1

Browse files
committed
Merge branch 'master' of github.com:QChASM/AaronTools.py
2 parents 6415b0e + 487d287 commit 04506c1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+25784
-771
lines changed

README.md

Lines changed: 48 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,63 @@
1-
<a href="https://badge.fury.io/py/AaronTools"><img src="https://badge.fury.io/py/AaronTools.svg" alt="PyPI version" height="18"></a>
1+
<a href="https://badge.fury.io/py/AaronTools"><img src="https://badge.fury.io/py/AaronTools.svg" alt="PyPI version"></a>
2+
<a href="https://doi.org/10.1002/wcms.1510"><img src="https://img.shields.io/badge/DOI-10.1002/wcms.1510-blue"></a>
23
# AaronTools.py
34
AaronTools provides a collection of tools for automating routine tasks encountered when running quantum chemistry computations.
45

56
These tools can be used either directly within a Python script using AaronTools objects, or via a series of command-line scripts.
67

7-
See the <a href="https://github.com/QChASM/AaronTools.py/wiki">Wiki</a> for installation and usage.
8+
## Installation
89

9-
AaronTools is described in
10-
"QChASM: Quantum Chemistry Automation and Structure Manipulation" <a href="http://dx.doi.org/10.1002/wcms.1510" target="_blank"><i>WIREs Comp. Mol. Sci.</i> <b>11</b>, e1510 (2021)</a>.
10+
AaronTools can be installed from <a href="https://pypi.org/project/AaronTools/">PyPI</a> or from GitHub. See the <a href="https://github.com/QChASM/AaronTools.py/wiki">Wiki</a> for installation details and usage.
1111

12-
A Perl implementation of AaronTools is also <a href="https://github.com/QChASM/AaronTools">available here.</a>
13-
However, users are <em>strongly urged</em> to use the Python version since it has far more powerful features and, unlike the Perl version, will continue to be developed and supported.
1412

1513
## Citation
1614
If you use the Python AaronTools, please cite:
1715

1816
V. M. Ingman, A. J. Schaefer, L. R. Andreola, and S. E. Wheeler "QChASM: Quantum Chemistry Automation and Structure Manipulation" <a href="http://dx.doi.org/10.1002/wcms.1510" target="_blank"><i>WIREs Comp. Mol. Sci.</i> <b>11</b>, e1510 (2021)</a>
1917

18+
19+
## Features
20+
AaronTools has a wide variety of features that can be accessed through the Python API as well as command line scripts (CLSs). These features include, but are not limited to:
21+
22+
* Calculating steric parameters
23+
* Sterimol Parameters, including Sterimol2Vec (<a href="https://github.com/QChASM/AaronTools.py/wiki/Command-Line-Scripts#user-content-substituentSterimol">substituent CLS</a>, <a href="https://github.com/QChASM/AaronTools.py/wiki/Command-Line-Scripts#user-content-ligandSterimol">ligand CLS</a>, <a href="https://github.com/QChASM/AaronTools.py/blob/ff461166927faff684d6d16e4deb1e4a45375eae/substituent.py#L504">substituent API</a>, <a href="https://github.com/QChASM/AaronTools.py/blob/ff461166927faff684d6d16e4deb1e4a45375eae/component.py#L219">ligand API</a>)
24+
* Buried Volume (<a href="https://github.com/QChASM/AaronTools.py/wiki/Command-Line-Scripts#user-content-percentVolumeBuried">CLS</a>, <a href="https://github.com/QChASM/AaronTools.py/blob/ff461166927faff684d6d16e4deb1e4a45375eae/geometry.py#L2408">API</a>)
25+
* Steric Maps (<a href="https://github.com/QChASM/AaronTools.py/wiki/Command-Line-Scripts#user-content-stericMap">CLS</a>, <a href="https://github.com/QChASM/AaronTools.py/blob/ff461166927faff684d6d16e4deb1e4a45375eae/geometry.py#L2739">API</a>)
26+
* Ligand Solid Angle (<a href="">CLS</a>, <a href="https://github.com/QChASM/AaronTools.py/blob/ff461166927faff684d6d16e4deb1e4a45375eae/component.py#L901">API</a>)
27+
* Ligand Cone Angle - Tolman for asymmetric mono- and bidentate ligands, as well as exact cone angles (<a href="https://github.com/QChASM/AaronTools.py/wiki/Command-Line-Scripts#user-content-coneAngle">CLS</a>, <a href="https://github.com/QChASM/AaronTools.py/blob/ff461166927faff684d6d16e4deb1e4a45375eae/component.py#L456">API</a>)
28+
* Molecular Structure Editing
29+
* add or modify substituents (<a href="https://github.com/QChASM/AaronTools.py/wiki/Command-Line-Scripts#user-content-substitute">single CLS</a>, <a href="https://github.com/QChASM/AaronTools.py/wiki/Command-Line-Scripts#user-content-multiSubstitute">batch CLS</a>, <a href="https://github.com/QChASM/AaronTools.py/blob/ff461166927faff684d6d16e4deb1e4a45375eae/geometry.py#L3979">single API</a>)
30+
* swap ligands (<a href="https://github.com/QChASM/AaronTools.py/wiki/Command-Line-Scripts#user-content-mapLigand">CLS</a>, <a href="https://github.com/QChASM/AaronTools.py/blob/ff461166927faff684d6d16e4deb1e4a45375eae/geometry.py#L4907">API</a>)
31+
* Generating Molecular Structures
32+
* coordination complexes (<a href="https://github.com/QChASM/AaronTools.py/wiki/Command-Line-Scripts#user-content-getCoordinationComplexes">CLS</a>, <a href="https://github.com/QChASM/AaronTools.py/blob/ff461166927faff684d6d16e4deb1e4a45375eae/geometry.py#L271">API</a>)
33+
* organic molecules from SMILES or IUPAC (<a href="https://github.com/QChASM/AaronTools.py/wiki/Command-Line-Scripts#user-content-fetchMolecule">CLS</a>, <a href="https://github.com/QChASM/AaronTools.py/blob/ff461166927faff684d6d16e4deb1e4a45375eae/geometry.py#L154">API</a>)
34+
* Quantum Computation Setup and Processing
35+
* making input files for Gaussian, ORCA, Psi4, Q-Chem, xTB, and SQM (<a href="https://github.com/QChASM/AaronTools.py/wiki/Command-Line-Scripts#user-content-makeInput">CLS</a>, <a href="https://github.com/QChASM/AaronTools.py/blob/ff461166927faff684d6d16e4deb1e4a45375eae/fileIO.py#L190">API</a>)
36+
* parsing data from output files (<a href="https://github.com/QChASM/AaronTools.py/wiki/Command-Line-Scripts#user-content-printInfo">CLS</a>, <a href="https://github.com/QChASM/AaronTools.py/blob/ff461166927faff684d6d16e4deb1e4a45375eae/fileIO.py#L1077">API</a>)
37+
* thermochemistry based on Boltzmann-populated vibrational modes (<a href="https://github.com/QChASM/AaronTools.py/wiki/Command-Line-Scripts#user-content-grabThermo">CLS</a>, <a href="https://github.com/QChASM/AaronTools.py/blob/ff461166927faff684d6d16e4deb1e4a45375eae/comp_output.py#L36">API</a>)
38+
* normal vibrational modes (<a href="https://github.com/QChASM/AaronTools.py/wiki/Command-Line-Scripts#user-content-follow">displace along mode CLS</a>, <a href="https://github.com/QChASM/AaronTools.py/wiki/Command-Line-Scripts#user-content-printFreq">print data CLS</a>, <a href="https://github.com/QChASM/AaronTools.py/wiki/Command-Line-Scripts#user-content-plotIR">IR or VCD spectrum CLS</a>, <a href="https://github.com/QChASM/AaronTools.py/blob/ff461166927faff684d6d16e4deb1e4a45375eae/spectra.py#L691">API</a>)
39+
* valence excitations (<a href="https://github.com/QChASM/AaronTools.py/wiki/Command-Line-Scripts#user-content-plotUVVispy">UV/vis or ECD spectrum CLS</a>, <a href="https://github.com/QChASM/AaronTools.py/blob/ff461166927faff684d6d16e4deb1e4a45375eae/spectra.py#L1327">API</a>)
40+
* orbitals, electron density, and Fukui functions (<a href="https://github.com/QChASM/AaronTools.py/wiki/Command-Line-Scripts#printcube">CLS</a>, <a href="https://github.com/QChASM/AaronTools.py/blob/e5f218341e47c74e41df3340ab6a31d3cadcaf6a/orbitals.py#L14">API</a>)
41+
* Parse output from output files of several popular quantum chemistry programs (<a href="https://github.com/QChASM/AaronTools.py/wiki/Tutorials:-Coding-with-FileReaders">wiki</a>)
42+
* Gaussian
43+
* ORCA
44+
* Psi4
45+
* Q-Chem
46+
* NBO
47+
* xTB
48+
49+
Features are explained in more detail on various pages of the wiki, on help pages for various CLSs, and in docstrings of the Python API.
50+
51+
52+
## Other Versions
53+
54+
### ChimeraX Plugin
55+
The majority of these features are also available with a graphical interface in the <a href="https://cxtoolshed.rbvi.ucsf.edu/apps/seqcrow">SEQCROW plugin</a> for <a href="https://www.cgl.ucsf.edu/chimerax/">ChimeraX</a>.
56+
57+
### Perl
58+
A Perl implementation of AaronTools is also <a href="https://github.com/QChASM/AaronTools">available here.</a>
59+
However, users are <em>strongly urged</em> to use the Python version since it has far more powerful features and, unlike the Perl version, will continue to be developed and supported.
60+
61+
2062
## Contact
2163
If you have any questions or would like to discuss bugs or additional needed features, feel free to contact us at [email protected]

Solvents/1-butanol.xyz

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
15
2+
3+
O 2.36410 -0.34930 -0.00000
4+
C 1.21260 0.49690 0.00000
5+
C -0.05250 -0.36340 -0.00000
6+
C -1.28540 0.54260 -0.00000
7+
C -2.55060 -0.31780 0.00000
8+
H 3.13760 0.23120 0.00000
9+
H 1.22410 1.12610 0.89000
10+
H 1.22410 1.12610 -0.89000
11+
H -0.06400 -0.99260 -0.89000
12+
H -0.06400 -0.99260 0.89000
13+
H -1.27390 1.17180 0.89000
14+
H -1.27390 1.17180 -0.89000
15+
H -3.42890 0.32770 -0.00000
16+
H -2.56210 -0.94700 -0.89000
17+
H -2.56210 -0.94700 0.89000

Solvents/CCl4.xyz

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
5
2+
3+
Cl -0.00000 -1.47210 -1.04100
4+
C 0.00000 -0.00000 0.00000
5+
Cl 0.00000 1.47210 -1.04100
6+
Cl -1.47210 -0.00000 1.04100
7+
Cl 1.47210 -0.00000 1.04100

Solvents/acetic_acid.xyz

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
8
2+
3+
C 1.41830 0.42130 -0.00000
4+
C -0.01080 -0.05680 -0.00000
5+
O -1.01610 0.83270 -0.00000
6+
O -0.25180 -1.24080 0.00000
7+
H 1.76290 0.53650 1.02770
8+
H 2.04520 -0.30750 -0.51380
9+
H 1.48060 1.38050 -0.51380
10+
H -1.93310 0.52590 0.00000

Solvents/acetone.xyz

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
10
2+
3+
C 1.30510 -0.67720 0.00000
4+
C 0.00000 0.07630 -0.00000
5+
O -0.00000 1.28390 0.00000
6+
C -1.30510 -0.67720 -0.00000
7+
H 2.13360 0.03110 0.00000
8+
H 1.36280 -1.30380 0.89000
9+
H 1.36280 -1.30380 -0.89000
10+
H -1.61980 -0.85880 1.02770
11+
H -2.06470 -0.08810 -0.51380
12+
H -1.17480 -1.62960 -0.51380

Solvents/acetonitrile.xyz

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
6
2+
3+
C 1.29390 -0.00000 -0.00000
4+
C -0.17810 0.00000 -0.00000
5+
N -1.31410 0.00000 0.00000
6+
H 1.65720 -0.00000 1.02770
7+
H 1.65720 -0.89000 -0.51380
8+
H 1.65720 0.89000 -0.51380

Solvents/benzene.xyz

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
12
2+
3+
C 0.16410 -1.37260 -0.00020
4+
C -1.10660 -0.82840 0.00010
5+
C -1.27070 0.54420 -0.00000
6+
C -0.16410 1.37260 0.00000
7+
C 1.10660 0.82840 0.00060
8+
C 1.27070 -0.54420 -0.00070
9+
H 0.29230 -2.44490 0.00440
10+
H -1.97120 -1.47560 0.00000
11+
H -2.26350 0.96930 -0.00050
12+
H -0.29230 2.44490 -0.00080
13+
H 1.97120 1.47560 -0.00010
14+
H 2.26350 -0.96930 0.00020

Solvents/chloroform.xyz

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
5
2+
3+
Cl -1.69950 -0.03500 0.07470
4+
C 0.00000 -0.00000 -0.52630
5+
Cl 0.81940 1.48930 0.07470
6+
Cl 0.88010 -1.45430 0.07470
7+
H -0.00000 0.00000 -1.61630

Solvents/tBuOH.xyz

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
15
2+
3+
C 0.41910 1.24920 0.77030
4+
C -0.01420 0.00000 0.00050
5+
C 0.41910 -1.24920 0.77030
6+
C -1.53610 0.00000 -0.15650
7+
O 0.59790 0.00000 -1.29080
8+
H 1.50340 1.24920 0.88210
9+
H 0.11040 2.13920 0.22190
10+
H -0.04770 1.24920 1.75530
11+
H -0.04770 -1.24920 1.75530
12+
H 0.11040 -2.13920 0.22190
13+
H 1.50340 -1.24920 0.88210
14+
H -1.84480 0.89000 -0.70490
15+
H -1.84480 -0.89000 -0.70490
16+
H -2.00300 0.00000 0.82850
17+
H 1.55410 -0.00000 -1.14680

Solvents/water.xyz

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
3
2+
3+
O -0.00000 -0.06450 -0.00000
4+
H -0.77630 0.51200 0.00000
5+
H 0.77630 0.51200 0.00000

0 commit comments

Comments
 (0)