Auto3D 3.0.0__tar.gz → 3.1.1__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.
Files changed (224) hide show
  1. {auto3d-3.0.0 → auto3d-3.1.1}/MANIFEST.in +8 -0
  2. auto3d-3.1.1/PKG-INFO +276 -0
  3. auto3d-3.1.1/README.md +216 -0
  4. {auto3d-3.0.0 → auto3d-3.1.1}/pyproject.toml +55 -7
  5. {auto3d-3.0.0 → auto3d-3.1.1}/src/Auto3D/__init__.py +21 -19
  6. auto3d-3.1.1/src/Auto3D/domain/__init__.py +6 -0
  7. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/domain}/clash_relief.py +6 -8
  8. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/domain}/embedding.py +73 -15
  9. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/domain}/filtering.py +25 -18
  10. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/domain}/id_mapping.py +11 -18
  11. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/domain}/ranking.py +116 -65
  12. auto3d-3.1.1/src/Auto3D/engines/__init__.py +6 -0
  13. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/engines}/batch_opt/batchopt.py +95 -61
  14. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/engines}/batch_opt/fire_optimizer.py +4 -5
  15. auto3d-3.1.1/src/Auto3D/engines/batch_opt/model_wrapper.py +336 -0
  16. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/engines}/batch_opt/optimization_engine.py +65 -53
  17. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/engines}/batch_opt/padding.py +7 -16
  18. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/engines}/isomers/__init__.py +6 -5
  19. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/engines}/isomers/base.py +1 -0
  20. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/engines}/isomers/factory.py +34 -21
  21. auto3d-3.1.1/src/Auto3D/engines/isomers/omega.py +209 -0
  22. auto3d-3.1.1/src/Auto3D/engines/isomers/rdkit_sdf.py +177 -0
  23. auto3d-3.1.1/src/Auto3D/engines/isomers/rdkit_smi.py +304 -0
  24. auto3d-3.1.1/src/Auto3D/engines/isomers/tautomers.py +146 -0
  25. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/engines}/model_factory.py +76 -38
  26. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/engines}/models/__init__.py +5 -5
  27. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/engines}/models/adapter.py +206 -67
  28. auto3d-3.0.0/src/Auto3D/batch_opt/ANI2xt_no_rep.py → auto3d-3.1.1/src/Auto3D/engines/models/ani2xt.py +72 -35
  29. auto3d-3.1.1/src/Auto3D/engines/models/availability.py +47 -0
  30. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/engines}/models/contract.py +96 -17
  31. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/engines}/models/loading.py +19 -5
  32. auto3d-3.1.1/src/Auto3D/engines/models/policy.py +142 -0
  33. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/engines}/models/preflight.py +25 -4
  34. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/engines}/models/species.py +49 -46
  35. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/entry}/ASE/geometry.py +26 -26
  36. auto3d-3.1.1/src/Auto3D/entry/ASE/thermo/__init__.py +36 -0
  37. auto3d-3.1.1/src/Auto3D/entry/ASE/thermo/calculator.py +341 -0
  38. auto3d-3.1.1/src/Auto3D/entry/ASE/thermo/driver.py +708 -0
  39. auto3d-3.1.1/src/Auto3D/entry/ASE/thermo/properties.py +338 -0
  40. auto3d-3.1.1/src/Auto3D/entry/ASE/thermo/vibrations.py +546 -0
  41. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/entry}/SPE.py +37 -25
  42. auto3d-3.1.1/src/Auto3D/entry/__init__.py +6 -0
  43. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/entry}/auto3D.py +55 -49
  44. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/entry}/tautomer.py +22 -18
  45. auto3d-3.1.1/src/Auto3D/foundation/__init__.py +6 -0
  46. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/foundation}/config.py +183 -41
  47. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/foundation}/constants.py +5 -4
  48. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/foundation}/exceptions.py +8 -0
  49. auto3d-3.1.1/src/Auto3D/foundation/registry.py +124 -0
  50. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/foundation}/results.py +1 -0
  51. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/foundation}/torch_config.py +4 -2
  52. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/foundation}/utils/__init__.py +4 -4
  53. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/foundation}/utils/atomic_io.py +1 -0
  54. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/foundation}/utils/connectivity.py +4 -1
  55. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/foundation}/utils/convergence.py +32 -3
  56. auto3d-3.1.1/src/Auto3D/foundation/utils/energy.py +371 -0
  57. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/foundation}/utils/geometry.py +4 -3
  58. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/foundation}/utils/logging_config.py +5 -4
  59. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/foundation}/utils/molprops.py +3 -3
  60. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/foundation}/utils/output_guard.py +4 -3
  61. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/foundation}/utils/reconciliation.py +4 -3
  62. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/foundation}/utils/sdf_io.py +6 -5
  63. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/foundation}/utils/smi_io.py +8 -10
  64. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/foundation}/utils/stereo_check.py +17 -16
  65. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/foundation}/utils/stereochemistry.py +9 -16
  66. auto3d-3.1.1/src/Auto3D/orchestration/__init__.py +6 -0
  67. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/orchestration}/chunk_manager.py +6 -4
  68. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/orchestration}/job_layout.py +4 -5
  69. auto3d-3.1.1/src/Auto3D/orchestration/pipeline/__init__.py +7 -0
  70. auto3d-3.0.0/src/Auto3D/utils/validation.py → auto3d-3.1.1/src/Auto3D/orchestration/pipeline/input_checks.py +39 -133
  71. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/orchestration}/processors.py +5 -4
  72. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/orchestration}/workflow.py +48 -40
  73. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/orchestration}/workflow_workers.py +45 -33
  74. auto3d-3.1.1/src/Auto3D/presentation/__init__.py +6 -0
  75. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/presentation}/auto3Dcli.py +15 -14
  76. auto3d-3.1.1/src/Auto3D/presentation/cli/__init__.py +14 -0
  77. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/presentation}/cli/app.py +143 -43
  78. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/presentation}/cli/commands/config.py +29 -32
  79. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/presentation}/cli/commands/models.py +91 -54
  80. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/presentation}/cli/commands/properties.py +103 -44
  81. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/presentation}/cli/commands/run.py +33 -16
  82. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/presentation}/cli/commands/validate.py +41 -43
  83. auto3d-3.1.1/src/Auto3D/presentation/cli/config_schema.py +240 -0
  84. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/presentation}/cli/console.py +6 -4
  85. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/presentation}/cli/errors.py +36 -27
  86. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/presentation}/cli/progress.py +9 -8
  87. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/presentation}/cli/results.py +27 -15
  88. auto3d-3.1.1/src/Auto3D/py.typed +0 -0
  89. auto3d-3.1.1/src/Auto3D.egg-info/PKG-INFO +276 -0
  90. auto3d-3.1.1/src/Auto3D.egg-info/SOURCES.txt +204 -0
  91. auto3d-3.1.1/src/Auto3D.egg-info/entry_points.txt +2 -0
  92. {auto3d-3.0.0 → auto3d-3.1.1}/src/Auto3D.egg-info/requires.txt +2 -1
  93. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_SPE.py +60 -52
  94. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_adapter_atom_mask.py +10 -9
  95. auto3d-3.1.1/tests/test_adapter_fp64_contract.py +118 -0
  96. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_ani2xt_atom_energies.py +13 -15
  97. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_ase_geometry.py +11 -7
  98. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_ase_torch_config.py +7 -2
  99. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_atomic_io.py +10 -12
  100. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_auto3D.py +259 -121
  101. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_auto3Dcli.py +8 -7
  102. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_batchopt.py +119 -51
  103. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_chunk_manager.py +57 -62
  104. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_cli.py +122 -62
  105. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_cli_app.py +223 -133
  106. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_cli_commands_config.py +4 -4
  107. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_cli_config_schema.py +150 -321
  108. auto3d-3.1.1/tests/test_cli_console.py +80 -0
  109. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_cli_errors.py +40 -25
  110. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_cli_exit_codes.py +116 -40
  111. auto3d-3.1.1/tests/test_cli_models_command.py +102 -0
  112. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_cli_property_commands.py +147 -89
  113. auto3d-3.1.1/tests/test_cli_results.py +135 -0
  114. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_cli_security.py +7 -6
  115. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_config.py +151 -118
  116. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_config_parity.py +49 -286
  117. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_conftest_isolation_guards.py +22 -12
  118. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_custom_nnp_contract.py +99 -56
  119. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_custom_nnp_eager.py +7 -6
  120. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_durability.py +106 -130
  121. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_e_tot_units.py +47 -31
  122. auto3d-3.1.1/tests/test_element_sets.py +133 -0
  123. auto3d-3.1.1/tests/test_embed_params.py +100 -0
  124. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_filtering.py +28 -47
  125. auto3d-3.1.1/tests/test_filtering_thermo_failed.py +96 -0
  126. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_fire_optimizer.py +6 -8
  127. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_helpers_pipeline_output.py +21 -41
  128. auto3d-3.1.1/tests/test_hessian_invocation_contract.py +325 -0
  129. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_id_mapping.py +11 -12
  130. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_import_boundaries.py +226 -159
  131. auto3d-3.1.1/tests/test_isomer_engine.py +356 -0
  132. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_isomer_engine_hardening.py +120 -58
  133. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_isomers.py +27 -16
  134. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_job_layout.py +7 -9
  135. auto3d-3.1.1/tests/test_layer_boundaries.py +241 -0
  136. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_lazy_torchani_import.py +6 -5
  137. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_legacy_yaml_parity.py +7 -10
  138. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_logging_config.py +15 -20
  139. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_model_adapter.py +141 -98
  140. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_model_caching.py +3 -2
  141. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_model_factory.py +75 -53
  142. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_model_preflight.py +32 -41
  143. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_model_wrapper.py +7 -7
  144. auto3d-3.1.1/tests/test_mp_start_method.py +110 -0
  145. auto3d-3.1.1/tests/test_no_aimnet.py +122 -0
  146. auto3d-3.1.1/tests/test_notebook_properties.py +121 -0
  147. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_optimization_engine.py +123 -113
  148. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_optimization_engine_indexing.py +133 -67
  149. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_optimization_engine_validation.py +54 -52
  150. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_output_overwrite_gates.py +53 -22
  151. auto3d-3.1.1/tests/test_packaging_metadata.py +199 -0
  152. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_padding.py +9 -9
  153. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_padding_invariance.py +5 -4
  154. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_parallel_embed.py +53 -43
  155. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_pipeline_e2e.py +39 -43
  156. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_processors.py +18 -9
  157. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_progress.py +47 -21
  158. auto3d-3.1.1/tests/test_public_api.py +67 -0
  159. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_ranking.py +237 -192
  160. auto3d-3.1.1/tests/test_ranking_by_gibbs.py +187 -0
  161. auto3d-3.1.1/tests/test_registry.py +108 -0
  162. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_results.py +2 -1
  163. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_sdf_isomer_enumeration.py +21 -18
  164. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_smiles_stereo_warning.py +16 -36
  165. auto3d-3.1.1/tests/test_spe_energy_only.py +480 -0
  166. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_species_conversion.py +21 -26
  167. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_species_module.py +93 -31
  168. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_stereo_identity.py +89 -11
  169. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_stereo_postopt.py +13 -11
  170. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_stereochemistry_validation.py +29 -30
  171. auto3d-3.1.1/tests/test_suite_hygiene.py +121 -0
  172. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_tauto.py +43 -21
  173. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_tautomer_select.py +20 -7
  174. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_tautomer_stereo.py +8 -13
  175. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_thermo.py +135 -111
  176. auto3d-3.1.1/tests/test_thermo_etot_sync.py +146 -0
  177. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_thermo_helpers.py +485 -310
  178. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_thermo_imaginary_mode_inversion.py +96 -67
  179. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_thermo_projection.py +55 -76
  180. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_thermo_record_assertions.py +6 -4
  181. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_thermo_reference.py +14 -20
  182. auto3d-3.1.1/tests/test_thermo_relative_energies.py +360 -0
  183. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_thermo_transition_state.py +19 -36
  184. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_torch_config.py +25 -27
  185. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_utils.py +26 -20
  186. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_utils_connectivity.py +18 -10
  187. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_utils_energy_constants.py +8 -7
  188. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_utils_geometry.py +21 -33
  189. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_utils_molprops.py +14 -5
  190. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_utils_reconciliation.py +13 -23
  191. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_utils_sdf_io.py +9 -15
  192. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_utils_smi_io.py +9 -9
  193. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_utils_stereochemistry.py +37 -43
  194. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_utils_validation.py +25 -25
  195. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_validate_run_parity.py +6 -5
  196. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_validation.py +68 -39
  197. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_validation_errors.py +18 -14
  198. {auto3d-3.0.0 → auto3d-3.1.1}/tests/test_workflow.py +133 -111
  199. auto3d-3.0.0/PKG-INFO +0 -240
  200. auto3d-3.0.0/README.md +0 -181
  201. auto3d-3.0.0/src/Auto3D/.gitignore +0 -18
  202. auto3d-3.0.0/src/Auto3D/ASE/thermo.py +0 -1767
  203. auto3d-3.0.0/src/Auto3D/batch_opt/model_wrapper.py +0 -231
  204. auto3d-3.0.0/src/Auto3D/cli/__init__.py +0 -14
  205. auto3d-3.0.0/src/Auto3D/cli/config_schema.py +0 -435
  206. auto3d-3.0.0/src/Auto3D/isomer_engine.py +0 -763
  207. auto3d-3.0.0/src/Auto3D/utils/energy.py +0 -113
  208. auto3d-3.0.0/src/Auto3D.egg-info/PKG-INFO +0 -240
  209. auto3d-3.0.0/src/Auto3D.egg-info/SOURCES.txt +0 -172
  210. auto3d-3.0.0/src/Auto3D.egg-info/entry_points.txt +0 -2
  211. auto3d-3.0.0/tests/test_cli_console.py +0 -47
  212. auto3d-3.0.0/tests/test_cli_results.py +0 -98
  213. auto3d-3.0.0/tests/test_isomer_engine.py +0 -214
  214. auto3d-3.0.0/tests/test_mp_start_method.py +0 -53
  215. auto3d-3.0.0/tests/test_packaging_metadata.py +0 -105
  216. auto3d-3.0.0/tests/test_public_api.py +0 -37
  217. {auto3d-3.0.0 → auto3d-3.1.1}/LICENSE +0 -0
  218. {auto3d-3.0.0 → auto3d-3.1.1}/setup.cfg +0 -0
  219. {auto3d-3.0.0/src/Auto3D/ASE → auto3d-3.1.1/src/Auto3D/engines/batch_opt}/__init__.py +0 -0
  220. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/engines}/models/ani2xt_no_repulsion.pt +0 -0
  221. {auto3d-3.0.0/src/Auto3D/batch_opt → auto3d-3.1.1/src/Auto3D/entry/ASE}/__init__.py +0 -0
  222. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.1/src/Auto3D/presentation}/cli/commands/__init__.py +0 -0
  223. {auto3d-3.0.0 → auto3d-3.1.1}/src/Auto3D.egg-info/dependency_links.txt +0 -0
  224. {auto3d-3.0.0 → auto3d-3.1.1}/src/Auto3D.egg-info/top_level.txt +0 -0
@@ -9,3 +9,11 @@ graft src/Auto3D
9
9
  # distribution.
10
10
  global-exclude *.py[cod]
11
11
  global-exclude __pycache__/*
12
+
13
+ # `src/Auto3D/.gitignore` is a repository file that `graft` swept into the
14
+ # 3.0.0 wheel (verified against the artifact: entry `Auto3D/.gitignore`). It
15
+ # was the only non-Python payload there besides the bundled ANI2xt weights, and
16
+ # an installed package telling anyone that it ignores `*.sdf` is meaningless at
17
+ # best. It stays in the repo -- it still carries patterns the root .gitignore
18
+ # does not -- it just stops being shipped.
19
+ global-exclude .gitignore
auto3d-3.1.1/PKG-INFO ADDED
@@ -0,0 +1,276 @@
1
+ Metadata-Version: 2.4
2
+ Name: Auto3D
3
+ Version: 3.1.1
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: types-requests; extra == "dev"
50
+ Requires-Dist: ruff==0.15.9; extra == "dev"
51
+ Requires-Dist: pre-commit>=3.0; extra == "dev"
52
+ Provides-Extra: docs
53
+ Requires-Dist: sphinx>=7.0; extra == "docs"
54
+ Requires-Dist: sphinx-rtd-theme>=1.3.0; extra == "docs"
55
+ Requires-Dist: nbsphinx>=0.9.0; extra == "docs"
56
+ Requires-Dist: myst-parser>=2.0; extra == "docs"
57
+ Provides-Extra: all
58
+ Requires-Dist: Auto3D[ani,ase,dev,docs]; extra == "all"
59
+ Dynamic: license-file
60
+
61
+ # **Auto3D**
62
+
63
+ [![PyPI](https://img.shields.io/pypi/v/Auto3D)](https://pypi.org/project/Auto3D/)
64
+ [![PyPI - Downloads](https://img.shields.io/pypi/dm/Auto3D)](https://pypi.org/project/Auto3D/)
65
+ [![Docs](https://img.shields.io/readthedocs/auto3d)](https://auto3d.readthedocs.io/)
66
+ [![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
67
+ [![PyPI - License](https://img.shields.io/pypi/l/Auto3D)](https://github.com/isayevlab/Auto3D_pkg/blob/main/LICENSE)
68
+
69
+ ![auto3d-white](https://github.com/user-attachments/assets/3184d31b-fb21-42d5-a1e0-611ccbf66ad2)
70
+
71
+ **SMILES in, low-energy 3D conformers out.** Auto3D enumerates tautomers and
72
+ stereoisomers, embeds and optimizes them with a neural network potential
73
+ (AIMNet2, ANI2x, ANI2xt), removes duplicates, and ranks what is left by energy —
74
+ in one command, or one function call.
75
+
76
+ ```bash
77
+ pip install Auto3D
78
+ auto3d run molecules.smi --k=1
79
+ ```
80
+
81
+ That writes `molecules_<timestamp>/molecules_out.sdf`: the lowest-energy
82
+ conformer per input molecule, each carrying its energy.
83
+
84
+ ---
85
+
86
+ ## Installation
87
+
88
+ ```bash
89
+ pip install Auto3D # core: AIMNet2 engines
90
+ pip install "Auto3D[ani,ase]" # + torchani (ANI2x/ANI2xt) and ase (thermochemistry)
91
+ ```
92
+
93
+ Requires **Python ≥ 3.11** and **PyTorch ≥ 2.8**. For GPU acceleration, install a
94
+ CUDA-enabled PyTorch build first. AIMNet2 weights download to `~/.cache/aimnet`
95
+ on first use, so the first run needs network access.
96
+
97
+ <details>
98
+ <summary><b>Using conda?</b> Install Auto3D itself with pip, even inside a conda env.</summary>
99
+
100
+ Starting with **3.1.1**, the conda-forge package no longer requires `aimnet`
101
+ (which cannot be packaged for conda-forge — its dependency
102
+ `nvalchemi-toolkit-ops` is pip-only). The conda package ships with the ANI2x
103
+ and ANI2xt engines and ASE thermochemistry working out of the box; add the
104
+ default AIMNet2 engine with one pip command inside the environment:
105
+
106
+ ```bash
107
+ conda install -c conda-forge auto3d # once the 3.1.1 feedstock update lands
108
+ pip install aimnet # adds the AIMNet2 engines
109
+ ```
110
+
111
+ If conda-forge still shows an older version, install with pip inside a conda
112
+ environment instead — `installation.yml` sets up the supported combination:
113
+
114
+ ```bash
115
+ conda env create --file installation.yml --name auto3D
116
+ conda activate auto3D # pip installs Auto3D[ani,ase] into it
117
+ ```
118
+
119
+ Details: [Building the conda package](https://auto3d.readthedocs.io/en/latest/howto/conda_build.html).
120
+
121
+ </details>
122
+
123
+ ## Quick start
124
+
125
+ **Command line**
126
+
127
+ ```bash
128
+ auto3d run molecules.smi --k=5 # top-5 conformers per molecule
129
+ auto3d run molecules.smi --window=3.0 # or everything within 3 kcal/mol
130
+ auto3d run molecules.smi --k=5 --no-gpu # CPU only
131
+ ```
132
+
133
+ Exactly one of `--k` or `--window` is required. GPU is used by default, and
134
+ requesting it with no visible CUDA device is a **fatal error, not a fallback** —
135
+ pass `--no-gpu` on a CPU-only machine.
136
+
137
+ **Python**
138
+
139
+ ```python
140
+ from Auto3D import Auto3DOptions, main
141
+
142
+ config = Auto3DOptions(path="molecules.smi", k=1)
143
+ output_path = main(config)
144
+ ```
145
+
146
+ `main()` returns a `WorkflowResult`, which *is* the output path (it subclasses
147
+ `str`) and also carries `n_molecules`, `n_conformers`, and `failures`.
148
+
149
+ For batches of ≤150 molecules, skip the job directory and get RDKit molecules
150
+ straight back:
151
+
152
+ ```python
153
+ from Auto3D import Auto3DOptions, smiles2mols
154
+
155
+ mols = smiles2mols(["CCO", "CCCO", "c1ccccc1"], Auto3DOptions(k=1, use_gpu=False))
156
+ for mol in mols:
157
+ print(mol.GetProp("_Name"), mol.GetProp("E_tot"), "Hartree")
158
+ ```
159
+
160
+ ## What you get
161
+
162
+ A run creates `<stem>_<timestamp>/` next to the input, containing the output SDF
163
+ and an `Auto3D.log`. Each conformer in the SDF carries:
164
+
165
+ | Property | Meaning |
166
+ |---|---|
167
+ | `E_tot` / `E_tot(Hartree)` | Total energy, Hartree |
168
+ | `E_rel(kcal/mol)` | Energy relative to the best conformer of that molecule |
169
+ | `_Name`, `ID` | Molecule name and a stable identifier |
170
+ | `fmax`, `Converged`, `Dropped_Oscillating` | Optimizer diagnostics |
171
+
172
+ The input SMILES is **not** written to the output — join on `_Name`/`ID` against
173
+ your input file.
174
+
175
+ ## Beyond conformer generation
176
+
177
+ Each of these wraps a Python API function and has a matching notebook in
178
+ [`example/`](example/).
179
+
180
+ | Command | Does | Python API |
181
+ |---|---|---|
182
+ | `auto3d run` | Generate conformers from SMILES/SDF | `main`, `smiles2mols` |
183
+ | `auto3d energy` | Single-point energy for an SDF | `calc_spe` |
184
+ | `auto3d optimize` | Geometry-optimize an existing SDF | `opt_geometry` |
185
+ | `auto3d thermo` | Enthalpy / entropy / Gibbs (needs `ase`) | `calc_thermo` |
186
+ | `auto3d tautomers` | Enumerate and rank stable tautomers | `get_stable_tautomers` |
187
+ | `auto3d validate` | Check an input file without running | — |
188
+ | `auto3d config init\|show\|validate` | Manage YAML configs | — |
189
+ | `auto3d models list\|info\|test` | Inspect and smoke-test engines | — |
190
+
191
+ All commands except `models list` take `-v/--verbose`, the only way to get a
192
+ traceback. `--json` is available on `run`, `validate`, and the four property
193
+ commands. Exit codes: `0` success, `2` config/input error, `4` GPU requested but
194
+ unavailable, `6` partial success, `130` interrupted.
195
+
196
+ ## Engines
197
+
198
+ | Engine | Networks/step | Elements |
199
+ |---|---|---|
200
+ | **AIMNET** (default) | 1 | H, B, C, N, O, F, Si, P, S, Cl, As, Se, Br, I |
201
+ | **aimnet2-2025**, **aimnet2-nse**, **aimnet2-pd**, … | 1 | as above (`aimnet2-pd` swaps As for Pd) |
202
+ | **ANI2x** | 8 (ensemble) | H, C, N, O, F, S, Cl |
203
+ | **ANI2xt** | 1 | H, C, N, O, F, S, Cl |
204
+
205
+ Select with `--engine` or `optimizing_engine`. AIMNet2 models come from the
206
+ [`aimnet`](https://github.com/isayevlab/aimnetcentral) package and are
207
+ sha256-validated on download; `auto3d models list` shows what is available.
208
+ `optimizing_engine` also accepts a path to a
209
+ [custom NNP](https://auto3d.readthedocs.io/en/latest/howto/custom_nnp.html).
210
+
211
+ No engine speed benchmark is maintained in this repository, so the table reports
212
+ how many networks each engine evaluates per step rather than a speed ranking.
213
+ Time your own workload before choosing.
214
+
215
+ ## Key parameters
216
+
217
+ | Parameter | Default | Description |
218
+ |---|---|---|
219
+ | `k` | — | Top-k conformers per molecule |
220
+ | `window` | — | Energy window, kcal/mol — exactly one of `k`/`window` is required |
221
+ | `optimizing_engine` | `AIMNET` | Engine name, registry name, or path to a custom model |
222
+ | `use_gpu` | `True` | GPU acceleration; missing CUDA device is fatal, not a fallback |
223
+ | `gpu_idx` | `0` | CUDA index, or a list for multi-GPU |
224
+ | `enumerate_tautomer` | `False` | Enumerate tautomers |
225
+ | `enumerate_isomer` | `True` | Enumerate stereoisomers |
226
+ | `threshold` | `0.3` | RMSD threshold for duplicate removal, Å |
227
+ | `opt_steps` | `2000` | Maximum optimization steps |
228
+ | `convergence_threshold` | `0.01` | Force convergence threshold, eV/Å |
229
+
230
+ Full list: [CLI reference](https://auto3d.readthedocs.io/en/latest/cli.html) ·
231
+ [API reference](https://auto3d.readthedocs.io/en/latest/api.html)
232
+
233
+ ## Upgrading from 2.x
234
+
235
+ AIMNet2 is now served by the `aimnet` package rather than bundled `.jpt` files,
236
+ and the default AIMNet2 energies differ from 2.x (the registry `.pt` externalizes
237
+ D3 dispersion), so conformer rankings may shift slightly. The thermochemistry SDF
238
+ property `S_hartree` is now `S_hartree_per_K`. Python ≥ 3.11 and PyTorch ≥ 2.8 are
239
+ required. See the [migration guide](https://auto3d.readthedocs.io/en/latest/migration.html).
240
+
241
+ ## Documentation
242
+
243
+ [**auto3d.readthedocs.io**](https://auto3d.readthedocs.io/) ·
244
+ [Installation](https://auto3d.readthedocs.io/en/latest/installation.html) ·
245
+ [Quickstart](https://auto3d.readthedocs.io/en/latest/howto/quickstart.html) ·
246
+ [CLI](https://auto3d.readthedocs.io/en/latest/cli.html) ·
247
+ [API](https://auto3d.readthedocs.io/en/latest/api.html) ·
248
+ [Custom NNPs](https://auto3d.readthedocs.io/en/latest/howto/custom_nnp.html) ·
249
+ [Troubleshooting](https://auto3d.readthedocs.io/en/latest/howto/troubleshooting.html) ·
250
+ [Notebooks](example/)
251
+
252
+ ## Citation
253
+
254
+ ```bibtex
255
+ @article{liu2022auto3d,
256
+ title={Auto3D: Automatic generation of the low-energy 3D structures with ANI neural network potentials},
257
+ author={Liu, Zhen and Zubatiuk, Tetiana and Roitberg, Adrian and Isayev, Olexandr},
258
+ journal={Journal of Chemical Information and Modeling},
259
+ volume={62},
260
+ number={22},
261
+ pages={5373--5382},
262
+ year={2022},
263
+ publisher={ACS Publications},
264
+ doi={10.1021/acs.jcim.2c00817}
265
+ }
266
+ ```
267
+
268
+ ## Contributing
269
+
270
+ [Issues](https://github.com/isayevlab/Auto3D_pkg/issues) ·
271
+ [Discussions](https://github.com/isayevlab/Auto3D_pkg/discussions) ·
272
+ [CONTRIBUTING.md](CONTRIBUTING.md)
273
+
274
+ ## License
275
+
276
+ MIT — see [LICENSE](LICENSE).
auto3d-3.1.1/README.md ADDED
@@ -0,0 +1,216 @@
1
+ # **Auto3D**
2
+
3
+ [![PyPI](https://img.shields.io/pypi/v/Auto3D)](https://pypi.org/project/Auto3D/)
4
+ [![PyPI - Downloads](https://img.shields.io/pypi/dm/Auto3D)](https://pypi.org/project/Auto3D/)
5
+ [![Docs](https://img.shields.io/readthedocs/auto3d)](https://auto3d.readthedocs.io/)
6
+ [![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
7
+ [![PyPI - License](https://img.shields.io/pypi/l/Auto3D)](https://github.com/isayevlab/Auto3D_pkg/blob/main/LICENSE)
8
+
9
+ ![auto3d-white](https://github.com/user-attachments/assets/3184d31b-fb21-42d5-a1e0-611ccbf66ad2)
10
+
11
+ **SMILES in, low-energy 3D conformers out.** Auto3D enumerates tautomers and
12
+ stereoisomers, embeds and optimizes them with a neural network potential
13
+ (AIMNet2, ANI2x, ANI2xt), removes duplicates, and ranks what is left by energy —
14
+ in one command, or one function call.
15
+
16
+ ```bash
17
+ pip install Auto3D
18
+ auto3d run molecules.smi --k=1
19
+ ```
20
+
21
+ That writes `molecules_<timestamp>/molecules_out.sdf`: the lowest-energy
22
+ conformer per input molecule, each carrying its energy.
23
+
24
+ ---
25
+
26
+ ## Installation
27
+
28
+ ```bash
29
+ pip install Auto3D # core: AIMNet2 engines
30
+ pip install "Auto3D[ani,ase]" # + torchani (ANI2x/ANI2xt) and ase (thermochemistry)
31
+ ```
32
+
33
+ Requires **Python ≥ 3.11** and **PyTorch ≥ 2.8**. For GPU acceleration, install a
34
+ CUDA-enabled PyTorch build first. AIMNet2 weights download to `~/.cache/aimnet`
35
+ on first use, so the first run needs network access.
36
+
37
+ <details>
38
+ <summary><b>Using conda?</b> Install Auto3D itself with pip, even inside a conda env.</summary>
39
+
40
+ Starting with **3.1.1**, the conda-forge package no longer requires `aimnet`
41
+ (which cannot be packaged for conda-forge — its dependency
42
+ `nvalchemi-toolkit-ops` is pip-only). The conda package ships with the ANI2x
43
+ and ANI2xt engines and ASE thermochemistry working out of the box; add the
44
+ default AIMNet2 engine with one pip command inside the environment:
45
+
46
+ ```bash
47
+ conda install -c conda-forge auto3d # once the 3.1.1 feedstock update lands
48
+ pip install aimnet # adds the AIMNet2 engines
49
+ ```
50
+
51
+ If conda-forge still shows an older version, install with pip inside a conda
52
+ environment instead — `installation.yml` sets up the supported combination:
53
+
54
+ ```bash
55
+ conda env create --file installation.yml --name auto3D
56
+ conda activate auto3D # pip installs Auto3D[ani,ase] into it
57
+ ```
58
+
59
+ Details: [Building the conda package](https://auto3d.readthedocs.io/en/latest/howto/conda_build.html).
60
+
61
+ </details>
62
+
63
+ ## Quick start
64
+
65
+ **Command line**
66
+
67
+ ```bash
68
+ auto3d run molecules.smi --k=5 # top-5 conformers per molecule
69
+ auto3d run molecules.smi --window=3.0 # or everything within 3 kcal/mol
70
+ auto3d run molecules.smi --k=5 --no-gpu # CPU only
71
+ ```
72
+
73
+ Exactly one of `--k` or `--window` is required. GPU is used by default, and
74
+ requesting it with no visible CUDA device is a **fatal error, not a fallback** —
75
+ pass `--no-gpu` on a CPU-only machine.
76
+
77
+ **Python**
78
+
79
+ ```python
80
+ from Auto3D import Auto3DOptions, main
81
+
82
+ config = Auto3DOptions(path="molecules.smi", k=1)
83
+ output_path = main(config)
84
+ ```
85
+
86
+ `main()` returns a `WorkflowResult`, which *is* the output path (it subclasses
87
+ `str`) and also carries `n_molecules`, `n_conformers`, and `failures`.
88
+
89
+ For batches of ≤150 molecules, skip the job directory and get RDKit molecules
90
+ straight back:
91
+
92
+ ```python
93
+ from Auto3D import Auto3DOptions, smiles2mols
94
+
95
+ mols = smiles2mols(["CCO", "CCCO", "c1ccccc1"], Auto3DOptions(k=1, use_gpu=False))
96
+ for mol in mols:
97
+ print(mol.GetProp("_Name"), mol.GetProp("E_tot"), "Hartree")
98
+ ```
99
+
100
+ ## What you get
101
+
102
+ A run creates `<stem>_<timestamp>/` next to the input, containing the output SDF
103
+ and an `Auto3D.log`. Each conformer in the SDF carries:
104
+
105
+ | Property | Meaning |
106
+ |---|---|
107
+ | `E_tot` / `E_tot(Hartree)` | Total energy, Hartree |
108
+ | `E_rel(kcal/mol)` | Energy relative to the best conformer of that molecule |
109
+ | `_Name`, `ID` | Molecule name and a stable identifier |
110
+ | `fmax`, `Converged`, `Dropped_Oscillating` | Optimizer diagnostics |
111
+
112
+ The input SMILES is **not** written to the output — join on `_Name`/`ID` against
113
+ your input file.
114
+
115
+ ## Beyond conformer generation
116
+
117
+ Each of these wraps a Python API function and has a matching notebook in
118
+ [`example/`](example/).
119
+
120
+ | Command | Does | Python API |
121
+ |---|---|---|
122
+ | `auto3d run` | Generate conformers from SMILES/SDF | `main`, `smiles2mols` |
123
+ | `auto3d energy` | Single-point energy for an SDF | `calc_spe` |
124
+ | `auto3d optimize` | Geometry-optimize an existing SDF | `opt_geometry` |
125
+ | `auto3d thermo` | Enthalpy / entropy / Gibbs (needs `ase`) | `calc_thermo` |
126
+ | `auto3d tautomers` | Enumerate and rank stable tautomers | `get_stable_tautomers` |
127
+ | `auto3d validate` | Check an input file without running | — |
128
+ | `auto3d config init\|show\|validate` | Manage YAML configs | — |
129
+ | `auto3d models list\|info\|test` | Inspect and smoke-test engines | — |
130
+
131
+ All commands except `models list` take `-v/--verbose`, the only way to get a
132
+ traceback. `--json` is available on `run`, `validate`, and the four property
133
+ commands. Exit codes: `0` success, `2` config/input error, `4` GPU requested but
134
+ unavailable, `6` partial success, `130` interrupted.
135
+
136
+ ## Engines
137
+
138
+ | Engine | Networks/step | Elements |
139
+ |---|---|---|
140
+ | **AIMNET** (default) | 1 | H, B, C, N, O, F, Si, P, S, Cl, As, Se, Br, I |
141
+ | **aimnet2-2025**, **aimnet2-nse**, **aimnet2-pd**, … | 1 | as above (`aimnet2-pd` swaps As for Pd) |
142
+ | **ANI2x** | 8 (ensemble) | H, C, N, O, F, S, Cl |
143
+ | **ANI2xt** | 1 | H, C, N, O, F, S, Cl |
144
+
145
+ Select with `--engine` or `optimizing_engine`. AIMNet2 models come from the
146
+ [`aimnet`](https://github.com/isayevlab/aimnetcentral) package and are
147
+ sha256-validated on download; `auto3d models list` shows what is available.
148
+ `optimizing_engine` also accepts a path to a
149
+ [custom NNP](https://auto3d.readthedocs.io/en/latest/howto/custom_nnp.html).
150
+
151
+ No engine speed benchmark is maintained in this repository, so the table reports
152
+ how many networks each engine evaluates per step rather than a speed ranking.
153
+ Time your own workload before choosing.
154
+
155
+ ## Key parameters
156
+
157
+ | Parameter | Default | Description |
158
+ |---|---|---|
159
+ | `k` | — | Top-k conformers per molecule |
160
+ | `window` | — | Energy window, kcal/mol — exactly one of `k`/`window` is required |
161
+ | `optimizing_engine` | `AIMNET` | Engine name, registry name, or path to a custom model |
162
+ | `use_gpu` | `True` | GPU acceleration; missing CUDA device is fatal, not a fallback |
163
+ | `gpu_idx` | `0` | CUDA index, or a list for multi-GPU |
164
+ | `enumerate_tautomer` | `False` | Enumerate tautomers |
165
+ | `enumerate_isomer` | `True` | Enumerate stereoisomers |
166
+ | `threshold` | `0.3` | RMSD threshold for duplicate removal, Å |
167
+ | `opt_steps` | `2000` | Maximum optimization steps |
168
+ | `convergence_threshold` | `0.01` | Force convergence threshold, eV/Å |
169
+
170
+ Full list: [CLI reference](https://auto3d.readthedocs.io/en/latest/cli.html) ·
171
+ [API reference](https://auto3d.readthedocs.io/en/latest/api.html)
172
+
173
+ ## Upgrading from 2.x
174
+
175
+ AIMNet2 is now served by the `aimnet` package rather than bundled `.jpt` files,
176
+ and the default AIMNet2 energies differ from 2.x (the registry `.pt` externalizes
177
+ D3 dispersion), so conformer rankings may shift slightly. The thermochemistry SDF
178
+ property `S_hartree` is now `S_hartree_per_K`. Python ≥ 3.11 and PyTorch ≥ 2.8 are
179
+ required. See the [migration guide](https://auto3d.readthedocs.io/en/latest/migration.html).
180
+
181
+ ## Documentation
182
+
183
+ [**auto3d.readthedocs.io**](https://auto3d.readthedocs.io/) ·
184
+ [Installation](https://auto3d.readthedocs.io/en/latest/installation.html) ·
185
+ [Quickstart](https://auto3d.readthedocs.io/en/latest/howto/quickstart.html) ·
186
+ [CLI](https://auto3d.readthedocs.io/en/latest/cli.html) ·
187
+ [API](https://auto3d.readthedocs.io/en/latest/api.html) ·
188
+ [Custom NNPs](https://auto3d.readthedocs.io/en/latest/howto/custom_nnp.html) ·
189
+ [Troubleshooting](https://auto3d.readthedocs.io/en/latest/howto/troubleshooting.html) ·
190
+ [Notebooks](example/)
191
+
192
+ ## Citation
193
+
194
+ ```bibtex
195
+ @article{liu2022auto3d,
196
+ title={Auto3D: Automatic generation of the low-energy 3D structures with ANI neural network potentials},
197
+ author={Liu, Zhen and Zubatiuk, Tetiana and Roitberg, Adrian and Isayev, Olexandr},
198
+ journal={Journal of Chemical Information and Modeling},
199
+ volume={62},
200
+ number={22},
201
+ pages={5373--5382},
202
+ year={2022},
203
+ publisher={ACS Publications},
204
+ doi={10.1021/acs.jcim.2c00817}
205
+ }
206
+ ```
207
+
208
+ ## Contributing
209
+
210
+ [Issues](https://github.com/isayevlab/Auto3D_pkg/issues) ·
211
+ [Discussions](https://github.com/isayevlab/Auto3D_pkg/discussions) ·
212
+ [CONTRIBUTING.md](CONTRIBUTING.md)
213
+
214
+ ## License
215
+
216
+ MIT — see [LICENSE](LICENSE).
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "Auto3D"
7
- version = "3.0.0"
7
+ version = "3.1.1"
8
8
  description = "Generating Low-energy 3D Conformers from SMILES/SDF"
9
9
  readme = "README.md"
10
10
  license = {text = "MIT"}
@@ -61,7 +61,7 @@ ani = [
61
61
  ]
62
62
  ase = [
63
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.
64
+ # and Auto3D.entry.ASE.thermo passes it -- on 3.22.1 that call raises TypeError.
65
65
  # 3.22.1 also slices the last 3N-6 of the input list without sorting it
66
66
  # first, a third distinct mode-selection semantics. Verified against the
67
67
  # 3.22.1 and 3.23.0 wheels.
@@ -71,7 +71,15 @@ dev = [
71
71
  "pytest>=7.0",
72
72
  "pytest-cov>=4.0",
73
73
  "mypy>=1.0",
74
- "ruff>=0.1.0",
74
+ # requests ships no inline types; without the stubs mypy reports
75
+ # `import-untyped` at models/preflight.py's download path.
76
+ "types-requests",
77
+ # Pinned, not floored, and kept identical to the version the `lint` CI job
78
+ # installs. `ruff format` is a gate now, and a range lets a contributor
79
+ # format with one style while CI checks against another -- the failure would
80
+ # arrive as a red build on a diff that never touched the offending lines.
81
+ # `>=0.1.0` was the old floor, spanning every formatting style ruff has had.
82
+ "ruff==0.15.9",
75
83
  "pre-commit>=3.0",
76
84
  ]
77
85
  docs = [
@@ -85,7 +93,7 @@ all = [
85
93
  ]
86
94
 
87
95
  [project.scripts]
88
- auto3d = "Auto3D.auto3Dcli:cli"
96
+ auto3d = "Auto3D.presentation.auto3Dcli:cli"
89
97
 
90
98
  [project.urls]
91
99
  Homepage = "https://github.com/isayevlab/Auto3D_pkg"
@@ -98,7 +106,10 @@ Changelog = "https://github.com/isayevlab/Auto3D_pkg/releases"
98
106
  where = ["src"]
99
107
 
100
108
  [tool.setuptools.package-data]
101
- Auto3D = ["models/*.pt"]
109
+ # `py.typed` backs the `Typing :: Typed` classifier: without the marker file
110
+ # PEP 561 tells a downstream checker to treat every name here as `Any`, so the
111
+ # annotations exist but nobody outside can see them.
112
+ Auto3D = ["engines/models/*.pt", "py.typed"]
102
113
 
103
114
  [tool.ruff]
104
115
  line-length = 100
@@ -158,8 +169,13 @@ ignore = [
158
169
  # class's test, and a vacuous `assert ... or True` that could never fail.
159
170
  # Both were fixed at the source instead (see git history), and both codes
160
171
  # stay enabled for tests/ so a regression here is caught by lint again.
172
+ #
173
+ # I001 (unsorted imports) was also on this list, excused as "reordering would
174
+ # touch most test files". That was the same objection as the unformatted tree,
175
+ # and it expired with it: once `ruff format` had been run over all 176 files in
176
+ # one commit, sorting 34 files' imports was no longer the disruptive change it
177
+ # had been the argument against. The code is enabled for tests/ again.
161
178
  "tests/*" = [
162
- "I001", # unsorted imports -- reordering would touch most test files
163
179
  "F401", # unused imports (legacy test scaffolding, e.g. optional-dep guards)
164
180
  "E712", # `== True`/`== False` comparisons (common in older tests)
165
181
  "E702", # multiple statements on one line (semicolons in legacy tests)
@@ -178,8 +194,40 @@ ignore = [
178
194
  [tool.ruff.lint.isort]
179
195
  known-first-party = ["Auto3D"]
180
196
 
197
+ # Every value here is a ruff default. They are written down anyway, because the
198
+ # formatter is a gate now (`ruff format --check` in the `lint` CI job) and a gate
199
+ # whose behavior lives in someone else's defaults moves when that someone else
200
+ # ships a release. Pinning them makes a reformat land when *we* change this
201
+ # section, not when ruff changes its mind.
202
+ #
203
+ # `docstring-code-format` stays off deliberately: many docstrings here carry
204
+ # illustrative snippets that are not valid standalone Python (elided bodies,
205
+ # `...` continuations), and formatting them is a silent rewrite of documentation
206
+ # that no test covers.
207
+ [tool.ruff.format]
208
+ quote-style = "double"
209
+ indent-style = "space"
210
+ line-ending = "lf"
211
+ skip-magic-trailing-comma = false
212
+ docstring-code-format = false
213
+
181
214
  [tool.mypy]
182
- python_version = "3.11"
215
+ # Deliberately no `python_version`. Setting it to the declared floor ("3.11")
216
+ # would be the obvious choice, and it does not work: mypy applies that version
217
+ # when parsing the *source and stubs of typed third-party packages*, and numpy
218
+ # ships stubs using 3.12 `type` statements. That is a `[syntax]` error, which is
219
+ # fatal -- mypy stops with "errors prevented further checking" before analysing
220
+ # a single Auto3D module, reports one error that is not in this package, and
221
+ # looks like a pass.
222
+ #
223
+ # It is environment-specific in which package trips first, which is the trap:
224
+ # a skip-list of offenders (`tifffile`, `sphinx` on one dev box) looked like a
225
+ # fix locally and left CI aborting on numpy, a core dependency, where excluding
226
+ # it would have thrown away the array types worth checking in the first place.
227
+ #
228
+ # So mypy uses the running interpreter's semantics. The cost is that a 3.12-only
229
+ # construct in our own code would not be flagged here; the tests still run on
230
+ # 3.11 in CI, and the typecheck step is pinned to a 3.12 job.
183
231
  warn_return_any = true
184
232
  warn_unused_configs = true
185
233
  ignore_missing_imports = true