Auto3D 3.0.0__tar.gz → 3.1.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.
Files changed (222) hide show
  1. {auto3d-3.0.0 → auto3d-3.1.0}/MANIFEST.in +8 -0
  2. auto3d-3.1.0/PKG-INFO +271 -0
  3. auto3d-3.1.0/README.md +211 -0
  4. {auto3d-3.0.0 → auto3d-3.1.0}/pyproject.toml +55 -7
  5. {auto3d-3.0.0 → auto3d-3.1.0}/src/Auto3D/__init__.py +21 -19
  6. auto3d-3.1.0/src/Auto3D/domain/__init__.py +6 -0
  7. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/domain}/clash_relief.py +6 -8
  8. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/domain}/embedding.py +73 -15
  9. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/domain}/filtering.py +25 -18
  10. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/domain}/id_mapping.py +11 -18
  11. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/domain}/ranking.py +116 -65
  12. auto3d-3.1.0/src/Auto3D/engines/__init__.py +6 -0
  13. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/engines}/batch_opt/batchopt.py +95 -61
  14. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/engines}/batch_opt/fire_optimizer.py +4 -5
  15. auto3d-3.1.0/src/Auto3D/engines/batch_opt/model_wrapper.py +336 -0
  16. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/engines}/batch_opt/optimization_engine.py +65 -53
  17. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/engines}/batch_opt/padding.py +7 -16
  18. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/engines}/isomers/__init__.py +6 -5
  19. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/engines}/isomers/base.py +1 -0
  20. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/engines}/isomers/factory.py +34 -21
  21. auto3d-3.1.0/src/Auto3D/engines/isomers/omega.py +209 -0
  22. auto3d-3.1.0/src/Auto3D/engines/isomers/rdkit_sdf.py +177 -0
  23. auto3d-3.1.0/src/Auto3D/engines/isomers/rdkit_smi.py +304 -0
  24. auto3d-3.1.0/src/Auto3D/engines/isomers/tautomers.py +146 -0
  25. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/engines}/model_factory.py +76 -38
  26. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/engines}/models/__init__.py +5 -5
  27. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/engines}/models/adapter.py +201 -67
  28. auto3d-3.0.0/src/Auto3D/batch_opt/ANI2xt_no_rep.py → auto3d-3.1.0/src/Auto3D/engines/models/ani2xt.py +72 -35
  29. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/engines}/models/contract.py +96 -17
  30. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/engines}/models/loading.py +19 -5
  31. auto3d-3.1.0/src/Auto3D/engines/models/policy.py +142 -0
  32. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/engines}/models/preflight.py +10 -4
  33. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/engines}/models/species.py +49 -46
  34. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/entry}/ASE/geometry.py +26 -26
  35. auto3d-3.1.0/src/Auto3D/entry/ASE/thermo/__init__.py +36 -0
  36. auto3d-3.1.0/src/Auto3D/entry/ASE/thermo/calculator.py +341 -0
  37. auto3d-3.1.0/src/Auto3D/entry/ASE/thermo/driver.py +708 -0
  38. auto3d-3.1.0/src/Auto3D/entry/ASE/thermo/properties.py +338 -0
  39. auto3d-3.1.0/src/Auto3D/entry/ASE/thermo/vibrations.py +546 -0
  40. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/entry}/SPE.py +37 -25
  41. auto3d-3.1.0/src/Auto3D/entry/__init__.py +6 -0
  42. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/entry}/auto3D.py +55 -49
  43. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/entry}/tautomer.py +22 -18
  44. auto3d-3.1.0/src/Auto3D/foundation/__init__.py +6 -0
  45. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/foundation}/config.py +183 -41
  46. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/foundation}/constants.py +5 -4
  47. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/foundation}/exceptions.py +8 -0
  48. auto3d-3.1.0/src/Auto3D/foundation/registry.py +124 -0
  49. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/foundation}/results.py +1 -0
  50. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/foundation}/torch_config.py +4 -2
  51. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/foundation}/utils/__init__.py +4 -4
  52. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/foundation}/utils/atomic_io.py +1 -0
  53. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/foundation}/utils/connectivity.py +4 -1
  54. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/foundation}/utils/convergence.py +32 -3
  55. auto3d-3.1.0/src/Auto3D/foundation/utils/energy.py +371 -0
  56. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/foundation}/utils/geometry.py +4 -3
  57. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/foundation}/utils/logging_config.py +5 -4
  58. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/foundation}/utils/molprops.py +3 -3
  59. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/foundation}/utils/output_guard.py +4 -3
  60. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/foundation}/utils/reconciliation.py +4 -3
  61. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/foundation}/utils/sdf_io.py +6 -5
  62. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/foundation}/utils/smi_io.py +8 -10
  63. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/foundation}/utils/stereo_check.py +17 -16
  64. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/foundation}/utils/stereochemistry.py +9 -16
  65. auto3d-3.1.0/src/Auto3D/orchestration/__init__.py +6 -0
  66. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/orchestration}/chunk_manager.py +6 -4
  67. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/orchestration}/job_layout.py +4 -5
  68. auto3d-3.1.0/src/Auto3D/orchestration/pipeline/__init__.py +7 -0
  69. auto3d-3.0.0/src/Auto3D/utils/validation.py → auto3d-3.1.0/src/Auto3D/orchestration/pipeline/input_checks.py +39 -133
  70. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/orchestration}/processors.py +5 -4
  71. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/orchestration}/workflow.py +48 -40
  72. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/orchestration}/workflow_workers.py +45 -33
  73. auto3d-3.1.0/src/Auto3D/presentation/__init__.py +6 -0
  74. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/presentation}/auto3Dcli.py +15 -14
  75. auto3d-3.1.0/src/Auto3D/presentation/cli/__init__.py +14 -0
  76. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/presentation}/cli/app.py +143 -43
  77. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/presentation}/cli/commands/config.py +29 -32
  78. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/presentation}/cli/commands/models.py +91 -54
  79. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/presentation}/cli/commands/properties.py +103 -44
  80. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/presentation}/cli/commands/run.py +33 -16
  81. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/presentation}/cli/commands/validate.py +41 -43
  82. auto3d-3.1.0/src/Auto3D/presentation/cli/config_schema.py +240 -0
  83. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/presentation}/cli/console.py +6 -4
  84. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/presentation}/cli/errors.py +35 -27
  85. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/presentation}/cli/progress.py +9 -8
  86. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/presentation}/cli/results.py +27 -15
  87. auto3d-3.1.0/src/Auto3D/py.typed +0 -0
  88. auto3d-3.1.0/src/Auto3D.egg-info/PKG-INFO +271 -0
  89. auto3d-3.1.0/src/Auto3D.egg-info/SOURCES.txt +202 -0
  90. auto3d-3.1.0/src/Auto3D.egg-info/entry_points.txt +2 -0
  91. {auto3d-3.0.0 → auto3d-3.1.0}/src/Auto3D.egg-info/requires.txt +2 -1
  92. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_SPE.py +60 -52
  93. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_adapter_atom_mask.py +10 -9
  94. auto3d-3.1.0/tests/test_adapter_fp64_contract.py +118 -0
  95. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_ani2xt_atom_energies.py +13 -15
  96. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_ase_geometry.py +11 -7
  97. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_ase_torch_config.py +7 -2
  98. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_atomic_io.py +10 -12
  99. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_auto3D.py +259 -121
  100. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_auto3Dcli.py +8 -7
  101. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_batchopt.py +119 -51
  102. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_chunk_manager.py +57 -62
  103. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_cli.py +122 -62
  104. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_cli_app.py +202 -133
  105. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_cli_commands_config.py +4 -4
  106. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_cli_config_schema.py +150 -321
  107. auto3d-3.1.0/tests/test_cli_console.py +80 -0
  108. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_cli_errors.py +27 -25
  109. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_cli_exit_codes.py +62 -40
  110. auto3d-3.1.0/tests/test_cli_models_command.py +102 -0
  111. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_cli_property_commands.py +147 -89
  112. auto3d-3.1.0/tests/test_cli_results.py +135 -0
  113. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_cli_security.py +7 -6
  114. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_config.py +151 -118
  115. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_config_parity.py +49 -286
  116. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_conftest_isolation_guards.py +22 -12
  117. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_custom_nnp_contract.py +99 -56
  118. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_custom_nnp_eager.py +7 -6
  119. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_durability.py +106 -130
  120. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_e_tot_units.py +47 -31
  121. auto3d-3.1.0/tests/test_element_sets.py +133 -0
  122. auto3d-3.1.0/tests/test_embed_params.py +100 -0
  123. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_filtering.py +28 -47
  124. auto3d-3.1.0/tests/test_filtering_thermo_failed.py +96 -0
  125. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_fire_optimizer.py +6 -8
  126. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_helpers_pipeline_output.py +21 -41
  127. auto3d-3.1.0/tests/test_hessian_invocation_contract.py +325 -0
  128. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_id_mapping.py +11 -12
  129. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_import_boundaries.py +226 -159
  130. auto3d-3.1.0/tests/test_isomer_engine.py +356 -0
  131. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_isomer_engine_hardening.py +120 -58
  132. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_isomers.py +27 -16
  133. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_job_layout.py +7 -9
  134. auto3d-3.1.0/tests/test_layer_boundaries.py +241 -0
  135. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_lazy_torchani_import.py +6 -5
  136. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_legacy_yaml_parity.py +7 -10
  137. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_logging_config.py +15 -20
  138. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_model_adapter.py +141 -98
  139. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_model_caching.py +3 -2
  140. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_model_factory.py +75 -53
  141. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_model_preflight.py +32 -41
  142. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_model_wrapper.py +7 -7
  143. auto3d-3.1.0/tests/test_mp_start_method.py +110 -0
  144. auto3d-3.1.0/tests/test_notebook_properties.py +121 -0
  145. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_optimization_engine.py +123 -113
  146. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_optimization_engine_indexing.py +133 -67
  147. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_optimization_engine_validation.py +54 -52
  148. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_output_overwrite_gates.py +53 -22
  149. auto3d-3.1.0/tests/test_packaging_metadata.py +199 -0
  150. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_padding.py +9 -9
  151. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_padding_invariance.py +5 -4
  152. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_parallel_embed.py +53 -43
  153. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_pipeline_e2e.py +39 -43
  154. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_processors.py +18 -9
  155. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_progress.py +47 -21
  156. auto3d-3.1.0/tests/test_public_api.py +67 -0
  157. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_ranking.py +237 -192
  158. auto3d-3.1.0/tests/test_ranking_by_gibbs.py +187 -0
  159. auto3d-3.1.0/tests/test_registry.py +108 -0
  160. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_results.py +2 -1
  161. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_sdf_isomer_enumeration.py +21 -18
  162. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_smiles_stereo_warning.py +16 -36
  163. auto3d-3.1.0/tests/test_spe_energy_only.py +480 -0
  164. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_species_conversion.py +21 -26
  165. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_species_module.py +93 -31
  166. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_stereo_identity.py +89 -11
  167. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_stereo_postopt.py +13 -11
  168. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_stereochemistry_validation.py +29 -30
  169. auto3d-3.1.0/tests/test_suite_hygiene.py +121 -0
  170. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_tauto.py +43 -21
  171. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_tautomer_select.py +20 -7
  172. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_tautomer_stereo.py +8 -13
  173. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_thermo.py +135 -111
  174. auto3d-3.1.0/tests/test_thermo_etot_sync.py +146 -0
  175. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_thermo_helpers.py +485 -310
  176. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_thermo_imaginary_mode_inversion.py +96 -67
  177. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_thermo_projection.py +55 -76
  178. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_thermo_record_assertions.py +6 -4
  179. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_thermo_reference.py +14 -20
  180. auto3d-3.1.0/tests/test_thermo_relative_energies.py +360 -0
  181. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_thermo_transition_state.py +19 -36
  182. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_torch_config.py +25 -27
  183. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_utils.py +26 -20
  184. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_utils_connectivity.py +18 -10
  185. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_utils_energy_constants.py +8 -7
  186. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_utils_geometry.py +21 -33
  187. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_utils_molprops.py +14 -5
  188. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_utils_reconciliation.py +13 -23
  189. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_utils_sdf_io.py +9 -15
  190. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_utils_smi_io.py +9 -9
  191. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_utils_stereochemistry.py +37 -43
  192. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_utils_validation.py +25 -25
  193. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_validate_run_parity.py +6 -5
  194. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_validation.py +68 -39
  195. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_validation_errors.py +18 -14
  196. {auto3d-3.0.0 → auto3d-3.1.0}/tests/test_workflow.py +133 -111
  197. auto3d-3.0.0/PKG-INFO +0 -240
  198. auto3d-3.0.0/README.md +0 -181
  199. auto3d-3.0.0/src/Auto3D/.gitignore +0 -18
  200. auto3d-3.0.0/src/Auto3D/ASE/thermo.py +0 -1767
  201. auto3d-3.0.0/src/Auto3D/batch_opt/model_wrapper.py +0 -231
  202. auto3d-3.0.0/src/Auto3D/cli/__init__.py +0 -14
  203. auto3d-3.0.0/src/Auto3D/cli/config_schema.py +0 -435
  204. auto3d-3.0.0/src/Auto3D/isomer_engine.py +0 -763
  205. auto3d-3.0.0/src/Auto3D/utils/energy.py +0 -113
  206. auto3d-3.0.0/src/Auto3D.egg-info/PKG-INFO +0 -240
  207. auto3d-3.0.0/src/Auto3D.egg-info/SOURCES.txt +0 -172
  208. auto3d-3.0.0/src/Auto3D.egg-info/entry_points.txt +0 -2
  209. auto3d-3.0.0/tests/test_cli_console.py +0 -47
  210. auto3d-3.0.0/tests/test_cli_results.py +0 -98
  211. auto3d-3.0.0/tests/test_isomer_engine.py +0 -214
  212. auto3d-3.0.0/tests/test_mp_start_method.py +0 -53
  213. auto3d-3.0.0/tests/test_packaging_metadata.py +0 -105
  214. auto3d-3.0.0/tests/test_public_api.py +0 -37
  215. {auto3d-3.0.0 → auto3d-3.1.0}/LICENSE +0 -0
  216. {auto3d-3.0.0 → auto3d-3.1.0}/setup.cfg +0 -0
  217. {auto3d-3.0.0/src/Auto3D/ASE → auto3d-3.1.0/src/Auto3D/engines/batch_opt}/__init__.py +0 -0
  218. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/engines}/models/ani2xt_no_repulsion.pt +0 -0
  219. {auto3d-3.0.0/src/Auto3D/batch_opt → auto3d-3.1.0/src/Auto3D/entry/ASE}/__init__.py +0 -0
  220. {auto3d-3.0.0/src/Auto3D → auto3d-3.1.0/src/Auto3D/presentation}/cli/commands/__init__.py +0 -0
  221. {auto3d-3.0.0 → auto3d-3.1.0}/src/Auto3D.egg-info/dependency_links.txt +0 -0
  222. {auto3d-3.0.0 → auto3d-3.1.0}/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.0/PKG-INFO ADDED
@@ -0,0 +1,271 @@
1
+ Metadata-Version: 2.4
2
+ Name: Auto3D
3
+ Version: 3.1.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: 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
+ <br>
101
+
102
+ `conda install -c conda-forge auto3d` installs **2.3.0**, not 3.1.0. conda-forge
103
+ requires every dependency to be a conda package, and `aimnet` — a core dependency
104
+ since 3.0.0 — is not one yet, nor is its own dependency `nvalchemi-toolkit-ops`.
105
+
106
+ Auto3D works fine *inside* a conda environment; it is only the conda **package**
107
+ that lags. `installation.yml` sets up the supported combination:
108
+
109
+ ```bash
110
+ conda env create --file installation.yml --name auto3D
111
+ conda activate auto3D # pip installs Auto3D[ani,ase] into it
112
+ ```
113
+
114
+ Details and the path forward: [Building the conda package](https://auto3d.readthedocs.io/en/latest/howto/conda_build.html).
115
+
116
+ </details>
117
+
118
+ ## Quick start
119
+
120
+ **Command line**
121
+
122
+ ```bash
123
+ auto3d run molecules.smi --k=5 # top-5 conformers per molecule
124
+ auto3d run molecules.smi --window=3.0 # or everything within 3 kcal/mol
125
+ auto3d run molecules.smi --k=5 --no-gpu # CPU only
126
+ ```
127
+
128
+ Exactly one of `--k` or `--window` is required. GPU is used by default, and
129
+ requesting it with no visible CUDA device is a **fatal error, not a fallback** —
130
+ pass `--no-gpu` on a CPU-only machine.
131
+
132
+ **Python**
133
+
134
+ ```python
135
+ from Auto3D import Auto3DOptions, main
136
+
137
+ config = Auto3DOptions(path="molecules.smi", k=1)
138
+ output_path = main(config)
139
+ ```
140
+
141
+ `main()` returns a `WorkflowResult`, which *is* the output path (it subclasses
142
+ `str`) and also carries `n_molecules`, `n_conformers`, and `failures`.
143
+
144
+ For batches of ≤150 molecules, skip the job directory and get RDKit molecules
145
+ straight back:
146
+
147
+ ```python
148
+ from Auto3D import Auto3DOptions, smiles2mols
149
+
150
+ mols = smiles2mols(["CCO", "CCCO", "c1ccccc1"], Auto3DOptions(k=1, use_gpu=False))
151
+ for mol in mols:
152
+ print(mol.GetProp("_Name"), mol.GetProp("E_tot"), "Hartree")
153
+ ```
154
+
155
+ ## What you get
156
+
157
+ A run creates `<stem>_<timestamp>/` next to the input, containing the output SDF
158
+ and an `Auto3D.log`. Each conformer in the SDF carries:
159
+
160
+ | Property | Meaning |
161
+ |---|---|
162
+ | `E_tot` / `E_tot(Hartree)` | Total energy, Hartree |
163
+ | `E_rel(kcal/mol)` | Energy relative to the best conformer of that molecule |
164
+ | `_Name`, `ID` | Molecule name and a stable identifier |
165
+ | `fmax`, `Converged`, `Dropped_Oscillating` | Optimizer diagnostics |
166
+
167
+ The input SMILES is **not** written to the output — join on `_Name`/`ID` against
168
+ your input file.
169
+
170
+ ## Beyond conformer generation
171
+
172
+ Each of these wraps a Python API function and has a matching notebook in
173
+ [`example/`](example/).
174
+
175
+ | Command | Does | Python API |
176
+ |---|---|---|
177
+ | `auto3d run` | Generate conformers from SMILES/SDF | `main`, `smiles2mols` |
178
+ | `auto3d energy` | Single-point energy for an SDF | `calc_spe` |
179
+ | `auto3d optimize` | Geometry-optimize an existing SDF | `opt_geometry` |
180
+ | `auto3d thermo` | Enthalpy / entropy / Gibbs (needs `ase`) | `calc_thermo` |
181
+ | `auto3d tautomers` | Enumerate and rank stable tautomers | `get_stable_tautomers` |
182
+ | `auto3d validate` | Check an input file without running | — |
183
+ | `auto3d config init\|show\|validate` | Manage YAML configs | — |
184
+ | `auto3d models list\|info\|test` | Inspect and smoke-test engines | — |
185
+
186
+ All commands except `models list` take `-v/--verbose`, the only way to get a
187
+ traceback. `--json` is available on `run`, `validate`, and the four property
188
+ commands. Exit codes: `0` success, `2` config/input error, `4` GPU requested but
189
+ unavailable, `6` partial success, `130` interrupted.
190
+
191
+ ## Engines
192
+
193
+ | Engine | Networks/step | Elements |
194
+ |---|---|---|
195
+ | **AIMNET** (default) | 1 | H, B, C, N, O, F, Si, P, S, Cl, As, Se, Br, I |
196
+ | **aimnet2-2025**, **aimnet2-nse**, **aimnet2-pd**, … | 1 | as above (`aimnet2-pd` swaps As for Pd) |
197
+ | **ANI2x** | 8 (ensemble) | H, C, N, O, F, S, Cl |
198
+ | **ANI2xt** | 1 | H, C, N, O, F, S, Cl |
199
+
200
+ Select with `--engine` or `optimizing_engine`. AIMNet2 models come from the
201
+ [`aimnet`](https://github.com/isayevlab/aimnetcentral) package and are
202
+ sha256-validated on download; `auto3d models list` shows what is available.
203
+ `optimizing_engine` also accepts a path to a
204
+ [custom NNP](https://auto3d.readthedocs.io/en/latest/howto/custom_nnp.html).
205
+
206
+ No engine speed benchmark is maintained in this repository, so the table reports
207
+ how many networks each engine evaluates per step rather than a speed ranking.
208
+ Time your own workload before choosing.
209
+
210
+ ## Key parameters
211
+
212
+ | Parameter | Default | Description |
213
+ |---|---|---|
214
+ | `k` | — | Top-k conformers per molecule |
215
+ | `window` | — | Energy window, kcal/mol — exactly one of `k`/`window` is required |
216
+ | `optimizing_engine` | `AIMNET` | Engine name, registry name, or path to a custom model |
217
+ | `use_gpu` | `True` | GPU acceleration; missing CUDA device is fatal, not a fallback |
218
+ | `gpu_idx` | `0` | CUDA index, or a list for multi-GPU |
219
+ | `enumerate_tautomer` | `False` | Enumerate tautomers |
220
+ | `enumerate_isomer` | `True` | Enumerate stereoisomers |
221
+ | `threshold` | `0.3` | RMSD threshold for duplicate removal, Å |
222
+ | `opt_steps` | `2000` | Maximum optimization steps |
223
+ | `convergence_threshold` | `0.01` | Force convergence threshold, eV/Å |
224
+
225
+ Full list: [CLI reference](https://auto3d.readthedocs.io/en/latest/cli.html) ·
226
+ [API reference](https://auto3d.readthedocs.io/en/latest/api.html)
227
+
228
+ ## Upgrading from 2.x
229
+
230
+ AIMNet2 is now served by the `aimnet` package rather than bundled `.jpt` files,
231
+ and the default AIMNet2 energies differ from 2.x (the registry `.pt` externalizes
232
+ D3 dispersion), so conformer rankings may shift slightly. The thermochemistry SDF
233
+ property `S_hartree` is now `S_hartree_per_K`. Python ≥ 3.11 and PyTorch ≥ 2.8 are
234
+ required. See the [migration guide](https://auto3d.readthedocs.io/en/latest/migration.html).
235
+
236
+ ## Documentation
237
+
238
+ [**auto3d.readthedocs.io**](https://auto3d.readthedocs.io/) ·
239
+ [Installation](https://auto3d.readthedocs.io/en/latest/installation.html) ·
240
+ [Quickstart](https://auto3d.readthedocs.io/en/latest/howto/quickstart.html) ·
241
+ [CLI](https://auto3d.readthedocs.io/en/latest/cli.html) ·
242
+ [API](https://auto3d.readthedocs.io/en/latest/api.html) ·
243
+ [Custom NNPs](https://auto3d.readthedocs.io/en/latest/howto/custom_nnp.html) ·
244
+ [Troubleshooting](https://auto3d.readthedocs.io/en/latest/howto/troubleshooting.html) ·
245
+ [Notebooks](example/)
246
+
247
+ ## Citation
248
+
249
+ ```bibtex
250
+ @article{liu2022auto3d,
251
+ title={Auto3D: Automatic generation of the low-energy 3D structures with ANI neural network potentials},
252
+ author={Liu, Zhen and Zubatiuk, Tetiana and Roitberg, Adrian and Isayev, Olexandr},
253
+ journal={Journal of Chemical Information and Modeling},
254
+ volume={62},
255
+ number={22},
256
+ pages={5373--5382},
257
+ year={2022},
258
+ publisher={ACS Publications},
259
+ doi={10.1021/acs.jcim.2c00817}
260
+ }
261
+ ```
262
+
263
+ ## Contributing
264
+
265
+ [Issues](https://github.com/isayevlab/Auto3D_pkg/issues) ·
266
+ [Discussions](https://github.com/isayevlab/Auto3D_pkg/discussions) ·
267
+ [CONTRIBUTING.md](CONTRIBUTING.md)
268
+
269
+ ## License
270
+
271
+ MIT — see [LICENSE](LICENSE).
auto3d-3.1.0/README.md ADDED
@@ -0,0 +1,211 @@
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
+ <br>
41
+
42
+ `conda install -c conda-forge auto3d` installs **2.3.0**, not 3.1.0. conda-forge
43
+ requires every dependency to be a conda package, and `aimnet` — a core dependency
44
+ since 3.0.0 — is not one yet, nor is its own dependency `nvalchemi-toolkit-ops`.
45
+
46
+ Auto3D works fine *inside* a conda environment; it is only the conda **package**
47
+ that lags. `installation.yml` sets up the supported combination:
48
+
49
+ ```bash
50
+ conda env create --file installation.yml --name auto3D
51
+ conda activate auto3D # pip installs Auto3D[ani,ase] into it
52
+ ```
53
+
54
+ Details and the path forward: [Building the conda package](https://auto3d.readthedocs.io/en/latest/howto/conda_build.html).
55
+
56
+ </details>
57
+
58
+ ## Quick start
59
+
60
+ **Command line**
61
+
62
+ ```bash
63
+ auto3d run molecules.smi --k=5 # top-5 conformers per molecule
64
+ auto3d run molecules.smi --window=3.0 # or everything within 3 kcal/mol
65
+ auto3d run molecules.smi --k=5 --no-gpu # CPU only
66
+ ```
67
+
68
+ Exactly one of `--k` or `--window` is required. GPU is used by default, and
69
+ requesting it with no visible CUDA device is a **fatal error, not a fallback** —
70
+ pass `--no-gpu` on a CPU-only machine.
71
+
72
+ **Python**
73
+
74
+ ```python
75
+ from Auto3D import Auto3DOptions, main
76
+
77
+ config = Auto3DOptions(path="molecules.smi", k=1)
78
+ output_path = main(config)
79
+ ```
80
+
81
+ `main()` returns a `WorkflowResult`, which *is* the output path (it subclasses
82
+ `str`) and also carries `n_molecules`, `n_conformers`, and `failures`.
83
+
84
+ For batches of ≤150 molecules, skip the job directory and get RDKit molecules
85
+ straight back:
86
+
87
+ ```python
88
+ from Auto3D import Auto3DOptions, smiles2mols
89
+
90
+ mols = smiles2mols(["CCO", "CCCO", "c1ccccc1"], Auto3DOptions(k=1, use_gpu=False))
91
+ for mol in mols:
92
+ print(mol.GetProp("_Name"), mol.GetProp("E_tot"), "Hartree")
93
+ ```
94
+
95
+ ## What you get
96
+
97
+ A run creates `<stem>_<timestamp>/` next to the input, containing the output SDF
98
+ and an `Auto3D.log`. Each conformer in the SDF carries:
99
+
100
+ | Property | Meaning |
101
+ |---|---|
102
+ | `E_tot` / `E_tot(Hartree)` | Total energy, Hartree |
103
+ | `E_rel(kcal/mol)` | Energy relative to the best conformer of that molecule |
104
+ | `_Name`, `ID` | Molecule name and a stable identifier |
105
+ | `fmax`, `Converged`, `Dropped_Oscillating` | Optimizer diagnostics |
106
+
107
+ The input SMILES is **not** written to the output — join on `_Name`/`ID` against
108
+ your input file.
109
+
110
+ ## Beyond conformer generation
111
+
112
+ Each of these wraps a Python API function and has a matching notebook in
113
+ [`example/`](example/).
114
+
115
+ | Command | Does | Python API |
116
+ |---|---|---|
117
+ | `auto3d run` | Generate conformers from SMILES/SDF | `main`, `smiles2mols` |
118
+ | `auto3d energy` | Single-point energy for an SDF | `calc_spe` |
119
+ | `auto3d optimize` | Geometry-optimize an existing SDF | `opt_geometry` |
120
+ | `auto3d thermo` | Enthalpy / entropy / Gibbs (needs `ase`) | `calc_thermo` |
121
+ | `auto3d tautomers` | Enumerate and rank stable tautomers | `get_stable_tautomers` |
122
+ | `auto3d validate` | Check an input file without running | — |
123
+ | `auto3d config init\|show\|validate` | Manage YAML configs | — |
124
+ | `auto3d models list\|info\|test` | Inspect and smoke-test engines | — |
125
+
126
+ All commands except `models list` take `-v/--verbose`, the only way to get a
127
+ traceback. `--json` is available on `run`, `validate`, and the four property
128
+ commands. Exit codes: `0` success, `2` config/input error, `4` GPU requested but
129
+ unavailable, `6` partial success, `130` interrupted.
130
+
131
+ ## Engines
132
+
133
+ | Engine | Networks/step | Elements |
134
+ |---|---|---|
135
+ | **AIMNET** (default) | 1 | H, B, C, N, O, F, Si, P, S, Cl, As, Se, Br, I |
136
+ | **aimnet2-2025**, **aimnet2-nse**, **aimnet2-pd**, … | 1 | as above (`aimnet2-pd` swaps As for Pd) |
137
+ | **ANI2x** | 8 (ensemble) | H, C, N, O, F, S, Cl |
138
+ | **ANI2xt** | 1 | H, C, N, O, F, S, Cl |
139
+
140
+ Select with `--engine` or `optimizing_engine`. AIMNet2 models come from the
141
+ [`aimnet`](https://github.com/isayevlab/aimnetcentral) package and are
142
+ sha256-validated on download; `auto3d models list` shows what is available.
143
+ `optimizing_engine` also accepts a path to a
144
+ [custom NNP](https://auto3d.readthedocs.io/en/latest/howto/custom_nnp.html).
145
+
146
+ No engine speed benchmark is maintained in this repository, so the table reports
147
+ how many networks each engine evaluates per step rather than a speed ranking.
148
+ Time your own workload before choosing.
149
+
150
+ ## Key parameters
151
+
152
+ | Parameter | Default | Description |
153
+ |---|---|---|
154
+ | `k` | — | Top-k conformers per molecule |
155
+ | `window` | — | Energy window, kcal/mol — exactly one of `k`/`window` is required |
156
+ | `optimizing_engine` | `AIMNET` | Engine name, registry name, or path to a custom model |
157
+ | `use_gpu` | `True` | GPU acceleration; missing CUDA device is fatal, not a fallback |
158
+ | `gpu_idx` | `0` | CUDA index, or a list for multi-GPU |
159
+ | `enumerate_tautomer` | `False` | Enumerate tautomers |
160
+ | `enumerate_isomer` | `True` | Enumerate stereoisomers |
161
+ | `threshold` | `0.3` | RMSD threshold for duplicate removal, Å |
162
+ | `opt_steps` | `2000` | Maximum optimization steps |
163
+ | `convergence_threshold` | `0.01` | Force convergence threshold, eV/Å |
164
+
165
+ Full list: [CLI reference](https://auto3d.readthedocs.io/en/latest/cli.html) ·
166
+ [API reference](https://auto3d.readthedocs.io/en/latest/api.html)
167
+
168
+ ## Upgrading from 2.x
169
+
170
+ AIMNet2 is now served by the `aimnet` package rather than bundled `.jpt` files,
171
+ and the default AIMNet2 energies differ from 2.x (the registry `.pt` externalizes
172
+ D3 dispersion), so conformer rankings may shift slightly. The thermochemistry SDF
173
+ property `S_hartree` is now `S_hartree_per_K`. Python ≥ 3.11 and PyTorch ≥ 2.8 are
174
+ required. See the [migration guide](https://auto3d.readthedocs.io/en/latest/migration.html).
175
+
176
+ ## Documentation
177
+
178
+ [**auto3d.readthedocs.io**](https://auto3d.readthedocs.io/) ·
179
+ [Installation](https://auto3d.readthedocs.io/en/latest/installation.html) ·
180
+ [Quickstart](https://auto3d.readthedocs.io/en/latest/howto/quickstart.html) ·
181
+ [CLI](https://auto3d.readthedocs.io/en/latest/cli.html) ·
182
+ [API](https://auto3d.readthedocs.io/en/latest/api.html) ·
183
+ [Custom NNPs](https://auto3d.readthedocs.io/en/latest/howto/custom_nnp.html) ·
184
+ [Troubleshooting](https://auto3d.readthedocs.io/en/latest/howto/troubleshooting.html) ·
185
+ [Notebooks](example/)
186
+
187
+ ## Citation
188
+
189
+ ```bibtex
190
+ @article{liu2022auto3d,
191
+ title={Auto3D: Automatic generation of the low-energy 3D structures with ANI neural network potentials},
192
+ author={Liu, Zhen and Zubatiuk, Tetiana and Roitberg, Adrian and Isayev, Olexandr},
193
+ journal={Journal of Chemical Information and Modeling},
194
+ volume={62},
195
+ number={22},
196
+ pages={5373--5382},
197
+ year={2022},
198
+ publisher={ACS Publications},
199
+ doi={10.1021/acs.jcim.2c00817}
200
+ }
201
+ ```
202
+
203
+ ## Contributing
204
+
205
+ [Issues](https://github.com/isayevlab/Auto3D_pkg/issues) ·
206
+ [Discussions](https://github.com/isayevlab/Auto3D_pkg/discussions) ·
207
+ [CONTRIBUTING.md](CONTRIBUTING.md)
208
+
209
+ ## License
210
+
211
+ 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.0"
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