Auto3D 2.3.1__tar.gz → 3.0.0__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.
- auto3d-3.0.0/MANIFEST.in +11 -0
- auto3d-3.0.0/PKG-INFO +240 -0
- auto3d-3.0.0/README.md +181 -0
- auto3d-3.0.0/pyproject.toml +227 -0
- auto3d-3.0.0/setup.cfg +4 -0
- auto3d-3.0.0/src/Auto3D/ASE/geometry.py +232 -0
- auto3d-3.0.0/src/Auto3D/ASE/thermo.py +1767 -0
- auto3d-3.0.0/src/Auto3D/SPE.py +170 -0
- auto3d-3.0.0/src/Auto3D/__init__.py +123 -0
- auto3d-3.0.0/src/Auto3D/auto3D.py +262 -0
- auto3d-3.0.0/src/Auto3D/auto3Dcli.py +211 -0
- auto3d-3.0.0/src/Auto3D/batch_opt/ANI2xt_no_rep.py +347 -0
- auto3d-3.0.0/src/Auto3D/batch_opt/batchopt.py +410 -0
- auto3d-3.0.0/src/Auto3D/batch_opt/fire_optimizer.py +202 -0
- auto3d-3.0.0/src/Auto3D/batch_opt/model_wrapper.py +231 -0
- auto3d-3.0.0/src/Auto3D/batch_opt/optimization_engine.py +489 -0
- auto3d-3.0.0/src/Auto3D/batch_opt/padding.py +105 -0
- auto3d-3.0.0/src/Auto3D/chunk_manager.py +307 -0
- auto3d-3.0.0/src/Auto3D/clash_relief.py +105 -0
- auto3d-3.0.0/src/Auto3D/cli/__init__.py +14 -0
- auto3d-3.0.0/src/Auto3D/cli/app.py +544 -0
- auto3d-3.0.0/src/Auto3D/cli/commands/__init__.py +1 -0
- auto3d-3.0.0/src/Auto3D/cli/commands/config.py +247 -0
- auto3d-3.0.0/src/Auto3D/cli/commands/models.py +285 -0
- auto3d-3.0.0/src/Auto3D/cli/commands/properties.py +219 -0
- auto3d-3.0.0/src/Auto3D/cli/commands/run.py +332 -0
- auto3d-3.0.0/src/Auto3D/cli/commands/validate.py +244 -0
- auto3d-3.0.0/src/Auto3D/cli/config_schema.py +435 -0
- auto3d-3.0.0/src/Auto3D/cli/console.py +266 -0
- auto3d-3.0.0/src/Auto3D/cli/errors.py +244 -0
- auto3d-3.0.0/src/Auto3D/cli/progress.py +114 -0
- auto3d-3.0.0/src/Auto3D/cli/results.py +122 -0
- auto3d-3.0.0/src/Auto3D/config.py +543 -0
- auto3d-3.0.0/src/Auto3D/constants.py +167 -0
- auto3d-3.0.0/src/Auto3D/embedding.py +171 -0
- auto3d-3.0.0/src/Auto3D/exceptions.py +136 -0
- auto3d-3.0.0/src/Auto3D/filtering.py +384 -0
- auto3d-3.0.0/src/Auto3D/id_mapping.py +201 -0
- auto3d-3.0.0/src/Auto3D/isomer_engine.py +763 -0
- auto3d-3.0.0/src/Auto3D/isomers/__init__.py +26 -0
- auto3d-3.0.0/src/Auto3D/isomers/base.py +46 -0
- auto3d-3.0.0/src/Auto3D/isomers/factory.py +249 -0
- auto3d-3.0.0/src/Auto3D/job_layout.py +126 -0
- auto3d-3.0.0/src/Auto3D/model_factory.py +274 -0
- auto3d-3.0.0/src/Auto3D/models/__init__.py +24 -0
- auto3d-3.0.0/src/Auto3D/models/adapter.py +710 -0
- auto3d-3.0.0/src/Auto3D/models/contract.py +439 -0
- auto3d-3.0.0/src/Auto3D/models/loading.py +72 -0
- auto3d-3.0.0/src/Auto3D/models/preflight.py +213 -0
- auto3d-3.0.0/src/Auto3D/models/species.py +103 -0
- auto3d-3.0.0/src/Auto3D/processors.py +55 -0
- auto3d-3.0.0/src/Auto3D/ranking.py +521 -0
- auto3d-3.0.0/src/Auto3D/results.py +81 -0
- auto3d-3.0.0/src/Auto3D/tautomer.py +164 -0
- auto3d-3.0.0/src/Auto3D/torch_config.py +159 -0
- auto3d-3.0.0/src/Auto3D/utils/__init__.py +60 -0
- auto3d-3.0.0/src/Auto3D/utils/atomic_io.py +101 -0
- auto3d-3.0.0/src/Auto3D/utils/connectivity.py +207 -0
- auto3d-3.0.0/src/Auto3D/utils/convergence.py +71 -0
- auto3d-3.0.0/src/Auto3D/utils/energy.py +113 -0
- auto3d-3.0.0/src/Auto3D/utils/geometry.py +111 -0
- auto3d-3.0.0/src/Auto3D/utils/logging_config.py +66 -0
- auto3d-3.0.0/src/Auto3D/utils/molprops.py +75 -0
- auto3d-3.0.0/src/Auto3D/utils/output_guard.py +156 -0
- auto3d-3.0.0/src/Auto3D/utils/reconciliation.py +170 -0
- auto3d-3.0.0/src/Auto3D/utils/sdf_io.py +206 -0
- auto3d-3.0.0/src/Auto3D/utils/smi_io.py +256 -0
- auto3d-3.0.0/src/Auto3D/utils/stereo_check.py +165 -0
- auto3d-3.0.0/src/Auto3D/utils/stereochemistry.py +573 -0
- auto3d-3.0.0/src/Auto3D/utils/validation.py +502 -0
- auto3d-3.0.0/src/Auto3D/workflow.py +664 -0
- auto3d-3.0.0/src/Auto3D/workflow_workers.py +353 -0
- auto3d-3.0.0/src/Auto3D.egg-info/PKG-INFO +240 -0
- auto3d-3.0.0/src/Auto3D.egg-info/SOURCES.txt +172 -0
- auto3d-3.0.0/src/Auto3D.egg-info/requires.txt +35 -0
- auto3d-3.0.0/tests/test_SPE.py +337 -0
- auto3d-3.0.0/tests/test_adapter_atom_mask.py +204 -0
- auto3d-3.0.0/tests/test_ani2xt_atom_energies.py +376 -0
- auto3d-3.0.0/tests/test_ase_geometry.py +72 -0
- auto3d-3.0.0/tests/test_ase_torch_config.py +34 -0
- auto3d-3.0.0/tests/test_atomic_io.py +261 -0
- auto3d-3.0.0/tests/test_auto3D.py +504 -0
- auto3d-3.0.0/tests/test_auto3Dcli.py +98 -0
- auto3d-3.0.0/tests/test_batchopt.py +321 -0
- auto3d-3.0.0/tests/test_chunk_manager.py +832 -0
- auto3d-3.0.0/tests/test_cli.py +412 -0
- auto3d-3.0.0/tests/test_cli_app.py +1060 -0
- auto3d-3.0.0/tests/test_cli_commands_config.py +27 -0
- auto3d-3.0.0/tests/test_cli_config_schema.py +714 -0
- auto3d-3.0.0/tests/test_cli_console.py +47 -0
- auto3d-3.0.0/tests/test_cli_errors.py +353 -0
- auto3d-3.0.0/tests/test_cli_exit_codes.py +680 -0
- auto3d-3.0.0/tests/test_cli_property_commands.py +594 -0
- auto3d-3.0.0/tests/test_cli_results.py +98 -0
- auto3d-3.0.0/tests/test_cli_security.py +164 -0
- auto3d-3.0.0/tests/test_config.py +481 -0
- auto3d-3.0.0/tests/test_config_parity.py +725 -0
- auto3d-3.0.0/tests/test_conftest_isolation_guards.py +124 -0
- auto3d-3.0.0/tests/test_custom_nnp_contract.py +761 -0
- auto3d-3.0.0/tests/test_custom_nnp_eager.py +108 -0
- auto3d-3.0.0/tests/test_durability.py +1251 -0
- auto3d-3.0.0/tests/test_e_tot_units.py +205 -0
- auto3d-3.0.0/tests/test_filtering.py +797 -0
- auto3d-3.0.0/tests/test_fire_optimizer.py +460 -0
- auto3d-3.0.0/tests/test_helpers_pipeline_output.py +781 -0
- auto3d-3.0.0/tests/test_id_mapping.py +205 -0
- auto3d-3.0.0/tests/test_import_boundaries.py +936 -0
- auto3d-3.0.0/tests/test_isomer_engine.py +214 -0
- auto3d-3.0.0/tests/test_isomer_engine_hardening.py +470 -0
- auto3d-3.0.0/tests/test_isomers.py +478 -0
- auto3d-3.0.0/tests/test_job_layout.py +150 -0
- auto3d-3.0.0/tests/test_lazy_torchani_import.py +62 -0
- auto3d-3.0.0/tests/test_legacy_yaml_parity.py +144 -0
- auto3d-3.0.0/tests/test_logging_config.py +174 -0
- auto3d-3.0.0/tests/test_model_adapter.py +726 -0
- auto3d-3.0.0/tests/test_model_caching.py +107 -0
- auto3d-3.0.0/tests/test_model_factory.py +407 -0
- auto3d-3.0.0/tests/test_model_preflight.py +486 -0
- auto3d-3.0.0/tests/test_model_wrapper.py +406 -0
- auto3d-3.0.0/tests/test_mp_start_method.py +53 -0
- auto3d-3.0.0/tests/test_optimization_engine.py +648 -0
- auto3d-3.0.0/tests/test_optimization_engine_indexing.py +834 -0
- auto3d-3.0.0/tests/test_optimization_engine_validation.py +161 -0
- auto3d-3.0.0/tests/test_output_overwrite_gates.py +259 -0
- auto3d-3.0.0/tests/test_packaging_metadata.py +105 -0
- auto3d-3.0.0/tests/test_padding.py +270 -0
- auto3d-3.0.0/tests/test_padding_invariance.py +80 -0
- auto3d-3.0.0/tests/test_parallel_embed.py +253 -0
- auto3d-3.0.0/tests/test_pipeline_e2e.py +344 -0
- auto3d-3.0.0/tests/test_processors.py +131 -0
- auto3d-3.0.0/tests/test_progress.py +304 -0
- auto3d-3.0.0/tests/test_public_api.py +37 -0
- auto3d-3.0.0/tests/test_ranking.py +1223 -0
- auto3d-3.0.0/tests/test_results.py +44 -0
- auto3d-3.0.0/tests/test_sdf_isomer_enumeration.py +199 -0
- auto3d-3.0.0/tests/test_smiles_stereo_warning.py +199 -0
- auto3d-3.0.0/tests/test_species_conversion.py +152 -0
- auto3d-3.0.0/tests/test_species_module.py +165 -0
- auto3d-3.0.0/tests/test_stereo_identity.py +164 -0
- auto3d-3.0.0/tests/test_stereo_postopt.py +218 -0
- auto3d-3.0.0/tests/test_stereochemistry_validation.py +232 -0
- {auto3d-2.3.1 → auto3d-3.0.0}/tests/test_tauto.py +9 -8
- auto3d-3.0.0/tests/test_tautomer_select.py +95 -0
- auto3d-3.0.0/tests/test_tautomer_stereo.py +133 -0
- auto3d-3.0.0/tests/test_thermo.py +560 -0
- auto3d-3.0.0/tests/test_thermo_helpers.py +1680 -0
- auto3d-3.0.0/tests/test_thermo_imaginary_mode_inversion.py +500 -0
- auto3d-3.0.0/tests/test_thermo_projection.py +413 -0
- auto3d-3.0.0/tests/test_thermo_record_assertions.py +83 -0
- auto3d-3.0.0/tests/test_thermo_reference.py +249 -0
- auto3d-3.0.0/tests/test_thermo_transition_state.py +208 -0
- auto3d-3.0.0/tests/test_torch_config.py +308 -0
- {auto3d-2.3.1 → auto3d-3.0.0}/tests/test_utils.py +12 -8
- auto3d-3.0.0/tests/test_utils_connectivity.py +211 -0
- auto3d-3.0.0/tests/test_utils_energy_constants.py +66 -0
- auto3d-3.0.0/tests/test_utils_geometry.py +155 -0
- auto3d-3.0.0/tests/test_utils_molprops.py +100 -0
- auto3d-3.0.0/tests/test_utils_reconciliation.py +255 -0
- auto3d-3.0.0/tests/test_utils_sdf_io.py +321 -0
- auto3d-3.0.0/tests/test_utils_smi_io.py +363 -0
- auto3d-3.0.0/tests/test_utils_stereochemistry.py +561 -0
- auto3d-3.0.0/tests/test_utils_validation.py +267 -0
- auto3d-3.0.0/tests/test_validate_run_parity.py +123 -0
- auto3d-3.0.0/tests/test_validation.py +274 -0
- auto3d-3.0.0/tests/test_validation_errors.py +203 -0
- auto3d-3.0.0/tests/test_workflow.py +1086 -0
- auto3d-2.3.1/MANIFEST.in +0 -3
- auto3d-2.3.1/PKG-INFO +0 -35
- auto3d-2.3.1/README.md +0 -16
- auto3d-2.3.1/pyproject.toml +0 -3
- auto3d-2.3.1/setup.cfg +0 -39
- auto3d-2.3.1/src/Auto3D/ASE/__pycache__/__init__.cpython-39.pyc +0 -0
- auto3d-2.3.1/src/Auto3D/ASE/__pycache__/geometry.cpython-39.pyc +0 -0
- auto3d-2.3.1/src/Auto3D/ASE/__pycache__/thermo.cpython-39.pyc +0 -0
- auto3d-2.3.1/src/Auto3D/ASE/geometry.py +0 -72
- auto3d-2.3.1/src/Auto3D/ASE/thermo.py +0 -327
- auto3d-2.3.1/src/Auto3D/SPE.py +0 -112
- auto3d-2.3.1/src/Auto3D/__init__.py +0 -26
- auto3d-2.3.1/src/Auto3D/__pycache__/SPE.cpython-39.pyc +0 -0
- auto3d-2.3.1/src/Auto3D/__pycache__/__init__.cpython-39.pyc +0 -0
- auto3d-2.3.1/src/Auto3D/__pycache__/auto3D.cpython-39.pyc +0 -0
- auto3d-2.3.1/src/Auto3D/__pycache__/auto3Dcli.cpython-39.pyc +0 -0
- auto3d-2.3.1/src/Auto3D/__pycache__/isomer_engine.cpython-39.pyc +0 -0
- auto3d-2.3.1/src/Auto3D/__pycache__/ranking.cpython-39.pyc +0 -0
- auto3d-2.3.1/src/Auto3D/__pycache__/tautomer.cpython-39.pyc +0 -0
- auto3d-2.3.1/src/Auto3D/__pycache__/utils.cpython-39.pyc +0 -0
- auto3d-2.3.1/src/Auto3D/__pycache__/utils_file.cpython-39.pyc +0 -0
- auto3d-2.3.1/src/Auto3D/auto3D.py +0 -520
- auto3d-2.3.1/src/Auto3D/auto3Dcli.py +0 -170
- auto3d-2.3.1/src/Auto3D/batch_opt/ANI2xt_no_rep.py +0 -126
- auto3d-2.3.1/src/Auto3D/batch_opt/ANI2xt_rep.py +0 -127
- auto3d-2.3.1/src/Auto3D/batch_opt/__pycache__/ANI2xt_no_rep.cpython-39.pyc +0 -0
- auto3d-2.3.1/src/Auto3D/batch_opt/__pycache__/__init__.cpython-39.pyc +0 -0
- auto3d-2.3.1/src/Auto3D/batch_opt/__pycache__/batchopt.cpython-39.pyc +0 -0
- auto3d-2.3.1/src/Auto3D/batch_opt/batchopt.py +0 -447
- auto3d-2.3.1/src/Auto3D/isomer_engine.py +0 -368
- auto3d-2.3.1/src/Auto3D/models/__init__.py +0 -0
- auto3d-2.3.1/src/Auto3D/models/aimnet2_wb97m-d3_0.jpt +0 -0
- auto3d-2.3.1/src/Auto3D/models/aimnet2_wb97m_ens_f.jpt +0 -0
- auto3d-2.3.1/src/Auto3D/ranking.py +0 -170
- auto3d-2.3.1/src/Auto3D/tautomer.py +0 -83
- auto3d-2.3.1/src/Auto3D/utils.py +0 -706
- auto3d-2.3.1/src/Auto3D/utils_file.py +0 -320
- auto3d-2.3.1/src/Auto3D.egg-info/PKG-INFO +0 -35
- auto3d-2.3.1/src/Auto3D.egg-info/SOURCES.txt +0 -53
- auto3d-2.3.1/src/Auto3D.egg-info/requires.txt +0 -4
- auto3d-2.3.1/tests/test_SPE.py +0 -190
- auto3d-2.3.1/tests/test_auto3D.py +0 -371
- auto3d-2.3.1/tests/test_isomer_engine.py +0 -91
- auto3d-2.3.1/tests/test_thermo.py +0 -299
- {auto3d-2.3.1 → auto3d-3.0.0}/LICENSE +0 -0
- {auto3d-2.3.1 → auto3d-3.0.0}/src/Auto3D/.gitignore +0 -0
- {auto3d-2.3.1 → auto3d-3.0.0}/src/Auto3D/ASE/__init__.py +0 -0
- {auto3d-2.3.1 → auto3d-3.0.0}/src/Auto3D/batch_opt/__init__.py +0 -0
- {auto3d-2.3.1 → auto3d-3.0.0}/src/Auto3D/models/ani2xt_no_repulsion.pt +0 -0
- {auto3d-2.3.1 → auto3d-3.0.0}/src/Auto3D.egg-info/dependency_links.txt +0 -0
- {auto3d-2.3.1 → auto3d-3.0.0}/src/Auto3D.egg-info/entry_points.txt +0 -0
- {auto3d-2.3.1 → auto3d-3.0.0}/src/Auto3D.egg-info/top_level.txt +0 -0
auto3d-3.0.0/MANIFEST.in
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
graft src/Auto3D
|
|
2
|
+
|
|
3
|
+
# `graft` is recursive and unconditional, so without these the sdist and wheel
|
|
4
|
+
# pick up whatever the build tree happens to contain. Building in a checkout
|
|
5
|
+
# that has been used -- which is every real build -- put 69 __pycache__/*.pyc
|
|
6
|
+
# files into the first 3.0.0 wheel: CPython 3.13 bytecode shipped inside a
|
|
7
|
+
# py3-none-any wheel, stale for any other interpreter and pure bloat for this
|
|
8
|
+
# one. Bytecode is generated at install time; it never belongs in a
|
|
9
|
+
# distribution.
|
|
10
|
+
global-exclude *.py[cod]
|
|
11
|
+
global-exclude __pycache__/*
|
auto3d-3.0.0/PKG-INFO
ADDED
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: Auto3D
|
|
3
|
+
Version: 3.0.0
|
|
4
|
+
Summary: Generating Low-energy 3D Conformers from SMILES/SDF
|
|
5
|
+
Author-email: Zhen Liu <liu5@andrew.cmu.edu>, Tetiana Zubatiuk <tetiana@zubatyuk.com>, Adrian Roitberg <roitberg@ufl.edu>, Olexandr Isayev <olexandr@olexandrisayev.com>
|
|
6
|
+
Maintainer-email: Olexandr Isayev <olexandr@olexandrisayev.com>
|
|
7
|
+
License: MIT
|
|
8
|
+
Project-URL: Homepage, https://github.com/isayevlab/Auto3D_pkg
|
|
9
|
+
Project-URL: Documentation, https://auto3d.readthedocs.io
|
|
10
|
+
Project-URL: Repository, https://github.com/isayevlab/Auto3D_pkg
|
|
11
|
+
Project-URL: Bug Tracker, https://github.com/isayevlab/Auto3D_pkg/issues
|
|
12
|
+
Project-URL: Changelog, https://github.com/isayevlab/Auto3D_pkg/releases
|
|
13
|
+
Keywords: chemistry,molecular-dynamics,conformer-generation,neural-network-potentials,cheminformatics,drug-discovery
|
|
14
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
15
|
+
Classifier: Intended Audience :: Science/Research
|
|
16
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
17
|
+
Classifier: Operating System :: OS Independent
|
|
18
|
+
Classifier: Programming Language :: Python :: 3
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
22
|
+
Classifier: Topic :: Scientific/Engineering :: Chemistry
|
|
23
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
24
|
+
Classifier: Typing :: Typed
|
|
25
|
+
Requires-Python: >=3.11
|
|
26
|
+
Description-Content-Type: text/markdown
|
|
27
|
+
License-File: LICENSE
|
|
28
|
+
Requires-Dist: tqdm>=4.60.0
|
|
29
|
+
Requires-Dist: psutil>=5.8.0
|
|
30
|
+
Requires-Dist: Send2Trash>=1.8.0
|
|
31
|
+
Requires-Dist: pyyaml>=6.0
|
|
32
|
+
Requires-Dist: numpy>=1.21.0
|
|
33
|
+
Requires-Dist: pandas>=1.3.0
|
|
34
|
+
Requires-Dist: rdkit>=2022.9.5
|
|
35
|
+
Requires-Dist: torch>=2.8
|
|
36
|
+
Requires-Dist: aimnet>=0.2
|
|
37
|
+
Requires-Dist: requests>=2.32.3
|
|
38
|
+
Requires-Dist: typer>=0.12.0
|
|
39
|
+
Requires-Dist: rich>=13.0.0
|
|
40
|
+
Requires-Dist: pydantic>=2.0
|
|
41
|
+
Provides-Extra: ani
|
|
42
|
+
Requires-Dist: torchani>=2.8; extra == "ani"
|
|
43
|
+
Provides-Extra: ase
|
|
44
|
+
Requires-Dist: ase>=3.23.0; extra == "ase"
|
|
45
|
+
Provides-Extra: dev
|
|
46
|
+
Requires-Dist: pytest>=7.0; extra == "dev"
|
|
47
|
+
Requires-Dist: pytest-cov>=4.0; extra == "dev"
|
|
48
|
+
Requires-Dist: mypy>=1.0; extra == "dev"
|
|
49
|
+
Requires-Dist: ruff>=0.1.0; extra == "dev"
|
|
50
|
+
Requires-Dist: pre-commit>=3.0; extra == "dev"
|
|
51
|
+
Provides-Extra: docs
|
|
52
|
+
Requires-Dist: sphinx>=7.0; extra == "docs"
|
|
53
|
+
Requires-Dist: sphinx-rtd-theme>=1.3.0; extra == "docs"
|
|
54
|
+
Requires-Dist: nbsphinx>=0.9.0; extra == "docs"
|
|
55
|
+
Requires-Dist: myst-parser>=2.0; extra == "docs"
|
|
56
|
+
Provides-Extra: all
|
|
57
|
+
Requires-Dist: Auto3D[ani,ase,dev,docs]; extra == "all"
|
|
58
|
+
Dynamic: license-file
|
|
59
|
+
|
|
60
|
+
# **Auto3D**
|
|
61
|
+
|
|
62
|
+
[](https://pypi.org/project/Auto3D/)
|
|
63
|
+
[](https://pypi.org/project/Auto3D/)
|
|
64
|
+
[](https://github.com/isayevlab/Auto3D_pkg/blob/main/LICENSE)
|
|
65
|
+
[](https://www.python.org/downloads/)
|
|
66
|
+
|
|
67
|
+

|
|
68
|
+
|
|
69
|
+
**Auto3D** automatically generates low-energy 3D molecular conformers from SMILES or SDF input using neural network potentials (AIMNet2, ANI2x, ANI2xt). It handles tautomer enumeration, stereoisomer generation, geometry optimization, and conformer ranking in a single workflow.
|
|
70
|
+
|
|
71
|
+
## What's New in v3.0
|
|
72
|
+
|
|
73
|
+
- **Modern CLI** with Typer and Rich - beautiful terminal output, progress bars, and helpful error messages
|
|
74
|
+
- **Subcommand structure** - `run`, `config`, `models`, `validate` commands
|
|
75
|
+
- **Improved architecture** - cleaner codebase with strategy patterns and proper separation of concerns
|
|
76
|
+
- **Better logging** - structured logging throughout the workflow
|
|
77
|
+
- **Type safety** - full type hints and Pydantic validation
|
|
78
|
+
|
|
79
|
+
## Installation
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
# Using uv (fastest)
|
|
83
|
+
uv pip install Auto3D
|
|
84
|
+
|
|
85
|
+
# Using pip
|
|
86
|
+
pip install Auto3D
|
|
87
|
+
|
|
88
|
+
# Using conda (recommended for GPU support)
|
|
89
|
+
conda install -c conda-forge auto3d
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
For GPU acceleration, ensure you have CUDA-compatible PyTorch installed. See the [installation guide](https://auto3d.readthedocs.io/en/latest/installation.html) for detailed instructions.
|
|
93
|
+
|
|
94
|
+
## Quick Start
|
|
95
|
+
|
|
96
|
+
### Command Line
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
# Generate top-5 conformers per molecule
|
|
100
|
+
auto3d run molecules.smi --k=5
|
|
101
|
+
|
|
102
|
+
# Use a configuration file
|
|
103
|
+
auto3d run molecules.smi -c config.yaml
|
|
104
|
+
|
|
105
|
+
# Generate a config template
|
|
106
|
+
auto3d config init
|
|
107
|
+
|
|
108
|
+
# List available neural network models
|
|
109
|
+
auto3d models list
|
|
110
|
+
|
|
111
|
+
# Validate input file before running
|
|
112
|
+
auto3d validate molecules.smi
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### Python API
|
|
116
|
+
|
|
117
|
+
```python
|
|
118
|
+
from Auto3D import Auto3DOptions, main
|
|
119
|
+
|
|
120
|
+
# Generate conformers for a SMILES file
|
|
121
|
+
config = Auto3DOptions(path="molecules.smi", k=1)
|
|
122
|
+
output_path = main(config)
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
For small batches (< 150 molecules), use the convenience function:
|
|
126
|
+
|
|
127
|
+
```python
|
|
128
|
+
from Auto3D import Auto3DOptions, smiles2mols
|
|
129
|
+
|
|
130
|
+
smiles = ["CCO", "CCCO", "c1ccccc1"]
|
|
131
|
+
config = Auto3DOptions(k=1, use_gpu=False)
|
|
132
|
+
mols = smiles2mols(smiles, config)
|
|
133
|
+
|
|
134
|
+
# Access energies from RDKit mol objects
|
|
135
|
+
for mol in mols:
|
|
136
|
+
print(f"{mol.GetProp('_Name')}: {mol.GetProp('E_tot')} Hartree")
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
## CLI Commands
|
|
140
|
+
|
|
141
|
+
| Command | Description |
|
|
142
|
+
|---------|-------------|
|
|
143
|
+
| `auto3d run <input> [options]` | Generate conformers from SMILES/SDF |
|
|
144
|
+
| `auto3d energy <input.sdf>` | Single-point energy for an SDF |
|
|
145
|
+
| `auto3d optimize <input.sdf>` | Geometry-optimize the structures in an SDF |
|
|
146
|
+
| `auto3d thermo <input.sdf>` | Thermochemistry (enthalpy/entropy/Gibbs); needs the `ase` extra |
|
|
147
|
+
| `auto3d tautomers <input.smi>` | Enumerate and rank stable tautomers |
|
|
148
|
+
| `auto3d config init` | Create a configuration template |
|
|
149
|
+
| `auto3d config show <file>` | Display config with syntax highlighting |
|
|
150
|
+
| `auto3d config validate <file>` | Validate a configuration file |
|
|
151
|
+
| `auto3d models list` | List available NNP models |
|
|
152
|
+
| `auto3d models info <engine>` | Show model details |
|
|
153
|
+
| `auto3d models test <engine>` | Load an engine and run a forward pass to verify it works |
|
|
154
|
+
| `auto3d validate <input>` | Validate input file |
|
|
155
|
+
|
|
156
|
+
### Common Options
|
|
157
|
+
|
|
158
|
+
```bash
|
|
159
|
+
auto3d run input.smi --k=5 # Top-k conformers
|
|
160
|
+
auto3d run input.smi --window=3.0 # Energy window (kcal/mol)
|
|
161
|
+
auto3d run input.smi --engine=ANI2x # AIMNET, ANI2x, ANI2xt, a registry name, or a model path
|
|
162
|
+
auto3d run input.smi --no-gpu # CPU-only mode
|
|
163
|
+
auto3d run input.smi -c config.yaml # Use config file
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
### Shell Completion
|
|
167
|
+
|
|
168
|
+
```bash
|
|
169
|
+
# Enable tab completion
|
|
170
|
+
auto3d --install-completion bash # or zsh, fish
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
## Neural Network Potentials
|
|
174
|
+
|
|
175
|
+
| Engine | Description | Elements |
|
|
176
|
+
|--------|-------------|----------|
|
|
177
|
+
| **AIMNET** (default) | AIMNet2 with D3 dispersion (alias for `aimnet2`) | H, B, C, N, O, F, Si, P, S, Cl, As, Se, Br, I |
|
|
178
|
+
| **aimnet2-2025**, **aimnet2-nse**, **aimnet2-pd**, ... | Any `aimnet` registry model | H, B, C, N, O, F, Si, P, S, Cl, As, Se, Br, I (`aimnet2-pd` replaces As with Pd) |
|
|
179
|
+
| **ANI2x** | ANI-2x ensemble | H, C, N, O, F, S, Cl |
|
|
180
|
+
| **ANI2xt** | Extended ANI-2x | H, C, N, O, F, S, Cl |
|
|
181
|
+
|
|
182
|
+
AIMNet2 models are provided by the [`aimnet`](https://github.com/isayevlab/aimnetcentral)
|
|
183
|
+
package and auto-downloaded (and sha256-validated) into `~/.cache/aimnet` on first
|
|
184
|
+
use; set `AIMNET_CACHE_DIR` to change the cache location. Network access is required
|
|
185
|
+
once per model. Run `auto3d models list` to see available registry families.
|
|
186
|
+
`optimizing_engine` also accepts a path to a custom NNP model file.
|
|
187
|
+
|
|
188
|
+
> **Note:** As of v3.5, AIMNet2 is served by the `aimnet` package rather than
|
|
189
|
+
> bundled `.jpt` files, and the default AIMNet2 energies differ from 3.x (the
|
|
190
|
+
> registry `.pt` externalizes D3 dispersion), so conformer rankings may shift
|
|
191
|
+
> slightly. Requires Python >= 3.11 and PyTorch >= 2.8.
|
|
192
|
+
|
|
193
|
+
## Key Parameters
|
|
194
|
+
|
|
195
|
+
| Parameter | Default | Description |
|
|
196
|
+
|-----------|---------|-------------|
|
|
197
|
+
| `k` | - | Output top-k conformers per molecule |
|
|
198
|
+
| `window` | - | Energy window in kcal/mol (alternative to k) |
|
|
199
|
+
| `optimizing_engine` | AIMNET | NNP: AIMNET, an aimnet registry name, ANI2x, ANI2xt, or a model path |
|
|
200
|
+
| `use_gpu` | True | Enable GPU acceleration |
|
|
201
|
+
| `enumerate_tautomer` | False | Enumerate tautomers |
|
|
202
|
+
| `enumerate_isomer` | True | Enumerate stereoisomers |
|
|
203
|
+
| `threshold` | 0.3 | RMSD threshold for duplicate removal (Å) |
|
|
204
|
+
|
|
205
|
+
## Documentation
|
|
206
|
+
|
|
207
|
+
Full documentation: [**auto3d.readthedocs.io**](https://auto3d.readthedocs.io/)
|
|
208
|
+
|
|
209
|
+
- [Installation Guide](https://auto3d.readthedocs.io/en/latest/installation.html)
|
|
210
|
+
- [Usage & Examples](https://auto3d.readthedocs.io/en/latest/usage.html)
|
|
211
|
+
- [API Reference](https://auto3d.readthedocs.io/en/latest/api.html)
|
|
212
|
+
- [Jupyter Notebooks](https://github.com/isayevlab/Auto3D_pkg/tree/main/example)
|
|
213
|
+
|
|
214
|
+
## Citation
|
|
215
|
+
|
|
216
|
+
If you use Auto3D in your research, please cite:
|
|
217
|
+
|
|
218
|
+
```bibtex
|
|
219
|
+
@article{liu2022auto3d,
|
|
220
|
+
title={Auto3D: Automatic generation of the low-energy 3D structures with ANI neural network potentials},
|
|
221
|
+
author={Liu, Zhen and Zubatiuk, Tetiana and Roitberg, Adrian and Isayev, Olexandr},
|
|
222
|
+
journal={Journal of Chemical Information and Modeling},
|
|
223
|
+
volume={62},
|
|
224
|
+
number={22},
|
|
225
|
+
pages={5373--5382},
|
|
226
|
+
year={2022},
|
|
227
|
+
publisher={ACS Publications},
|
|
228
|
+
doi={10.1021/acs.jcim.2c00817}
|
|
229
|
+
}
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
## Contributing
|
|
233
|
+
|
|
234
|
+
- **Bug reports**: [GitHub Issues](https://github.com/isayevlab/Auto3D_pkg/issues)
|
|
235
|
+
- **Feature requests**: [GitHub Discussions](https://github.com/isayevlab/Auto3D_pkg/discussions)
|
|
236
|
+
- **Pull requests**: Welcome! Please read our contributing guidelines.
|
|
237
|
+
|
|
238
|
+
## License
|
|
239
|
+
|
|
240
|
+
MIT License - see [LICENSE](LICENSE) for details.
|
auto3d-3.0.0/README.md
ADDED
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
# **Auto3D**
|
|
2
|
+
|
|
3
|
+
[](https://pypi.org/project/Auto3D/)
|
|
4
|
+
[](https://pypi.org/project/Auto3D/)
|
|
5
|
+
[](https://github.com/isayevlab/Auto3D_pkg/blob/main/LICENSE)
|
|
6
|
+
[](https://www.python.org/downloads/)
|
|
7
|
+
|
|
8
|
+

|
|
9
|
+
|
|
10
|
+
**Auto3D** automatically generates low-energy 3D molecular conformers from SMILES or SDF input using neural network potentials (AIMNet2, ANI2x, ANI2xt). It handles tautomer enumeration, stereoisomer generation, geometry optimization, and conformer ranking in a single workflow.
|
|
11
|
+
|
|
12
|
+
## What's New in v3.0
|
|
13
|
+
|
|
14
|
+
- **Modern CLI** with Typer and Rich - beautiful terminal output, progress bars, and helpful error messages
|
|
15
|
+
- **Subcommand structure** - `run`, `config`, `models`, `validate` commands
|
|
16
|
+
- **Improved architecture** - cleaner codebase with strategy patterns and proper separation of concerns
|
|
17
|
+
- **Better logging** - structured logging throughout the workflow
|
|
18
|
+
- **Type safety** - full type hints and Pydantic validation
|
|
19
|
+
|
|
20
|
+
## Installation
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
# Using uv (fastest)
|
|
24
|
+
uv pip install Auto3D
|
|
25
|
+
|
|
26
|
+
# Using pip
|
|
27
|
+
pip install Auto3D
|
|
28
|
+
|
|
29
|
+
# Using conda (recommended for GPU support)
|
|
30
|
+
conda install -c conda-forge auto3d
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
For GPU acceleration, ensure you have CUDA-compatible PyTorch installed. See the [installation guide](https://auto3d.readthedocs.io/en/latest/installation.html) for detailed instructions.
|
|
34
|
+
|
|
35
|
+
## Quick Start
|
|
36
|
+
|
|
37
|
+
### Command Line
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
# Generate top-5 conformers per molecule
|
|
41
|
+
auto3d run molecules.smi --k=5
|
|
42
|
+
|
|
43
|
+
# Use a configuration file
|
|
44
|
+
auto3d run molecules.smi -c config.yaml
|
|
45
|
+
|
|
46
|
+
# Generate a config template
|
|
47
|
+
auto3d config init
|
|
48
|
+
|
|
49
|
+
# List available neural network models
|
|
50
|
+
auto3d models list
|
|
51
|
+
|
|
52
|
+
# Validate input file before running
|
|
53
|
+
auto3d validate molecules.smi
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Python API
|
|
57
|
+
|
|
58
|
+
```python
|
|
59
|
+
from Auto3D import Auto3DOptions, main
|
|
60
|
+
|
|
61
|
+
# Generate conformers for a SMILES file
|
|
62
|
+
config = Auto3DOptions(path="molecules.smi", k=1)
|
|
63
|
+
output_path = main(config)
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
For small batches (< 150 molecules), use the convenience function:
|
|
67
|
+
|
|
68
|
+
```python
|
|
69
|
+
from Auto3D import Auto3DOptions, smiles2mols
|
|
70
|
+
|
|
71
|
+
smiles = ["CCO", "CCCO", "c1ccccc1"]
|
|
72
|
+
config = Auto3DOptions(k=1, use_gpu=False)
|
|
73
|
+
mols = smiles2mols(smiles, config)
|
|
74
|
+
|
|
75
|
+
# Access energies from RDKit mol objects
|
|
76
|
+
for mol in mols:
|
|
77
|
+
print(f"{mol.GetProp('_Name')}: {mol.GetProp('E_tot')} Hartree")
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## CLI Commands
|
|
81
|
+
|
|
82
|
+
| Command | Description |
|
|
83
|
+
|---------|-------------|
|
|
84
|
+
| `auto3d run <input> [options]` | Generate conformers from SMILES/SDF |
|
|
85
|
+
| `auto3d energy <input.sdf>` | Single-point energy for an SDF |
|
|
86
|
+
| `auto3d optimize <input.sdf>` | Geometry-optimize the structures in an SDF |
|
|
87
|
+
| `auto3d thermo <input.sdf>` | Thermochemistry (enthalpy/entropy/Gibbs); needs the `ase` extra |
|
|
88
|
+
| `auto3d tautomers <input.smi>` | Enumerate and rank stable tautomers |
|
|
89
|
+
| `auto3d config init` | Create a configuration template |
|
|
90
|
+
| `auto3d config show <file>` | Display config with syntax highlighting |
|
|
91
|
+
| `auto3d config validate <file>` | Validate a configuration file |
|
|
92
|
+
| `auto3d models list` | List available NNP models |
|
|
93
|
+
| `auto3d models info <engine>` | Show model details |
|
|
94
|
+
| `auto3d models test <engine>` | Load an engine and run a forward pass to verify it works |
|
|
95
|
+
| `auto3d validate <input>` | Validate input file |
|
|
96
|
+
|
|
97
|
+
### Common Options
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
auto3d run input.smi --k=5 # Top-k conformers
|
|
101
|
+
auto3d run input.smi --window=3.0 # Energy window (kcal/mol)
|
|
102
|
+
auto3d run input.smi --engine=ANI2x # AIMNET, ANI2x, ANI2xt, a registry name, or a model path
|
|
103
|
+
auto3d run input.smi --no-gpu # CPU-only mode
|
|
104
|
+
auto3d run input.smi -c config.yaml # Use config file
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Shell Completion
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
# Enable tab completion
|
|
111
|
+
auto3d --install-completion bash # or zsh, fish
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
## Neural Network Potentials
|
|
115
|
+
|
|
116
|
+
| Engine | Description | Elements |
|
|
117
|
+
|--------|-------------|----------|
|
|
118
|
+
| **AIMNET** (default) | AIMNet2 with D3 dispersion (alias for `aimnet2`) | H, B, C, N, O, F, Si, P, S, Cl, As, Se, Br, I |
|
|
119
|
+
| **aimnet2-2025**, **aimnet2-nse**, **aimnet2-pd**, ... | Any `aimnet` registry model | H, B, C, N, O, F, Si, P, S, Cl, As, Se, Br, I (`aimnet2-pd` replaces As with Pd) |
|
|
120
|
+
| **ANI2x** | ANI-2x ensemble | H, C, N, O, F, S, Cl |
|
|
121
|
+
| **ANI2xt** | Extended ANI-2x | H, C, N, O, F, S, Cl |
|
|
122
|
+
|
|
123
|
+
AIMNet2 models are provided by the [`aimnet`](https://github.com/isayevlab/aimnetcentral)
|
|
124
|
+
package and auto-downloaded (and sha256-validated) into `~/.cache/aimnet` on first
|
|
125
|
+
use; set `AIMNET_CACHE_DIR` to change the cache location. Network access is required
|
|
126
|
+
once per model. Run `auto3d models list` to see available registry families.
|
|
127
|
+
`optimizing_engine` also accepts a path to a custom NNP model file.
|
|
128
|
+
|
|
129
|
+
> **Note:** As of v3.5, AIMNet2 is served by the `aimnet` package rather than
|
|
130
|
+
> bundled `.jpt` files, and the default AIMNet2 energies differ from 3.x (the
|
|
131
|
+
> registry `.pt` externalizes D3 dispersion), so conformer rankings may shift
|
|
132
|
+
> slightly. Requires Python >= 3.11 and PyTorch >= 2.8.
|
|
133
|
+
|
|
134
|
+
## Key Parameters
|
|
135
|
+
|
|
136
|
+
| Parameter | Default | Description |
|
|
137
|
+
|-----------|---------|-------------|
|
|
138
|
+
| `k` | - | Output top-k conformers per molecule |
|
|
139
|
+
| `window` | - | Energy window in kcal/mol (alternative to k) |
|
|
140
|
+
| `optimizing_engine` | AIMNET | NNP: AIMNET, an aimnet registry name, ANI2x, ANI2xt, or a model path |
|
|
141
|
+
| `use_gpu` | True | Enable GPU acceleration |
|
|
142
|
+
| `enumerate_tautomer` | False | Enumerate tautomers |
|
|
143
|
+
| `enumerate_isomer` | True | Enumerate stereoisomers |
|
|
144
|
+
| `threshold` | 0.3 | RMSD threshold for duplicate removal (Å) |
|
|
145
|
+
|
|
146
|
+
## Documentation
|
|
147
|
+
|
|
148
|
+
Full documentation: [**auto3d.readthedocs.io**](https://auto3d.readthedocs.io/)
|
|
149
|
+
|
|
150
|
+
- [Installation Guide](https://auto3d.readthedocs.io/en/latest/installation.html)
|
|
151
|
+
- [Usage & Examples](https://auto3d.readthedocs.io/en/latest/usage.html)
|
|
152
|
+
- [API Reference](https://auto3d.readthedocs.io/en/latest/api.html)
|
|
153
|
+
- [Jupyter Notebooks](https://github.com/isayevlab/Auto3D_pkg/tree/main/example)
|
|
154
|
+
|
|
155
|
+
## Citation
|
|
156
|
+
|
|
157
|
+
If you use Auto3D in your research, please cite:
|
|
158
|
+
|
|
159
|
+
```bibtex
|
|
160
|
+
@article{liu2022auto3d,
|
|
161
|
+
title={Auto3D: Automatic generation of the low-energy 3D structures with ANI neural network potentials},
|
|
162
|
+
author={Liu, Zhen and Zubatiuk, Tetiana and Roitberg, Adrian and Isayev, Olexandr},
|
|
163
|
+
journal={Journal of Chemical Information and Modeling},
|
|
164
|
+
volume={62},
|
|
165
|
+
number={22},
|
|
166
|
+
pages={5373--5382},
|
|
167
|
+
year={2022},
|
|
168
|
+
publisher={ACS Publications},
|
|
169
|
+
doi={10.1021/acs.jcim.2c00817}
|
|
170
|
+
}
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
## Contributing
|
|
174
|
+
|
|
175
|
+
- **Bug reports**: [GitHub Issues](https://github.com/isayevlab/Auto3D_pkg/issues)
|
|
176
|
+
- **Feature requests**: [GitHub Discussions](https://github.com/isayevlab/Auto3D_pkg/discussions)
|
|
177
|
+
- **Pull requests**: Welcome! Please read our contributing guidelines.
|
|
178
|
+
|
|
179
|
+
## License
|
|
180
|
+
|
|
181
|
+
MIT License - see [LICENSE](LICENSE) for details.
|
|
@@ -0,0 +1,227 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=61.0", "wheel"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "Auto3D"
|
|
7
|
+
version = "3.0.0"
|
|
8
|
+
description = "Generating Low-energy 3D Conformers from SMILES/SDF"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = {text = "MIT"}
|
|
11
|
+
authors = [
|
|
12
|
+
{name = "Zhen Liu", email = "liu5@andrew.cmu.edu"},
|
|
13
|
+
{name = "Tetiana Zubatiuk", email = "tetiana@zubatyuk.com"},
|
|
14
|
+
{name = "Adrian Roitberg", email = "roitberg@ufl.edu"},
|
|
15
|
+
{name = "Olexandr Isayev", email = "olexandr@olexandrisayev.com"},
|
|
16
|
+
]
|
|
17
|
+
maintainers = [
|
|
18
|
+
{name = "Olexandr Isayev", email = "olexandr@olexandrisayev.com"},
|
|
19
|
+
]
|
|
20
|
+
keywords = [
|
|
21
|
+
"chemistry",
|
|
22
|
+
"molecular-dynamics",
|
|
23
|
+
"conformer-generation",
|
|
24
|
+
"neural-network-potentials",
|
|
25
|
+
"cheminformatics",
|
|
26
|
+
"drug-discovery",
|
|
27
|
+
]
|
|
28
|
+
requires-python = ">=3.11"
|
|
29
|
+
classifiers = [
|
|
30
|
+
"Development Status :: 5 - Production/Stable",
|
|
31
|
+
"Intended Audience :: Science/Research",
|
|
32
|
+
"License :: OSI Approved :: MIT License",
|
|
33
|
+
"Operating System :: OS Independent",
|
|
34
|
+
"Programming Language :: Python :: 3",
|
|
35
|
+
"Programming Language :: Python :: 3.11",
|
|
36
|
+
"Programming Language :: Python :: 3.12",
|
|
37
|
+
"Programming Language :: Python :: 3.13",
|
|
38
|
+
"Topic :: Scientific/Engineering :: Chemistry",
|
|
39
|
+
"Topic :: Scientific/Engineering :: Artificial Intelligence",
|
|
40
|
+
"Typing :: Typed",
|
|
41
|
+
]
|
|
42
|
+
dependencies = [
|
|
43
|
+
"tqdm>=4.60.0",
|
|
44
|
+
"psutil>=5.8.0",
|
|
45
|
+
"Send2Trash>=1.8.0",
|
|
46
|
+
"pyyaml>=6.0",
|
|
47
|
+
"numpy>=1.21.0",
|
|
48
|
+
"pandas>=1.3.0",
|
|
49
|
+
"rdkit>=2022.9.5",
|
|
50
|
+
"torch>=2.8",
|
|
51
|
+
"aimnet>=0.2",
|
|
52
|
+
"requests>=2.32.3",
|
|
53
|
+
"typer>=0.12.0",
|
|
54
|
+
"rich>=13.0.0",
|
|
55
|
+
"pydantic>=2.0",
|
|
56
|
+
]
|
|
57
|
+
|
|
58
|
+
[project.optional-dependencies]
|
|
59
|
+
ani = [
|
|
60
|
+
"torchani>=2.8",
|
|
61
|
+
]
|
|
62
|
+
ase = [
|
|
63
|
+
# 3.23.0, not 3.22.1: IdealGasThermo gained `ignore_imag_modes` in 3.23.0,
|
|
64
|
+
# and Auto3D.ASE.thermo passes it -- on 3.22.1 that call raises TypeError.
|
|
65
|
+
# 3.22.1 also slices the last 3N-6 of the input list without sorting it
|
|
66
|
+
# first, a third distinct mode-selection semantics. Verified against the
|
|
67
|
+
# 3.22.1 and 3.23.0 wheels.
|
|
68
|
+
"ase>=3.23.0",
|
|
69
|
+
]
|
|
70
|
+
dev = [
|
|
71
|
+
"pytest>=7.0",
|
|
72
|
+
"pytest-cov>=4.0",
|
|
73
|
+
"mypy>=1.0",
|
|
74
|
+
"ruff>=0.1.0",
|
|
75
|
+
"pre-commit>=3.0",
|
|
76
|
+
]
|
|
77
|
+
docs = [
|
|
78
|
+
"sphinx>=7.0",
|
|
79
|
+
"sphinx-rtd-theme>=1.3.0",
|
|
80
|
+
"nbsphinx>=0.9.0",
|
|
81
|
+
"myst-parser>=2.0",
|
|
82
|
+
]
|
|
83
|
+
all = [
|
|
84
|
+
"Auto3D[ani,ase,dev,docs]",
|
|
85
|
+
]
|
|
86
|
+
|
|
87
|
+
[project.scripts]
|
|
88
|
+
auto3d = "Auto3D.auto3Dcli:cli"
|
|
89
|
+
|
|
90
|
+
[project.urls]
|
|
91
|
+
Homepage = "https://github.com/isayevlab/Auto3D_pkg"
|
|
92
|
+
Documentation = "https://auto3d.readthedocs.io"
|
|
93
|
+
Repository = "https://github.com/isayevlab/Auto3D_pkg"
|
|
94
|
+
"Bug Tracker" = "https://github.com/isayevlab/Auto3D_pkg/issues"
|
|
95
|
+
Changelog = "https://github.com/isayevlab/Auto3D_pkg/releases"
|
|
96
|
+
|
|
97
|
+
[tool.setuptools.packages.find]
|
|
98
|
+
where = ["src"]
|
|
99
|
+
|
|
100
|
+
[tool.setuptools.package-data]
|
|
101
|
+
Auto3D = ["models/*.pt"]
|
|
102
|
+
|
|
103
|
+
[tool.ruff]
|
|
104
|
+
line-length = 100
|
|
105
|
+
target-version = "py311"
|
|
106
|
+
|
|
107
|
+
[tool.ruff.lint]
|
|
108
|
+
select = [
|
|
109
|
+
"E", # pycodestyle errors
|
|
110
|
+
"F", # Pyflakes
|
|
111
|
+
"I", # isort
|
|
112
|
+
"N", # pep8-naming
|
|
113
|
+
"UP", # pyupgrade
|
|
114
|
+
"B", # flake8-bugbear
|
|
115
|
+
"C4", # flake8-comprehensions
|
|
116
|
+
"SIM", # flake8-simplify
|
|
117
|
+
]
|
|
118
|
+
ignore = [
|
|
119
|
+
"E501", # line too long (handled by formatter)
|
|
120
|
+
"E402", # module level import not at top (needed for sys.path manipulation)
|
|
121
|
+
"E741", # ambiguous variable name (scientific notation l, I, O)
|
|
122
|
+
"N801", # class name should use CapWords (legacy code compatibility)
|
|
123
|
+
"N802", # function name should be lowercase (legacy API compatibility)
|
|
124
|
+
"N803", # argument name should be lowercase (scientific computing conventions)
|
|
125
|
+
"N806", # variable name should be lowercase (scientific computing conventions)
|
|
126
|
+
"N815", # mixedCase variable (scientific notation like pKa)
|
|
127
|
+
"N999", # invalid module name (Auto3D is the package name)
|
|
128
|
+
"SIM102", # nested if (sometimes clearer)
|
|
129
|
+
"SIM103", # return condition directly (explicit is clearer)
|
|
130
|
+
"SIM105", # contextlib.suppress (try-except-pass is clearer for optional imports)
|
|
131
|
+
"SIM108", # ternary operator (less readable for complex conditions)
|
|
132
|
+
"SIM110", # any/all (explicit loops can be clearer)
|
|
133
|
+
"SIM115", # context manager for open (sometimes not applicable)
|
|
134
|
+
"SIM118", # key in dict instead of dict.keys()
|
|
135
|
+
"B007", # unused loop variable (intentional in some cases)
|
|
136
|
+
"B008", # function call in default argument (torch.device is acceptable)
|
|
137
|
+
"B028", # stacklevel in warnings (not always needed)
|
|
138
|
+
"B904", # raise from in except (not always needed)
|
|
139
|
+
"C403", # set comprehension (list comprehension is often clearer)
|
|
140
|
+
"C408", # dict() call (more readable with keyword arguments)
|
|
141
|
+
"C416", # list comprehension (intentional in some cases)
|
|
142
|
+
"C417", # map usage (sometimes clearer than list comprehension)
|
|
143
|
+
"UP031", # format specifiers (% format is fine for simple cases)
|
|
144
|
+
]
|
|
145
|
+
|
|
146
|
+
[tool.ruff.lint.per-file-ignores]
|
|
147
|
+
# Task 11 (CI wiring) put `tests/` under `ruff check` for the first time. Bare
|
|
148
|
+
# `except:` blocks (E722) were fixed directly -- a narrow, mechanical swap to
|
|
149
|
+
# `except OSError:`/`except ImportError:` at each site. Everything below is
|
|
150
|
+
# pre-existing style debt spread across most test files (not specific to the
|
|
151
|
+
# newly-gated modules); fixing it is a wholesale test-suite reformat out of
|
|
152
|
+
# scope for a CI-wiring change, so it is narrowed here instead of edited.
|
|
153
|
+
#
|
|
154
|
+
# F811 (redefined-while-unused) and SIM222 (`... or True`) were deliberately
|
|
155
|
+
# NOT added here, even though both fired in tests/. A fix-round review found
|
|
156
|
+
# each one was flagging a real, currently-active bug rather than a style
|
|
157
|
+
# nit -- a duplicate `TestCombineSmi` class silently shadowing another
|
|
158
|
+
# class's test, and a vacuous `assert ... or True` that could never fail.
|
|
159
|
+
# Both were fixed at the source instead (see git history), and both codes
|
|
160
|
+
# stay enabled for tests/ so a regression here is caught by lint again.
|
|
161
|
+
"tests/*" = [
|
|
162
|
+
"I001", # unsorted imports -- reordering would touch most test files
|
|
163
|
+
"F401", # unused imports (legacy test scaffolding, e.g. optional-dep guards)
|
|
164
|
+
"E712", # `== True`/`== False` comparisons (common in older tests)
|
|
165
|
+
"E702", # multiple statements on one line (semicolons in legacy tests)
|
|
166
|
+
"B017", # assertRaises(Exception) -- broad but intentional in smoke tests
|
|
167
|
+
"F841", # unused local variables (e.g. captured-for-inspection results)
|
|
168
|
+
"N816", # mixedCase globals (e.g. `test_userNNP1` availability flags)
|
|
169
|
+
"UP008", # super() with parameters (legacy style, harmless)
|
|
170
|
+
"SIM117", # nested `with` statements (sometimes clearer split out)
|
|
171
|
+
"N811", # constant imported as non-constant (legacy aliasing)
|
|
172
|
+
"B905", # zip() without strict= (pre-3.10-style call sites)
|
|
173
|
+
"E401", # multiple imports on one line
|
|
174
|
+
"N813", # camelCase import aliased to lowercase
|
|
175
|
+
"SIM300", # yoda conditions
|
|
176
|
+
]
|
|
177
|
+
|
|
178
|
+
[tool.ruff.lint.isort]
|
|
179
|
+
known-first-party = ["Auto3D"]
|
|
180
|
+
|
|
181
|
+
[tool.mypy]
|
|
182
|
+
python_version = "3.11"
|
|
183
|
+
warn_return_any = true
|
|
184
|
+
warn_unused_configs = true
|
|
185
|
+
ignore_missing_imports = true
|
|
186
|
+
exclude = [
|
|
187
|
+
"tests/",
|
|
188
|
+
"docs/",
|
|
189
|
+
"example/",
|
|
190
|
+
]
|
|
191
|
+
|
|
192
|
+
[tool.pytest.ini_options]
|
|
193
|
+
testpaths = ["tests"]
|
|
194
|
+
python_files = "test_*.py"
|
|
195
|
+
python_classes = "Test*"
|
|
196
|
+
python_functions = "test_*"
|
|
197
|
+
addopts = "-v --tb=short -m 'not slow'"
|
|
198
|
+
markers = [
|
|
199
|
+
"slow: marks tests as slow (deselect with '-m \"not slow\"')",
|
|
200
|
+
]
|
|
201
|
+
filterwarnings = [
|
|
202
|
+
"error::pytest.PytestUnraisableExceptionWarning",
|
|
203
|
+
# Auto3D's own deprecation and chemistry warnings are public contract and
|
|
204
|
+
# must stay visible so tests can assert them (audit M34).
|
|
205
|
+
"default::DeprecationWarning:Auto3D.*",
|
|
206
|
+
"default::UserWarning:Auto3D.*",
|
|
207
|
+
# Third-party noise we do not control.
|
|
208
|
+
"ignore:.*pkg_resources is deprecated.*:DeprecationWarning",
|
|
209
|
+
"ignore:.*Importing 'parser.split_arg_string' is deprecated.*:DeprecationWarning",
|
|
210
|
+
"ignore::DeprecationWarning:torch.*",
|
|
211
|
+
"ignore::DeprecationWarning:ase.*",
|
|
212
|
+
"ignore::UserWarning:torch.*",
|
|
213
|
+
]
|
|
214
|
+
|
|
215
|
+
[tool.coverage.run]
|
|
216
|
+
source = ["src/Auto3D"]
|
|
217
|
+
omit = [
|
|
218
|
+
"*/tests/*",
|
|
219
|
+
"*/__init__.py",
|
|
220
|
+
]
|
|
221
|
+
|
|
222
|
+
[tool.coverage.report]
|
|
223
|
+
exclude_lines = [
|
|
224
|
+
"pragma: no cover",
|
|
225
|
+
"if TYPE_CHECKING:",
|
|
226
|
+
"raise NotImplementedError",
|
|
227
|
+
]
|
auto3d-3.0.0/setup.cfg
ADDED