openff-toolkit 0.18.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.
- devtools/scripts/build_cookiecutter_json.py +22 -0
- docs/conf.py +296 -0
- docs/conftest.py +23 -0
- examples/conformer_energies/conformer_energies.py +143 -0
- examples/deprecated/SMIRNOFF_comparison/compare_molecule_energies.py +48 -0
- examples/deprecated/SMIRNOFF_comparison/compare_set_energies.py +58 -0
- examples/deprecated/liquid_box/create_mol2_pdb/create_mol2_pdb.py +193 -0
- examples/deprecated/liquid_box/openff_simulation.py +72 -0
- examples/deprecated/mixedFF_structure/generate_mixedFF_complex.py +56 -0
- examples/deprecated/testing/test_impropers/tleap_tools.py +120 -0
- examples/examples_helper.py +61 -0
- openff/toolkit/__init__.py +101 -0
- openff/toolkit/_tests/__init__.py +0 -0
- openff/toolkit/_tests/_stale_tests.py +146 -0
- openff/toolkit/_tests/conftest.py +108 -0
- openff/toolkit/_tests/create_molecules.py +494 -0
- openff/toolkit/_tests/mocking.py +145 -0
- openff/toolkit/_tests/molecule/__init__.py +1 -0
- openff/toolkit/_tests/molecule/test_state_enumeration.py +302 -0
- openff/toolkit/_tests/test_energies.py +136 -0
- openff/toolkit/_tests/test_examples.py +109 -0
- openff/toolkit/_tests/test_forcefield.py +3864 -0
- openff/toolkit/_tests/test_interchange.py +19 -0
- openff/toolkit/_tests/test_io.py +19 -0
- openff/toolkit/_tests/test_links.py +73 -0
- openff/toolkit/_tests/test_mm_molecule.py +404 -0
- openff/toolkit/_tests/test_molecule.py +4246 -0
- openff/toolkit/_tests/test_nagl.py +169 -0
- openff/toolkit/_tests/test_parameter_plugins.py +89 -0
- openff/toolkit/_tests/test_parameters.py +2898 -0
- openff/toolkit/_tests/test_toolkit_io.py +1088 -0
- openff/toolkit/_tests/test_toolkits.py +4418 -0
- openff/toolkit/_tests/test_topology.py +2485 -0
- openff/toolkit/_tests/test_utils.py +101 -0
- openff/toolkit/_tests/test_utils_callback.py +178 -0
- openff/toolkit/_tests/test_utils_collections.py +263 -0
- openff/toolkit/_tests/test_utils_serialization.py +168 -0
- openff/toolkit/_tests/utils.py +1747 -0
- openff/toolkit/data/README.md +8 -0
- openff/toolkit/data/molecules/AlkEthOH_test_filt1_ff.mol2 +2026 -0
- openff/toolkit/data/molecules/AlkEthOH_test_filt1_tripos.mol2 +2026 -0
- openff/toolkit/data/molecules/AlkEthOH_tripos.tar.gz +0 -0
- openff/toolkit/data/molecules/CID20742535_anion.sdf +50 -0
- openff/toolkit/data/molecules/CID20742535_neutral.sdf +51 -0
- openff/toolkit/data/molecules/FreeSolv.tar.gz +0 -0
- openff/toolkit/data/molecules/MiniDrugBank.sdf +33988 -0
- openff/toolkit/data/molecules/MiniDrugBank_tripos.mol2 +35462 -0
- openff/toolkit/data/molecules/PT2385.sdf +90 -0
- openff/toolkit/data/molecules/QL8.sdf +401 -0
- openff/toolkit/data/molecules/README.md +21 -0
- openff/toolkit/data/molecules/benzene.crd +8 -0
- openff/toolkit/data/molecules/benzene.mol2 +34 -0
- openff/toolkit/data/molecules/benzene.top +166 -0
- openff/toolkit/data/molecules/butane_multi.sdf +231 -0
- openff/toolkit/data/molecules/cyclohexane.mol2 +44 -0
- openff/toolkit/data/molecules/ethanol.mol2 +25 -0
- openff/toolkit/data/molecules/ethanol.sdf +23 -0
- openff/toolkit/data/molecules/ethanol_partial_charges.sdf +26 -0
- openff/toolkit/data/molecules/ethanol_reordered.mol2 +25 -0
- openff/toolkit/data/molecules/ethanol_reordered.sdf +23 -0
- openff/toolkit/data/molecules/ethene_rdkit.sdf +17 -0
- openff/toolkit/data/molecules/laromustine_ff.mol2 +71 -0
- openff/toolkit/data/molecules/laromustine_tripos.mol2 +71 -0
- openff/toolkit/data/molecules/methane_multiconformer.sdf +32 -0
- openff/toolkit/data/molecules/methane_multiconformer_properties.sdf +45 -0
- openff/toolkit/data/molecules/nh4.pdb +7 -0
- openff/toolkit/data/molecules/po4_phenylphosphate.pdb +46 -0
- openff/toolkit/data/molecules/ruxolitinib_conformers.sdf +910 -0
- openff/toolkit/data/molecules/toluene.mol2 +38 -0
- openff/toolkit/data/molecules/toluene.mol2.gz +0 -0
- openff/toolkit/data/molecules/toluene.pdb +30 -0
- openff/toolkit/data/molecules/toluene.sdf +36 -0
- openff/toolkit/data/molecules/toluene_charged.mol2 +38 -0
- openff/toolkit/data/molecules/z_3_hydroxy_propenal.sdf +23 -0
- openff/toolkit/data/proteins/5tbm_complex_solv.pdb +1928 -0
- openff/toolkit/data/proteins/5tbm_complex_solv_box.pdb +19563 -0
- openff/toolkit/data/proteins/CTerminal_ALA.pdb +20 -0
- openff/toolkit/data/proteins/CTerminal_ALA.sdf +43 -0
- openff/toolkit/data/proteins/CTerminal_ALA_ALA.pdb +30 -0
- openff/toolkit/data/proteins/CTerminal_ALA_ALA_misnamedH.pdb +30 -0
- openff/toolkit/data/proteins/CTerminal_ARG.pdb +34 -0
- openff/toolkit/data/proteins/CTerminal_TRP.pdb +34 -0
- openff/toolkit/data/proteins/MainChain_ALA.pdb +25 -0
- openff/toolkit/data/proteins/MainChain_ALA.sdf +52 -0
- openff/toolkit/data/proteins/MainChain_ALA_ALA.pdb +35 -0
- openff/toolkit/data/proteins/MainChain_ALA_ALA.sdf +69 -0
- openff/toolkit/data/proteins/MainChain_ALA_ALA_icodes.pdb +35 -0
- openff/toolkit/data/proteins/MainChain_ALA_ALA_no_hydrogens.pdb +17 -0
- openff/toolkit/data/proteins/MainChain_ARG.pdb +39 -0
- openff/toolkit/data/proteins/MainChain_ARG.sdf +81 -0
- openff/toolkit/data/proteins/MainChain_CYM.pdb +25 -0
- openff/toolkit/data/proteins/MainChain_CYS.pdb +26 -0
- openff/toolkit/data/proteins/MainChain_CYX.pdb +48 -0
- openff/toolkit/data/proteins/MainChain_CYX.sdf +96 -0
- openff/toolkit/data/proteins/MainChain_GLH.sdf +64 -0
- openff/toolkit/data/proteins/MainChain_GLU.sdf +63 -0
- openff/toolkit/data/proteins/MainChain_HID.pdb +32 -0
- openff/toolkit/data/proteins/MainChain_HIE.pdb +32 -0
- openff/toolkit/data/proteins/MainChain_HIE.sdf +67 -0
- openff/toolkit/data/proteins/MainChain_HIP.pdb +33 -0
- openff/toolkit/data/proteins/MainChain_HIP.sdf +70 -0
- openff/toolkit/data/proteins/MainChain_PRO.pdb +29 -0
- openff/toolkit/data/proteins/MainChain_TRP.pdb +39 -0
- openff/toolkit/data/proteins/NTerminal_ALA.pdb +21 -0
- openff/toolkit/data/proteins/NTerminal_ALA.sdf +45 -0
- openff/toolkit/data/proteins/NTerminal_ALA_ALA.pdb +31 -0
- openff/toolkit/data/proteins/NTerminal_ARG.pdb +35 -0
- openff/toolkit/data/proteins/NTerminal_TRP.pdb +35 -0
- openff/toolkit/data/proteins/T4-protein-unprocessed-4w51.pdb +1892 -0
- openff/toolkit/data/proteins/T4-protein.mol2 +5461 -0
- openff/toolkit/data/proteins/T4-protein.pdb +2637 -0
- openff/toolkit/data/proteins/T4-protein.sdf +5318 -0
- openff/toolkit/data/proteins/T4_protein_waters.pdb +2965 -0
- openff/toolkit/data/proteins/TwoMol_SER_CYS.pdb +50 -0
- openff/toolkit/data/proteins/aa_residues_substructures_explicit_bond_orders_with_caps.json +6435 -0
- openff/toolkit/data/proteins/aa_residues_substructures_explicit_bond_orders_with_caps_explicit_connectivity.json +6675 -0
- openff/toolkit/data/proteins/aa_residues_substructures_with_caps.json +6297 -0
- openff/toolkit/data/proteins/ace-ZZZ-gly-nme.pdb +78 -0
- openff/toolkit/data/proteins/ace-ZZZ-gly-nme.sdf +98 -0
- openff/toolkit/data/proteins/ace-a10-nme.sdf +229 -0
- openff/toolkit/data/proteins/ace-ala-nh2.pdb +21 -0
- openff/toolkit/data/proteins/fluoresceine_dyed_helix_capped.pdb +338 -0
- openff/toolkit/data/proteins/neutral_arginine.pdb +31 -0
- openff/toolkit/data/proteins/split_chain.pdb +74 -0
- openff/toolkit/data/proteins/split_chain_reordered.pdb +74 -0
- openff/toolkit/data/reference_energies/README.md +6 -0
- openff/toolkit/data/reference_energies/reference_0.8.0.json +1 -0
- openff/toolkit/data/reference_energies/reference_0.8.0.json.txt +180 -0
- openff/toolkit/data/reference_energies/reference_after_1007.json +1 -0
- openff/toolkit/data/reference_energies/reference_after_1007.json.txt +350 -0
- openff/toolkit/data/reference_energies/reference_after_802.json +1 -0
- openff/toolkit/data/reference_energies/reference_after_802.json.txt +291 -0
- openff/toolkit/data/systems/README.md +3 -0
- openff/toolkit/data/systems/amber/cyclohexane_ethanol_0.4_0.6.inpcrd +1511 -0
- openff/toolkit/data/systems/amber/cyclohexane_ethanol_0.4_0.6.prmtop +13367 -0
- openff/toolkit/data/systems/monomers/butanol.mol2 +38 -0
- openff/toolkit/data/systems/monomers/butanol.sdf +88 -0
- openff/toolkit/data/systems/monomers/cyclohexane.mol2 +45 -0
- openff/toolkit/data/systems/monomers/cyclohexane.sdf +105 -0
- openff/toolkit/data/systems/monomers/ethanol.mol2 +26 -0
- openff/toolkit/data/systems/monomers/ethanol.sdf +58 -0
- openff/toolkit/data/systems/monomers/methane.mol2 +18 -0
- openff/toolkit/data/systems/monomers/methane.sdf +38 -0
- openff/toolkit/data/systems/monomers/propane.mol2 +30 -0
- openff/toolkit/data/systems/monomers/propane.sdf +68 -0
- openff/toolkit/data/systems/monomers/tip3p_water.mol2 +14 -0
- openff/toolkit/data/systems/monomers/water.mol2 +14 -0
- openff/toolkit/data/systems/monomers/water.sdf +28 -0
- openff/toolkit/data/systems/packmol_boxes/cyclohexane_ethanol_0.4_0.6.pdb +6272 -0
- openff/toolkit/data/systems/packmol_boxes/cyclohexane_water.pdb +5524 -0
- openff/toolkit/data/systems/packmol_boxes/ethanol_water.pdb +5174 -0
- openff/toolkit/data/systems/packmol_boxes/propane_methane_butanol_0.2_0.3_0.5.pdb +7959 -0
- openff/toolkit/data/systems/test_systems/1_cyclohexane_1_ethanol.pdb +61 -0
- openff/toolkit/data/systems/test_systems/1_ethanol.pdb +24 -0
- openff/toolkit/data/systems/test_systems/1_ethanol_no_conect.pdb +15 -0
- openff/toolkit/data/systems/test_systems/1_ethanol_reordered.pdb +24 -0
- openff/toolkit/data/systems/test_systems/PE.pdb +67 -0
- openff/toolkit/data/systems/test_systems/README.md +3 -0
- openff/toolkit/data/systems/test_systems/T4_lysozyme_water_ions.pdb +29240 -0
- openff/toolkit/data/test_forcefields/Frosst_AlkEthOH.offxml +61 -0
- openff/toolkit/data/test_forcefields/Frosst_AlkEthOH_GBSA.offxml +78 -0
- openff/toolkit/data/test_forcefields/Frosst_AlkEthOH_MDL.offxml +62 -0
- openff/toolkit/data/test_forcefields/Frosst_AlkEthOH_parmAtFrosst.offxml +64 -0
- openff/toolkit/data/test_forcefields/GBSA_HCT-1.0.offxml +21 -0
- openff/toolkit/data/test_forcefields/GBSA_OBC1-1.0.offxml +18 -0
- openff/toolkit/data/test_forcefields/GBSA_OBC2-1.0.offxml +18 -0
- openff/toolkit/data/test_forcefields/README.md +23 -0
- openff/toolkit/data/test_forcefields/ammonia_minimal.offxml +27 -0
- openff/toolkit/data/test_forcefields/benzene_minimal.offxml +29 -0
- openff/toolkit/data/test_forcefields/chargeincrement-test.offxml +16 -0
- openff/toolkit/data/test_forcefields/frcmod.Frosst_AlkEthOH_withIDs +85 -0
- openff/toolkit/data/test_forcefields/ion_charges.offxml +18 -0
- openff/toolkit/data/test_forcefields/mangled.offxml +9 -0
- openff/toolkit/data/test_forcefields/old/README.md +9 -0
- openff/toolkit/data/test_forcefields/old/hbonds.offxml +11 -0
- openff/toolkit/data/test_forcefields/old/test_ff_0_0_2_spec_0_1.offxml +332 -0
- openff/toolkit/data/test_forcefields/old/test_ff_0_0_2_spec_0_2.offxml +338 -0
- openff/toolkit/data/test_forcefields/old/test_ff_0_0_2_spec_0_3.offxml +329 -0
- openff/toolkit/data/test_forcefields/old/test_ff_0_0_4_fixed_spec_0_1.offxml +342 -0
- openff/toolkit/data/test_forcefields/old/test_ff_0_0_4_fixed_spec_0_2.offxml +348 -0
- openff/toolkit/data/test_forcefields/old/test_ff_0_0_4_fixed_spec_0_3.offxml +337 -0
- openff/toolkit/data/test_forcefields/old/test_ff_0_0_4_spec_0_1.offxml +340 -0
- openff/toolkit/data/test_forcefields/old/test_ff_0_0_4_spec_0_2.offxml +346 -0
- openff/toolkit/data/test_forcefields/old/test_ff_0_0_4_spec_0_3.offxml +337 -0
- openff/toolkit/data/test_forcefields/smirff99Frosst_reference_0_1_spec.offxml +349 -0
- openff/toolkit/data/test_forcefields/smirnoff99Frosst_experimental.offxml +343 -0
- openff/toolkit/data/test_forcefields/smirnoff99Frosst_reference_0_1_spec.offxml +349 -0
- openff/toolkit/data/test_forcefields/smirnoff99Frosst_reference_0_2_spec.offxml +356 -0
- openff/toolkit/data/test_forcefields/test_forcefield.offxml +346 -0
- openff/toolkit/data/test_forcefields/tip3p.offxml +22 -0
- openff/toolkit/data/test_forcefields/unsupported_smirnoff_version.offxml +9 -0
- openff/toolkit/topology/__init__.py +43 -0
- openff/toolkit/topology/_mm_molecule.py +663 -0
- openff/toolkit/topology/molecule.py +6102 -0
- openff/toolkit/topology/topology.py +2555 -0
- openff/toolkit/typing/__init__.py +1 -0
- openff/toolkit/typing/engines/__init__.py +1 -0
- openff/toolkit/typing/engines/smirnoff/__init__.py +31 -0
- openff/toolkit/typing/engines/smirnoff/forcefield.py +1440 -0
- openff/toolkit/typing/engines/smirnoff/io.py +234 -0
- openff/toolkit/typing/engines/smirnoff/parameters.py +3839 -0
- openff/toolkit/typing/engines/smirnoff/plugins.py +91 -0
- openff/toolkit/utils/__init__.py +57 -0
- openff/toolkit/utils/_viz.py +104 -0
- openff/toolkit/utils/ambertools_wrapper.py +507 -0
- openff/toolkit/utils/base_wrapper.py +268 -0
- openff/toolkit/utils/builtin_wrapper.py +136 -0
- openff/toolkit/utils/callback.py +187 -0
- openff/toolkit/utils/collections.py +247 -0
- openff/toolkit/utils/constants.py +18 -0
- openff/toolkit/utils/exceptions.py +766 -0
- openff/toolkit/utils/nagl_wrapper.py +164 -0
- openff/toolkit/utils/openeye_wrapper.py +2750 -0
- openff/toolkit/utils/rdkit_wrapper.py +3302 -0
- openff/toolkit/utils/serialization.py +466 -0
- openff/toolkit/utils/toolkit_registry.py +509 -0
- openff/toolkit/utils/toolkits.py +217 -0
- openff/toolkit/utils/utils.py +805 -0
- openff_toolkit-0.18.0.dist-info/METADATA +109 -0
- openff_toolkit-0.18.0.dist-info/RECORD +231 -0
- openff_toolkit-0.18.0.dist-info/WHEEL +5 -0
- openff_toolkit-0.18.0.dist-info/licenses/LICENSE +21 -0
- openff_toolkit-0.18.0.dist-info/top_level.txt +5 -0
- utilities/deprecated/convert_frosst/convert_frcmod_0.1.py +251 -0
- utilities/deprecated/convert_frosst/convert_frcmod_0.2.py +249 -0
- utilities/deprecated/convert_frosst/convert_frcmod_0.3.py +249 -0
- utilities/make_substructure_dict/_cif_to_substructure_dict.py +955 -0
- utilities/make_substructure_dict/_make_chemical_substructures.py +46 -0
- utilities/make_substructure_dict/_make_metadata_assignment_substructures.py +35 -0
- utilities/test_plugins/custom_plugins/handler_plugins.py +48 -0
- utilities/test_plugins/setup.py +19 -0
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Wrapper classes for providing a minimal consistent interface to cheminformatics toolkits
|
|
3
|
+
|
|
4
|
+
Currently supported toolkits:
|
|
5
|
+
|
|
6
|
+
* The `OpenEye Toolkit <https://docs.eyesopen.com/toolkits/python/quickstart-python/index.html>`_
|
|
7
|
+
* The `RDKit <http://www.rdkit.org/>`_
|
|
8
|
+
* `AmberTools <http://ambermd.org/AmberTools.php>`_
|
|
9
|
+
|
|
10
|
+
.. todo::
|
|
11
|
+
|
|
12
|
+
* Add checks at the beginning of each toolkit method call to make sure toolkit is licened
|
|
13
|
+
* Switch toolkit methods to object methods instead of static methods
|
|
14
|
+
* Should this be under ``openff.toolkit.utils.toolkits`` or ``openff.toolkit.toolkits``?
|
|
15
|
+
* Add singleton global toolkit registry that registers all available toolkits by default
|
|
16
|
+
when this file is imported
|
|
17
|
+
* Add description fields for each toolkit wrapper
|
|
18
|
+
* Eliminate global variables in favor of a singleton pattern
|
|
19
|
+
* Change global variables from _INSTALLED to _AVAILABLE
|
|
20
|
+
|
|
21
|
+
"""
|
|
22
|
+
|
|
23
|
+
__all__ = (
|
|
24
|
+
"ALLOWED_AROMATICITY_MODELS",
|
|
25
|
+
"ALLOWED_CHARGE_MODELS",
|
|
26
|
+
"ALLOWED_FRACTIONAL_BOND_ORDER_MODELS",
|
|
27
|
+
"AMBERTOOLS_AVAILABLE",
|
|
28
|
+
"BASIC_CHEMINFORMATICS_TOOLKITS",
|
|
29
|
+
"DEFAULT_AROMATICITY_MODEL",
|
|
30
|
+
"DEFAULT_CHARGE_MODEL",
|
|
31
|
+
"DEFAULT_FRACTIONAL_BOND_ORDER_MODEL",
|
|
32
|
+
"GLOBAL_TOOLKIT_REGISTRY",
|
|
33
|
+
"OPENEYE_AVAILABLE",
|
|
34
|
+
"RDKIT_AVAILABLE",
|
|
35
|
+
"AmberToolsToolkitWrapper",
|
|
36
|
+
"AntechamberNotFoundError",
|
|
37
|
+
"BadMoleculeAssumptionError",
|
|
38
|
+
"BuiltInToolkitWrapper",
|
|
39
|
+
"ChargeCalculationError",
|
|
40
|
+
"ChargeMethodUnavailableError",
|
|
41
|
+
"GAFFAtomTypeWarning",
|
|
42
|
+
"IncompatibleUnitError",
|
|
43
|
+
"IncorrectNumConformersError",
|
|
44
|
+
"IncorrectNumConformersWarning",
|
|
45
|
+
"InvalidIUPACNameError",
|
|
46
|
+
"InvalidToolkitError",
|
|
47
|
+
"InvalidToolkitRegistryError",
|
|
48
|
+
"LicenseError",
|
|
49
|
+
"MissingPackageError",
|
|
50
|
+
"NAGLToolkitWrapper",
|
|
51
|
+
"OpenEyeToolkitWrapper",
|
|
52
|
+
"RDKitToolkitWrapper",
|
|
53
|
+
"SMILESParseError",
|
|
54
|
+
"ToolkitRegistry",
|
|
55
|
+
"ToolkitUnavailableException",
|
|
56
|
+
"ToolkitWrapper",
|
|
57
|
+
"UndefinedStereochemistryError",
|
|
58
|
+
)
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
import logging
|
|
62
|
+
|
|
63
|
+
from openff.toolkit.utils.ambertools_wrapper import AmberToolsToolkitWrapper
|
|
64
|
+
from openff.toolkit.utils.base_wrapper import ToolkitWrapper
|
|
65
|
+
from openff.toolkit.utils.builtin_wrapper import BuiltInToolkitWrapper
|
|
66
|
+
from openff.toolkit.utils.constants import (
|
|
67
|
+
ALLOWED_AROMATICITY_MODELS,
|
|
68
|
+
ALLOWED_CHARGE_MODELS,
|
|
69
|
+
ALLOWED_FRACTIONAL_BOND_ORDER_MODELS,
|
|
70
|
+
DEFAULT_AROMATICITY_MODEL,
|
|
71
|
+
DEFAULT_CHARGE_MODEL,
|
|
72
|
+
DEFAULT_FRACTIONAL_BOND_ORDER_MODEL,
|
|
73
|
+
)
|
|
74
|
+
from openff.toolkit.utils.exceptions import (
|
|
75
|
+
AntechamberNotFoundError,
|
|
76
|
+
BadMoleculeAssumptionError,
|
|
77
|
+
ChargeCalculationError,
|
|
78
|
+
ChargeMethodUnavailableError,
|
|
79
|
+
GAFFAtomTypeWarning,
|
|
80
|
+
IncompatibleUnitError,
|
|
81
|
+
IncorrectNumConformersError,
|
|
82
|
+
IncorrectNumConformersWarning,
|
|
83
|
+
InvalidIUPACNameError,
|
|
84
|
+
InvalidToolkitError,
|
|
85
|
+
InvalidToolkitRegistryError,
|
|
86
|
+
LicenseError,
|
|
87
|
+
MissingPackageError,
|
|
88
|
+
SMILESParseError,
|
|
89
|
+
ToolkitUnavailableException,
|
|
90
|
+
UndefinedStereochemistryError,
|
|
91
|
+
)
|
|
92
|
+
from openff.toolkit.utils.nagl_wrapper import NAGLToolkitWrapper
|
|
93
|
+
from openff.toolkit.utils.openeye_wrapper import OpenEyeToolkitWrapper
|
|
94
|
+
from openff.toolkit.utils.rdkit_wrapper import RDKitToolkitWrapper
|
|
95
|
+
from openff.toolkit.utils.toolkit_registry import (
|
|
96
|
+
ToolkitRegistry,
|
|
97
|
+
toolkit_registry_manager,
|
|
98
|
+
)
|
|
99
|
+
|
|
100
|
+
logger = logging.getLogger(__name__)
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
# Create global toolkit registry, where all available toolkits are registered
|
|
104
|
+
GLOBAL_TOOLKIT_REGISTRY = ToolkitRegistry(
|
|
105
|
+
toolkit_precedence=[
|
|
106
|
+
NAGLToolkitWrapper,
|
|
107
|
+
OpenEyeToolkitWrapper,
|
|
108
|
+
RDKitToolkitWrapper,
|
|
109
|
+
AmberToolsToolkitWrapper,
|
|
110
|
+
BuiltInToolkitWrapper,
|
|
111
|
+
],
|
|
112
|
+
exception_if_unavailable=False,
|
|
113
|
+
)
|
|
114
|
+
"""
|
|
115
|
+
The toolkit registry used by default when no registry or wrapper is specified.
|
|
116
|
+
|
|
117
|
+
A toolkit registry is a list of toolkit wrappers used to provide functionality
|
|
118
|
+
not implemented by the OpenFF Toolkit itself. Any given functionality is
|
|
119
|
+
requested from each toolkit in order until one is found that provides it. For
|
|
120
|
+
more information, see :py:class:`ToolkitRegistry`.
|
|
121
|
+
|
|
122
|
+
To temporarily modify the ``GLOBAL_TOOLKIT_REGISTRY``,
|
|
123
|
+
see :py:func:`toolkit_registry_manager`.
|
|
124
|
+
|
|
125
|
+
Examples
|
|
126
|
+
========
|
|
127
|
+
|
|
128
|
+
Check the default toolkit precedence order:
|
|
129
|
+
|
|
130
|
+
>>> from openff.toolkit import GLOBAL_TOOLKIT_REGISTRY
|
|
131
|
+
>>> GLOBAL_TOOLKIT_REGISTRY.registered_toolkits() # doctest: +ELLIPSIS
|
|
132
|
+
[...]
|
|
133
|
+
|
|
134
|
+
Temporarily change the global toolkit registry:
|
|
135
|
+
|
|
136
|
+
>>> from openff.toolkit import ToolkitRegistry, RDKitToolkitWrapper
|
|
137
|
+
>>> from openff.toolkit.utils import toolkit_registry_manager
|
|
138
|
+
>>> with toolkit_registry_manager(ToolkitRegistry([RDKitToolkitWrapper]))):
|
|
139
|
+
>>> GLOBAL_TOOLKIT_REGISTRY
|
|
140
|
+
<ToolkitRegistry containing The RDKit>
|
|
141
|
+
>>> mol = Molecule.from_smiles("CCO")
|
|
142
|
+
>>> # when the context manager ends, the default registry is back to normal
|
|
143
|
+
>>> GLOBAL_TOOLKIT_REGISTRY
|
|
144
|
+
<ToolkitRegistry containing The RDKit, AmberTools, Built-in Toolkit>
|
|
145
|
+
|
|
146
|
+
To change the value of ``GLOBAL_TOOLKIT_REGISTRY`` for the remainder of the
|
|
147
|
+
Python process, individual toolkits can be added or removed with
|
|
148
|
+
the :py:meth:`ToolkitRegistry.deregister_toolkit`
|
|
149
|
+
and :py:meth:`ToolkitRegistry.register_toolkit` methods. This can be useful for
|
|
150
|
+
debugging and exploring subtly different behavior between toolkit wrappers:
|
|
151
|
+
|
|
152
|
+
>>> print(len(GLOBAL_TOOLKIT_REGISTRY.registered_toolkits))
|
|
153
|
+
4
|
|
154
|
+
>>> GLOBAL_TOOLKIT_REGISTRY.deregister_toolkit(RDKitToolkitWrapper)
|
|
155
|
+
>>> print(len(GLOBAL_TOOLKIT_REGISTRY.registered_toolkits))
|
|
156
|
+
3
|
|
157
|
+
>>> GLOBAL_TOOLKIT_REGISTRY.register_toolkit(RDKitToolkitWrapper)
|
|
158
|
+
>>> print(len(GLOBAL_TOOLKIT_REGISTRY.registered_toolkits))
|
|
159
|
+
4
|
|
160
|
+
|
|
161
|
+
Note that as with other global attributes in Python, assigning a new toolkit
|
|
162
|
+
registry to ``GLOBAL_TOOLKIT_REGISTRY`` is quite difficult to get right and very
|
|
163
|
+
likely to fail silently - we recommend modifying the existing value instead in
|
|
164
|
+
most cases.
|
|
165
|
+
|
|
166
|
+
See Also
|
|
167
|
+
========
|
|
168
|
+
toolkit_registry_manager, ToolkitRegistry, ToolkitWrapper
|
|
169
|
+
"""
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
OPENEYE_AVAILABLE = False
|
|
173
|
+
RDKIT_AVAILABLE = False
|
|
174
|
+
AMBERTOOLS_AVAILABLE = False
|
|
175
|
+
|
|
176
|
+
with toolkit_registry_manager(
|
|
177
|
+
ToolkitRegistry(
|
|
178
|
+
toolkit_precedence=[
|
|
179
|
+
OpenEyeToolkitWrapper,
|
|
180
|
+
RDKitToolkitWrapper,
|
|
181
|
+
AmberToolsToolkitWrapper,
|
|
182
|
+
],
|
|
183
|
+
exception_if_unavailable=False,
|
|
184
|
+
)
|
|
185
|
+
):
|
|
186
|
+
for toolkit in GLOBAL_TOOLKIT_REGISTRY.registered_toolkits:
|
|
187
|
+
if type(toolkit) is OpenEyeToolkitWrapper:
|
|
188
|
+
OPENEYE_AVAILABLE = True
|
|
189
|
+
elif type(toolkit) is RDKitToolkitWrapper:
|
|
190
|
+
RDKIT_AVAILABLE = True
|
|
191
|
+
elif type(toolkit) is AmberToolsToolkitWrapper:
|
|
192
|
+
AMBERTOOLS_AVAILABLE = True
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
# Define basic toolkits that handle essential file I/O
|
|
196
|
+
|
|
197
|
+
BASIC_CHEMINFORMATICS_TOOLKITS = [RDKitToolkitWrapper, OpenEyeToolkitWrapper]
|
|
198
|
+
|
|
199
|
+
# Ensure we have at least one basic toolkit
|
|
200
|
+
any_toolkits = False
|
|
201
|
+
for tk in GLOBAL_TOOLKIT_REGISTRY.registered_toolkits:
|
|
202
|
+
if type(tk) in BASIC_CHEMINFORMATICS_TOOLKITS:
|
|
203
|
+
if tk.is_available():
|
|
204
|
+
any_toolkits = True
|
|
205
|
+
break
|
|
206
|
+
|
|
207
|
+
if not any_toolkits: # pragma: no cover
|
|
208
|
+
from openff.toolkit.utils.utils import all_subclasses
|
|
209
|
+
|
|
210
|
+
msg = "WARNING: No basic cheminformatics toolkits are available.\n"
|
|
211
|
+
msg += "At least one basic toolkit is required to handle SMARTS matching and file I/O. \n"
|
|
212
|
+
msg += "Please install at least one of the following basic toolkits:\n"
|
|
213
|
+
for wrapper in all_subclasses(ToolkitWrapper):
|
|
214
|
+
if wrapper.toolkit_name is not None:
|
|
215
|
+
msg += f"{wrapper._toolkit_name} : {wrapper._toolkit_installation_instructions}\n"
|
|
216
|
+
# TODO: Make this a warning!?
|
|
217
|
+
print(msg)
|