xtb-step 2026.5.12__tar.gz
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.
- xtb_step-2026.5.12/AUTHORS.rst +5 -0
- xtb_step-2026.5.12/CONTRIBUTING.rst +113 -0
- xtb_step-2026.5.12/HISTORY.rst +10 -0
- xtb_step-2026.5.12/LICENSE +31 -0
- xtb_step-2026.5.12/MANIFEST.in +14 -0
- xtb_step-2026.5.12/PKG-INFO +158 -0
- xtb_step-2026.5.12/README.rst +104 -0
- xtb_step-2026.5.12/docs/Makefile +177 -0
- xtb_step-2026.5.12/docs/_static/SEAMM Inverted 288x181.png +0 -0
- xtb_step-2026.5.12/docs/_static/SEAMM logo.png +0 -0
- xtb_step-2026.5.12/docs/_static/molssi_main_logo.png +0 -0
- xtb_step-2026.5.12/docs/_static/molssi_main_logo_inverted_white.png +0 -0
- xtb_step-2026.5.12/docs/_static/molssi_square.png +0 -0
- xtb_step-2026.5.12/docs/_static/nsf.png +0 -0
- xtb_step-2026.5.12/docs/api/index.rst +17 -0
- xtb_step-2026.5.12/docs/authors.rst +1 -0
- xtb_step-2026.5.12/docs/conf.py +306 -0
- xtb_step-2026.5.12/docs/developer_guide/campaigns/2026-05-02/NOTES_A.rst +133 -0
- xtb_step-2026.5.12/docs/developer_guide/campaigns/2026-05-02/NOTES_B.rst +217 -0
- xtb_step-2026.5.12/docs/developer_guide/campaigns/2026-05-02/NOTES_C.rst +108 -0
- xtb_step-2026.5.12/docs/developer_guide/campaigns/2026-05-02/NOTES_D.rst +198 -0
- xtb_step-2026.5.12/docs/developer_guide/campaigns/2026-05-02/NOTES_E.rst +124 -0
- xtb_step-2026.5.12/docs/developer_guide/campaigns/2026-05-02/NOTES_F.rst +159 -0
- xtb_step-2026.5.12/docs/developer_guide/campaigns/2026-05-02/NOTES_G.rst +139 -0
- xtb_step-2026.5.12/docs/developer_guide/campaigns/2026-05-02/NOTES_H.rst +172 -0
- xtb_step-2026.5.12/docs/developer_guide/campaigns/2026-05-02/NOTES_I.rst +187 -0
- xtb_step-2026.5.12/docs/developer_guide/campaigns/2026-05-02/NOTES_Installer.rst +106 -0
- xtb_step-2026.5.12/docs/developer_guide/campaigns/2026-05-02/index.rst +18 -0
- xtb_step-2026.5.12/docs/developer_guide/campaigns/2026-05-02/xtb_step_v1_scope.rst +330 -0
- xtb_step-2026.5.12/docs/developer_guide/campaigns/index.rst +11 -0
- xtb_step-2026.5.12/docs/developer_guide/contributing.rst +1 -0
- xtb_step-2026.5.12/docs/developer_guide/index.rst +28 -0
- xtb_step-2026.5.12/docs/developer_guide/installation.rst +54 -0
- xtb_step-2026.5.12/docs/developer_guide/usage.rst +7 -0
- xtb_step-2026.5.12/docs/getting_started/index.rst +83 -0
- xtb_step-2026.5.12/docs/history.rst +1 -0
- xtb_step-2026.5.12/docs/index.rst +76 -0
- xtb_step-2026.5.12/docs/make.bat +242 -0
- xtb_step-2026.5.12/docs/user_guide/energy.rst +69 -0
- xtb_step-2026.5.12/docs/user_guide/frequencies.rst +102 -0
- xtb_step-2026.5.12/docs/user_guide/index.rst +71 -0
- xtb_step-2026.5.12/docs/user_guide/methods.rst +108 -0
- xtb_step-2026.5.12/docs/user_guide/optimization.rst +68 -0
- xtb_step-2026.5.12/docs/user_guide/results.rst +106 -0
- xtb_step-2026.5.12/docs/user_guide/solvation.rst +95 -0
- xtb_step-2026.5.12/requirements.txt +3 -0
- xtb_step-2026.5.12/requirements_dev.txt +10 -0
- xtb_step-2026.5.12/requirements_install.txt +4 -0
- xtb_step-2026.5.12/setup.cfg +27 -0
- xtb_step-2026.5.12/setup.py +100 -0
- xtb_step-2026.5.12/tests/__init__.py +3 -0
- xtb_step-2026.5.12/tests/test_xtb_step.py +13 -0
- xtb_step-2026.5.12/versioneer.py +1822 -0
- xtb_step-2026.5.12/xtb_step/__init__.py +40 -0
- xtb_step-2026.5.12/xtb_step/__main__.py +22 -0
- xtb_step-2026.5.12/xtb_step/_version.py +21 -0
- xtb_step-2026.5.12/xtb_step/data/properties.csv +14 -0
- xtb_step-2026.5.12/xtb_step/data/references.bib +195 -0
- xtb_step-2026.5.12/xtb_step/data/seamm-xtb.yml +6 -0
- xtb_step-2026.5.12/xtb_step/data/xtb.ini +71 -0
- xtb_step-2026.5.12/xtb_step/energy.py +493 -0
- xtb_step-2026.5.12/xtb_step/energy_parameters.py +136 -0
- xtb_step-2026.5.12/xtb_step/energy_step.py +95 -0
- xtb_step-2026.5.12/xtb_step/frequencies.py +349 -0
- xtb_step-2026.5.12/xtb_step/frequencies_parameters.py +82 -0
- xtb_step-2026.5.12/xtb_step/frequencies_step.py +95 -0
- xtb_step-2026.5.12/xtb_step/installer.py +131 -0
- xtb_step-2026.5.12/xtb_step/metadata.py +253 -0
- xtb_step-2026.5.12/xtb_step/optimization.py +183 -0
- xtb_step-2026.5.12/xtb_step/optimization_parameters.py +97 -0
- xtb_step-2026.5.12/xtb_step/optimization_step.py +95 -0
- xtb_step-2026.5.12/xtb_step/substep.py +563 -0
- xtb_step-2026.5.12/xtb_step/tk_energy.py +185 -0
- xtb_step-2026.5.12/xtb_step/tk_frequencies.py +108 -0
- xtb_step-2026.5.12/xtb_step/tk_optimization.py +94 -0
- xtb_step-2026.5.12/xtb_step/tk_xtb.py +151 -0
- xtb_step-2026.5.12/xtb_step/xtb.py +223 -0
- xtb_step-2026.5.12/xtb_step/xtb_step.py +95 -0
- xtb_step-2026.5.12/xtb_step.egg-info/PKG-INFO +158 -0
- xtb_step-2026.5.12/xtb_step.egg-info/SOURCES.txt +84 -0
- xtb_step-2026.5.12/xtb_step.egg-info/dependency_links.txt +1 -0
- xtb_step-2026.5.12/xtb_step.egg-info/entry_points.txt +18 -0
- xtb_step-2026.5.12/xtb_step.egg-info/requires.txt +3 -0
- xtb_step-2026.5.12/xtb_step.egg-info/top_level.txt +1 -0
- xtb_step-2026.5.12/xtb_step.egg-info/zip-safe +1 -0
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
.. highlight:: shell
|
|
2
|
+
|
|
3
|
+
============
|
|
4
|
+
Contributing
|
|
5
|
+
============
|
|
6
|
+
|
|
7
|
+
Contributions are welcome, and they are greatly appreciated! Every
|
|
8
|
+
little bit helps, and credit will always be given.
|
|
9
|
+
|
|
10
|
+
You can contribute in many ways:
|
|
11
|
+
|
|
12
|
+
Types of Contributions
|
|
13
|
+
----------------------
|
|
14
|
+
|
|
15
|
+
Report Bugs
|
|
16
|
+
~~~~~~~~~~~
|
|
17
|
+
|
|
18
|
+
Report bugs at https://github.com/molssi-seamm/xtb_step/issues.
|
|
19
|
+
|
|
20
|
+
If you are reporting a bug, please include:
|
|
21
|
+
|
|
22
|
+
* Your operating system name and version.
|
|
23
|
+
* Any details about your local setup that might be helpful in troubleshooting.
|
|
24
|
+
* Detailed steps to reproduce the bug.
|
|
25
|
+
|
|
26
|
+
Fix Bugs
|
|
27
|
+
~~~~~~~~
|
|
28
|
+
|
|
29
|
+
Look through the GitHub issues for bugs. Anything tagged with "bug"
|
|
30
|
+
and "help wanted" is open to whoever wants to implement it.
|
|
31
|
+
|
|
32
|
+
Implement Features
|
|
33
|
+
~~~~~~~~~~~~~~~~~~
|
|
34
|
+
|
|
35
|
+
Look through the GitHub issues for features. Anything tagged with "enhancement"
|
|
36
|
+
and "help wanted" is open to whoever wants to implement it.
|
|
37
|
+
|
|
38
|
+
Write Documentation
|
|
39
|
+
~~~~~~~~~~~~~~~~~~~
|
|
40
|
+
|
|
41
|
+
xTB Step could always use more documentation, whether as part of the
|
|
42
|
+
official xTB Step docs, in docstrings, or even on the web in blog posts,
|
|
43
|
+
articles, and such.
|
|
44
|
+
|
|
45
|
+
Submit Feedback
|
|
46
|
+
~~~~~~~~~~~~~~~
|
|
47
|
+
|
|
48
|
+
The best way to send feedback is to file an issue at https://github.com/molssi-seamm/xtb_step/issues.
|
|
49
|
+
|
|
50
|
+
If you are proposing a feature:
|
|
51
|
+
|
|
52
|
+
* Explain in detail how it would work.
|
|
53
|
+
* Keep the scope as narrow as possible, to make it easier to implement.
|
|
54
|
+
* Remember that this is a volunteer-driven project, and that contributions
|
|
55
|
+
are welcome :)
|
|
56
|
+
|
|
57
|
+
Get Started!
|
|
58
|
+
------------
|
|
59
|
+
|
|
60
|
+
Ready to contribute? Here's how to set up `xtb_step` for local development.
|
|
61
|
+
|
|
62
|
+
1. Fork the `xtb_step` repo on GitHub.
|
|
63
|
+
2. Clone your fork locally::
|
|
64
|
+
|
|
65
|
+
$ git clone git@github.com:your_name_here/xtb_step.git
|
|
66
|
+
|
|
67
|
+
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
|
|
68
|
+
|
|
69
|
+
$ mkvirtualenv xtb_step
|
|
70
|
+
$ cd xtb_step/
|
|
71
|
+
$ python setup.py develop
|
|
72
|
+
|
|
73
|
+
4. Create a branch for local development::
|
|
74
|
+
|
|
75
|
+
$ git checkout -b name-of-your-bugfix-or-feature
|
|
76
|
+
|
|
77
|
+
Now you can make your changes locally.
|
|
78
|
+
|
|
79
|
+
5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
|
|
80
|
+
|
|
81
|
+
$ flake8 xtb_step tests
|
|
82
|
+
$ python setup.py test or py.test
|
|
83
|
+
$ tox
|
|
84
|
+
|
|
85
|
+
To get flake8 and tox, just pip install them into your virtualenv.
|
|
86
|
+
|
|
87
|
+
6. Commit your changes and push your branch to GitHub::
|
|
88
|
+
|
|
89
|
+
$ git add .
|
|
90
|
+
$ git commit -m "Your detailed description of your changes."
|
|
91
|
+
$ git push origin name-of-your-bugfix-or-feature
|
|
92
|
+
|
|
93
|
+
7. Submit a pull request through the GitHub website.
|
|
94
|
+
|
|
95
|
+
Pull Request Guidelines
|
|
96
|
+
-----------------------
|
|
97
|
+
|
|
98
|
+
Before you submit a pull request, check that it meets these guidelines:
|
|
99
|
+
|
|
100
|
+
1. The pull request should include tests.
|
|
101
|
+
2. If the pull request adds functionality, the docs should be updated. Put
|
|
102
|
+
your new functionality into a function with a docstring, and add the
|
|
103
|
+
feature to the list in README.rst.
|
|
104
|
+
3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check
|
|
105
|
+
https://travis-ci.org/molssi-seamm/xtb_step/pull_requests
|
|
106
|
+
and make sure that the tests pass for all supported Python versions.
|
|
107
|
+
|
|
108
|
+
Tips
|
|
109
|
+
----
|
|
110
|
+
|
|
111
|
+
To run a subset of tests::
|
|
112
|
+
|
|
113
|
+
$ py.test tests.test_xtb_step
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
=======
|
|
2
|
+
History
|
|
3
|
+
=======
|
|
4
|
+
|
|
5
|
+
2026.5.2: Plug-in created using the SEAMM plug-in cookiecutter.
|
|
6
|
+
|
|
7
|
+
2026.5.12: Initial working version
|
|
8
|
+
* Support for Energy, Optimization, and Frequencies
|
|
9
|
+
* GFN0-xTB, GFN1-xTB, GFN2-xTB (the default), and GFN-FF supported
|
|
10
|
+
* ALPB, GBSA, or CPCM-X implicit solvation
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
|
|
2
|
+
BSD 3-Clause License
|
|
3
|
+
|
|
4
|
+
Copyright (c) 2026, Paul Saxe
|
|
5
|
+
All rights reserved.
|
|
6
|
+
|
|
7
|
+
Redistribution and use in source and binary forms, with or without
|
|
8
|
+
modification, are permitted provided that the following conditions are met:
|
|
9
|
+
|
|
10
|
+
1. Redistributions of source code must retain the above copyright notice, this
|
|
11
|
+
list of conditions and the following disclaimer.
|
|
12
|
+
|
|
13
|
+
2. Redistributions in binary form must reproduce the above copyright notice,
|
|
14
|
+
this list of conditions and the following disclaimer in the documentation
|
|
15
|
+
and/or other materials provided with the distribution.
|
|
16
|
+
|
|
17
|
+
3. Neither the name of the copyright holder nor the names of its
|
|
18
|
+
contributors may be used to endorse or promote products derived from
|
|
19
|
+
this software without specific prior written permission.
|
|
20
|
+
|
|
21
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
22
|
+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
23
|
+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
24
|
+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
25
|
+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
26
|
+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
27
|
+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
28
|
+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
29
|
+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
30
|
+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
31
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
include AUTHORS.rst
|
|
2
|
+
include CONTRIBUTING.rst
|
|
3
|
+
include HISTORY.rst
|
|
4
|
+
include LICENSE
|
|
5
|
+
include README.rst
|
|
6
|
+
include requirements*
|
|
7
|
+
include versioneer.py
|
|
8
|
+
|
|
9
|
+
recursive-include xtb_step/data *
|
|
10
|
+
recursive-include tests *
|
|
11
|
+
recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
|
|
12
|
+
|
|
13
|
+
recursive-exclude * __pycache__
|
|
14
|
+
recursive-exclude * *.py[co]
|
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: xtb_step
|
|
3
|
+
Version: 2026.5.12
|
|
4
|
+
Summary: A SEAMM plug-in for xTB
|
|
5
|
+
Home-page: https://github.com/molssi-seamm/xtb_step
|
|
6
|
+
Author: Paul Saxe
|
|
7
|
+
Author-email: psaxe@molssi.org
|
|
8
|
+
License: BSD-3-Clause
|
|
9
|
+
Keywords: SEAMM,SEAMMplugin,flowchart
|
|
10
|
+
Platform: Linux
|
|
11
|
+
Platform: Mac OS-X
|
|
12
|
+
Platform: Unix
|
|
13
|
+
Platform: Windows
|
|
14
|
+
Classifier: Environment :: Plugins
|
|
15
|
+
Classifier: Development Status :: 2 - Pre-Alpha
|
|
16
|
+
Classifier: Intended Audience :: Science/Research
|
|
17
|
+
Classifier: Topic :: Scientific/Engineering :: Chemistry
|
|
18
|
+
Classifier: Topic :: Scientific/Engineering :: Physics
|
|
19
|
+
Classifier: License :: OSI Approved :: BSD License
|
|
20
|
+
Classifier: Natural Language :: English
|
|
21
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
23
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
24
|
+
Description-Content-Type: text/x-rst
|
|
25
|
+
License-File: LICENSE
|
|
26
|
+
License-File: AUTHORS.rst
|
|
27
|
+
Requires-Dist: seamm
|
|
28
|
+
Requires-Dist: seamm-util
|
|
29
|
+
Requires-Dist: seamm-widgets
|
|
30
|
+
Dynamic: author
|
|
31
|
+
Dynamic: author-email
|
|
32
|
+
Dynamic: classifier
|
|
33
|
+
Dynamic: description
|
|
34
|
+
Dynamic: description-content-type
|
|
35
|
+
Dynamic: home-page
|
|
36
|
+
Dynamic: keywords
|
|
37
|
+
Dynamic: license
|
|
38
|
+
Dynamic: license-file
|
|
39
|
+
Dynamic: platform
|
|
40
|
+
Dynamic: requires-dist
|
|
41
|
+
Dynamic: summary
|
|
42
|
+
|
|
43
|
+
=================
|
|
44
|
+
SEAMM xTB Plug-in
|
|
45
|
+
=================
|
|
46
|
+
|
|
47
|
+
.. image:: https://img.shields.io/github/issues-pr-raw/molssi-seamm/xtb_step
|
|
48
|
+
:target: https://github.com/molssi-seamm/xtb_step/pulls
|
|
49
|
+
:alt: GitHub pull requests
|
|
50
|
+
|
|
51
|
+
.. image:: https://github.com/molssi-seamm/xtb_step/workflows/CI/badge.svg
|
|
52
|
+
:target: https://github.com/molssi-seamm/xtb_step/actions
|
|
53
|
+
:alt: Build Status
|
|
54
|
+
|
|
55
|
+
.. image:: https://codecov.io/gh/molssi-seamm/xtb_step/branch/master/graph/badge.svg
|
|
56
|
+
:target: https://codecov.io/gh/molssi-seamm/xtb_step
|
|
57
|
+
:alt: Code Coverage
|
|
58
|
+
|
|
59
|
+
.. image:: https://github.com/molssi-seamm/xtb_step/workflows/CodeQL/badge.svg
|
|
60
|
+
:target: https://github.com/molssi-seamm/xtb_step/security/code-scanning
|
|
61
|
+
:alt: Code Quality
|
|
62
|
+
|
|
63
|
+
.. image:: https://github.com/molssi-seamm/xtb_step/workflows/Release/badge.svg
|
|
64
|
+
:target: https://molssi-seamm.github.io/xtb_step/index.html
|
|
65
|
+
:alt: Documentation Status
|
|
66
|
+
|
|
67
|
+
.. image:: https://img.shields.io/pypi/v/xtb_step.svg
|
|
68
|
+
:target: https://pypi.python.org/pypi/xtb_step
|
|
69
|
+
:alt: PyPi VERSION
|
|
70
|
+
|
|
71
|
+
A SEAMM plug-in for the `xTB <https://github.com/grimme-lab/xtb>`_ family
|
|
72
|
+
of extended tight-binding methods from the Grimme group.
|
|
73
|
+
|
|
74
|
+
* Free software: BSD-3-Clause
|
|
75
|
+
* Documentation: https://molssi-seamm.github.io/xtb_step/index.html
|
|
76
|
+
* Code: https://github.com/molssi-seamm/xtb_step
|
|
77
|
+
|
|
78
|
+
Features
|
|
79
|
+
--------
|
|
80
|
+
|
|
81
|
+
* Single-point energies, geometry optimizations, and harmonic
|
|
82
|
+
vibrational frequencies for molecular (non-periodic) systems.
|
|
83
|
+
* The full set of xTB Hamiltonians and the GFN-FF force field:
|
|
84
|
+
|
|
85
|
+
- **GFN2-xTB** (default) -- self-consistent, multipole electrostatics,
|
|
86
|
+
density-dependent dispersion. Recommended for general use.
|
|
87
|
+
- **GFN1-xTB** -- earlier self-consistent method.
|
|
88
|
+
- **GFN0-xTB** -- non-self-consistent, useful for robust screening.
|
|
89
|
+
- **GFN-FF** -- generic force field, automatically parameterized.
|
|
90
|
+
|
|
91
|
+
* Implicit solvation with all three xTB-supported models:
|
|
92
|
+
|
|
93
|
+
- **ALPB** -- analytical linearized Poisson-Boltzmann
|
|
94
|
+
(Ehlert et al., *J. Chem. Theory Comput.* **2021**, *17*, 4250).
|
|
95
|
+
- **GBSA** -- generalized-Born model.
|
|
96
|
+
- **CPCM-X** -- conductor-like polarizable continuum
|
|
97
|
+
(Stahn et al., *J. Phys. Chem. A* **2023**, *127*, 7036).
|
|
98
|
+
|
|
99
|
+
with the standard xTB solvent list (water, methanol, DMSO,
|
|
100
|
+
acetonitrile, etc.).
|
|
101
|
+
|
|
102
|
+
* Net charge and spin multiplicity are read from the configuration,
|
|
103
|
+
so the same flowchart works unchanged across O\ :sub:`2`,
|
|
104
|
+
triplet O\ :sub:`2`, and O\ :sub:`2`\ :sup:`+` -- a single loop
|
|
105
|
+
can scan a list of systems with different charge/spin states.
|
|
106
|
+
|
|
107
|
+
* Optimization with all eight xTB convergence levels (crude through
|
|
108
|
+
extreme) and flexible structure handling: overwrite the current
|
|
109
|
+
configuration in place, store the optimized structure as a new
|
|
110
|
+
configuration, store it in a new system, or discard.
|
|
111
|
+
|
|
112
|
+
* Vibrational analysis using xTB's analytic Hessian, with the
|
|
113
|
+
optimize-then-Hessian (``--ohess``) workflow recommended by xTB
|
|
114
|
+
(or ``--hess`` alone if the geometry is already at a stationary
|
|
115
|
+
point). Thermochemistry quantities (ZPE, H(T), T*S, S, G(T),
|
|
116
|
+
total free energy) are reported in chemist-friendly units of
|
|
117
|
+
kJ/mol and J/mol/K, not E\ :sub:`h`.
|
|
118
|
+
|
|
119
|
+
* Tabulated results in the local ``step.out`` and storage in the
|
|
120
|
+
SEAMM property database using the standard ``<name>#xTB#{model}``
|
|
121
|
+
property-naming convention, so downstream plug-ins
|
|
122
|
+
(Thermochemistry, Reaction Path, ...) can pick up the values.
|
|
123
|
+
|
|
124
|
+
* Automatic citation tracking. The principal xTB program reference,
|
|
125
|
+
the active GFN method reference, the DFT-D4 dispersion references
|
|
126
|
+
(for GFN2-xTB), and the implicit-solvation reference are all added
|
|
127
|
+
to the run's reference list automatically.
|
|
128
|
+
|
|
129
|
+
* Automatic installation of the xtb executable into a dedicated
|
|
130
|
+
``seamm-xtb`` conda environment via the standard SEAMM Installer.
|
|
131
|
+
|
|
132
|
+
Acknowledgements
|
|
133
|
+
----------------
|
|
134
|
+
|
|
135
|
+
This package was created with the `molssi-seamm/cookiecutter-seamm-plugin`_ tool, which
|
|
136
|
+
is based on the excellent Cookiecutter_.
|
|
137
|
+
|
|
138
|
+
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
|
|
139
|
+
.. _`molssi-seamm/cookiecutter-seamm-plugin`: https://github.com/molssi-seamm/cookiecutter-seamm-plugin
|
|
140
|
+
|
|
141
|
+
Developed by the Molecular Sciences Software Institute (MolSSI_),
|
|
142
|
+
which receives funding from the `National Science Foundation`_ under
|
|
143
|
+
award CHE-2136142.
|
|
144
|
+
|
|
145
|
+
.. _MolSSI: https://molssi.org
|
|
146
|
+
.. _`National Science Foundation`: https://www.nsf.gov
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
=======
|
|
150
|
+
History
|
|
151
|
+
=======
|
|
152
|
+
|
|
153
|
+
2026.5.2: Plug-in created using the SEAMM plug-in cookiecutter.
|
|
154
|
+
|
|
155
|
+
2026.5.12: Initial working version
|
|
156
|
+
* Support for Energy, Optimization, and Frequencies
|
|
157
|
+
* GFN0-xTB, GFN1-xTB, GFN2-xTB (the default), and GFN-FF supported
|
|
158
|
+
* ALPB, GBSA, or CPCM-X implicit solvation
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
=================
|
|
2
|
+
SEAMM xTB Plug-in
|
|
3
|
+
=================
|
|
4
|
+
|
|
5
|
+
.. image:: https://img.shields.io/github/issues-pr-raw/molssi-seamm/xtb_step
|
|
6
|
+
:target: https://github.com/molssi-seamm/xtb_step/pulls
|
|
7
|
+
:alt: GitHub pull requests
|
|
8
|
+
|
|
9
|
+
.. image:: https://github.com/molssi-seamm/xtb_step/workflows/CI/badge.svg
|
|
10
|
+
:target: https://github.com/molssi-seamm/xtb_step/actions
|
|
11
|
+
:alt: Build Status
|
|
12
|
+
|
|
13
|
+
.. image:: https://codecov.io/gh/molssi-seamm/xtb_step/branch/master/graph/badge.svg
|
|
14
|
+
:target: https://codecov.io/gh/molssi-seamm/xtb_step
|
|
15
|
+
:alt: Code Coverage
|
|
16
|
+
|
|
17
|
+
.. image:: https://github.com/molssi-seamm/xtb_step/workflows/CodeQL/badge.svg
|
|
18
|
+
:target: https://github.com/molssi-seamm/xtb_step/security/code-scanning
|
|
19
|
+
:alt: Code Quality
|
|
20
|
+
|
|
21
|
+
.. image:: https://github.com/molssi-seamm/xtb_step/workflows/Release/badge.svg
|
|
22
|
+
:target: https://molssi-seamm.github.io/xtb_step/index.html
|
|
23
|
+
:alt: Documentation Status
|
|
24
|
+
|
|
25
|
+
.. image:: https://img.shields.io/pypi/v/xtb_step.svg
|
|
26
|
+
:target: https://pypi.python.org/pypi/xtb_step
|
|
27
|
+
:alt: PyPi VERSION
|
|
28
|
+
|
|
29
|
+
A SEAMM plug-in for the `xTB <https://github.com/grimme-lab/xtb>`_ family
|
|
30
|
+
of extended tight-binding methods from the Grimme group.
|
|
31
|
+
|
|
32
|
+
* Free software: BSD-3-Clause
|
|
33
|
+
* Documentation: https://molssi-seamm.github.io/xtb_step/index.html
|
|
34
|
+
* Code: https://github.com/molssi-seamm/xtb_step
|
|
35
|
+
|
|
36
|
+
Features
|
|
37
|
+
--------
|
|
38
|
+
|
|
39
|
+
* Single-point energies, geometry optimizations, and harmonic
|
|
40
|
+
vibrational frequencies for molecular (non-periodic) systems.
|
|
41
|
+
* The full set of xTB Hamiltonians and the GFN-FF force field:
|
|
42
|
+
|
|
43
|
+
- **GFN2-xTB** (default) -- self-consistent, multipole electrostatics,
|
|
44
|
+
density-dependent dispersion. Recommended for general use.
|
|
45
|
+
- **GFN1-xTB** -- earlier self-consistent method.
|
|
46
|
+
- **GFN0-xTB** -- non-self-consistent, useful for robust screening.
|
|
47
|
+
- **GFN-FF** -- generic force field, automatically parameterized.
|
|
48
|
+
|
|
49
|
+
* Implicit solvation with all three xTB-supported models:
|
|
50
|
+
|
|
51
|
+
- **ALPB** -- analytical linearized Poisson-Boltzmann
|
|
52
|
+
(Ehlert et al., *J. Chem. Theory Comput.* **2021**, *17*, 4250).
|
|
53
|
+
- **GBSA** -- generalized-Born model.
|
|
54
|
+
- **CPCM-X** -- conductor-like polarizable continuum
|
|
55
|
+
(Stahn et al., *J. Phys. Chem. A* **2023**, *127*, 7036).
|
|
56
|
+
|
|
57
|
+
with the standard xTB solvent list (water, methanol, DMSO,
|
|
58
|
+
acetonitrile, etc.).
|
|
59
|
+
|
|
60
|
+
* Net charge and spin multiplicity are read from the configuration,
|
|
61
|
+
so the same flowchart works unchanged across O\ :sub:`2`,
|
|
62
|
+
triplet O\ :sub:`2`, and O\ :sub:`2`\ :sup:`+` -- a single loop
|
|
63
|
+
can scan a list of systems with different charge/spin states.
|
|
64
|
+
|
|
65
|
+
* Optimization with all eight xTB convergence levels (crude through
|
|
66
|
+
extreme) and flexible structure handling: overwrite the current
|
|
67
|
+
configuration in place, store the optimized structure as a new
|
|
68
|
+
configuration, store it in a new system, or discard.
|
|
69
|
+
|
|
70
|
+
* Vibrational analysis using xTB's analytic Hessian, with the
|
|
71
|
+
optimize-then-Hessian (``--ohess``) workflow recommended by xTB
|
|
72
|
+
(or ``--hess`` alone if the geometry is already at a stationary
|
|
73
|
+
point). Thermochemistry quantities (ZPE, H(T), T*S, S, G(T),
|
|
74
|
+
total free energy) are reported in chemist-friendly units of
|
|
75
|
+
kJ/mol and J/mol/K, not E\ :sub:`h`.
|
|
76
|
+
|
|
77
|
+
* Tabulated results in the local ``step.out`` and storage in the
|
|
78
|
+
SEAMM property database using the standard ``<name>#xTB#{model}``
|
|
79
|
+
property-naming convention, so downstream plug-ins
|
|
80
|
+
(Thermochemistry, Reaction Path, ...) can pick up the values.
|
|
81
|
+
|
|
82
|
+
* Automatic citation tracking. The principal xTB program reference,
|
|
83
|
+
the active GFN method reference, the DFT-D4 dispersion references
|
|
84
|
+
(for GFN2-xTB), and the implicit-solvation reference are all added
|
|
85
|
+
to the run's reference list automatically.
|
|
86
|
+
|
|
87
|
+
* Automatic installation of the xtb executable into a dedicated
|
|
88
|
+
``seamm-xtb`` conda environment via the standard SEAMM Installer.
|
|
89
|
+
|
|
90
|
+
Acknowledgements
|
|
91
|
+
----------------
|
|
92
|
+
|
|
93
|
+
This package was created with the `molssi-seamm/cookiecutter-seamm-plugin`_ tool, which
|
|
94
|
+
is based on the excellent Cookiecutter_.
|
|
95
|
+
|
|
96
|
+
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
|
|
97
|
+
.. _`molssi-seamm/cookiecutter-seamm-plugin`: https://github.com/molssi-seamm/cookiecutter-seamm-plugin
|
|
98
|
+
|
|
99
|
+
Developed by the Molecular Sciences Software Institute (MolSSI_),
|
|
100
|
+
which receives funding from the `National Science Foundation`_ under
|
|
101
|
+
award CHE-2136142.
|
|
102
|
+
|
|
103
|
+
.. _MolSSI: https://molssi.org
|
|
104
|
+
.. _`National Science Foundation`: https://www.nsf.gov
|
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
# Makefile for Sphinx documentation
|
|
2
|
+
#
|
|
3
|
+
|
|
4
|
+
# You can set these variables from the command line.
|
|
5
|
+
SPHINXOPTS =
|
|
6
|
+
SPHINXBUILD = sphinx-build
|
|
7
|
+
PAPER =
|
|
8
|
+
BUILDDIR = _build
|
|
9
|
+
|
|
10
|
+
# User-friendly check for sphinx-build
|
|
11
|
+
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
|
|
12
|
+
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
|
|
13
|
+
endif
|
|
14
|
+
|
|
15
|
+
# Internal variables.
|
|
16
|
+
PAPEROPT_a4 = -D latex_paper_size=a4
|
|
17
|
+
PAPEROPT_letter = -D latex_paper_size=letter
|
|
18
|
+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
|
19
|
+
# the i18n builder cannot share the environment and doctrees with the others
|
|
20
|
+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
|
21
|
+
|
|
22
|
+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
|
|
23
|
+
|
|
24
|
+
help:
|
|
25
|
+
@echo "Please use \`make <target>' where <target> is one of"
|
|
26
|
+
@echo " html to make standalone HTML files"
|
|
27
|
+
@echo " dirhtml to make HTML files named index.html in directories"
|
|
28
|
+
@echo " singlehtml to make a single large HTML file"
|
|
29
|
+
@echo " pickle to make pickle files"
|
|
30
|
+
@echo " json to make JSON files"
|
|
31
|
+
@echo " htmlhelp to make HTML files and a HTML help project"
|
|
32
|
+
@echo " qthelp to make HTML files and a qthelp project"
|
|
33
|
+
@echo " devhelp to make HTML files and a Devhelp project"
|
|
34
|
+
@echo " epub to make an epub"
|
|
35
|
+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
|
36
|
+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
|
37
|
+
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
|
38
|
+
@echo " text to make text files"
|
|
39
|
+
@echo " man to make manual pages"
|
|
40
|
+
@echo " texinfo to make Texinfo files"
|
|
41
|
+
@echo " info to make Texinfo files and run them through makeinfo"
|
|
42
|
+
@echo " gettext to make PO message catalogs"
|
|
43
|
+
@echo " changes to make an overview of all changed/added/deprecated items"
|
|
44
|
+
@echo " xml to make Docutils-native XML files"
|
|
45
|
+
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
|
46
|
+
@echo " linkcheck to check all external links for integrity"
|
|
47
|
+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
|
48
|
+
|
|
49
|
+
clean:
|
|
50
|
+
rm -rf $(BUILDDIR)/*
|
|
51
|
+
|
|
52
|
+
html:
|
|
53
|
+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
|
54
|
+
@echo
|
|
55
|
+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
|
56
|
+
|
|
57
|
+
dirhtml:
|
|
58
|
+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
|
59
|
+
@echo
|
|
60
|
+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
|
61
|
+
|
|
62
|
+
singlehtml:
|
|
63
|
+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
|
64
|
+
@echo
|
|
65
|
+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
|
66
|
+
|
|
67
|
+
pickle:
|
|
68
|
+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
|
69
|
+
@echo
|
|
70
|
+
@echo "Build finished; now you can process the pickle files."
|
|
71
|
+
|
|
72
|
+
json:
|
|
73
|
+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
|
74
|
+
@echo
|
|
75
|
+
@echo "Build finished; now you can process the JSON files."
|
|
76
|
+
|
|
77
|
+
htmlhelp:
|
|
78
|
+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
|
79
|
+
@echo
|
|
80
|
+
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
|
81
|
+
".hhp project file in $(BUILDDIR)/htmlhelp."
|
|
82
|
+
|
|
83
|
+
qthelp:
|
|
84
|
+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
|
85
|
+
@echo
|
|
86
|
+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
|
87
|
+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
|
88
|
+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/xtb_step.qhcp"
|
|
89
|
+
@echo "To view the help file:"
|
|
90
|
+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/xtb_step.qhc"
|
|
91
|
+
|
|
92
|
+
devhelp:
|
|
93
|
+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
|
94
|
+
@echo
|
|
95
|
+
@echo "Build finished."
|
|
96
|
+
@echo "To view the help file:"
|
|
97
|
+
@echo "# mkdir -p $$HOME/.local/share/devhelp/xtb_step"
|
|
98
|
+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/xtb_step"
|
|
99
|
+
@echo "# devhelp"
|
|
100
|
+
|
|
101
|
+
epub:
|
|
102
|
+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
|
103
|
+
@echo
|
|
104
|
+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
|
105
|
+
|
|
106
|
+
latex:
|
|
107
|
+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
|
108
|
+
@echo
|
|
109
|
+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
|
110
|
+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
|
111
|
+
"(use \`make latexpdf' here to do that automatically)."
|
|
112
|
+
|
|
113
|
+
latexpdf:
|
|
114
|
+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
|
115
|
+
@echo "Running LaTeX files through pdflatex..."
|
|
116
|
+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
|
117
|
+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
|
118
|
+
|
|
119
|
+
latexpdfja:
|
|
120
|
+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
|
121
|
+
@echo "Running LaTeX files through platex and dvipdfmx..."
|
|
122
|
+
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
|
123
|
+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
|
124
|
+
|
|
125
|
+
text:
|
|
126
|
+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
|
127
|
+
@echo
|
|
128
|
+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
|
129
|
+
|
|
130
|
+
man:
|
|
131
|
+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
|
132
|
+
@echo
|
|
133
|
+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
|
134
|
+
|
|
135
|
+
texinfo:
|
|
136
|
+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
|
137
|
+
@echo
|
|
138
|
+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
|
139
|
+
@echo "Run \`make' in that directory to run these through makeinfo" \
|
|
140
|
+
"(use \`make info' here to do that automatically)."
|
|
141
|
+
|
|
142
|
+
info:
|
|
143
|
+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
|
144
|
+
@echo "Running Texinfo files through makeinfo..."
|
|
145
|
+
make -C $(BUILDDIR)/texinfo info
|
|
146
|
+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
|
147
|
+
|
|
148
|
+
gettext:
|
|
149
|
+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
|
150
|
+
@echo
|
|
151
|
+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
|
152
|
+
|
|
153
|
+
changes:
|
|
154
|
+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
|
155
|
+
@echo
|
|
156
|
+
@echo "The overview file is in $(BUILDDIR)/changes."
|
|
157
|
+
|
|
158
|
+
linkcheck:
|
|
159
|
+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
|
160
|
+
@echo
|
|
161
|
+
@echo "Link check complete; look for any errors in the above output " \
|
|
162
|
+
"or in $(BUILDDIR)/linkcheck/output.txt."
|
|
163
|
+
|
|
164
|
+
doctest:
|
|
165
|
+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
|
166
|
+
@echo "Testing of doctests in the sources finished, look at the " \
|
|
167
|
+
"results in $(BUILDDIR)/doctest/output.txt."
|
|
168
|
+
|
|
169
|
+
xml:
|
|
170
|
+
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
|
171
|
+
@echo
|
|
172
|
+
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
|
173
|
+
|
|
174
|
+
pseudoxml:
|
|
175
|
+
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
|
176
|
+
@echo
|
|
177
|
+
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
.. include:: ../AUTHORS.rst
|