PyFraME 0.5.1__tar.gz → 0.6.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 (216) hide show
  1. pyframe-0.6.0/CHANGELOG.md +376 -0
  2. {pyframe-0.5.1 → pyframe-0.6.0}/CITATION +3 -3
  3. {pyframe-0.5.1 → pyframe-0.6.0}/CITATION.cff +5 -5
  4. pyframe-0.6.0/CONTRIBUTORS +49 -0
  5. {pyframe-0.5.1 → pyframe-0.6.0}/PKG-INFO +326 -29
  6. {pyframe-0.5.1 → pyframe-0.6.0}/PyFraME.egg-info/PKG-INFO +326 -29
  7. {pyframe-0.5.1 → pyframe-0.6.0}/PyFraME.egg-info/SOURCES.txt +50 -5
  8. {pyframe-0.5.1 → pyframe-0.6.0}/PyFraME.egg-info/requires.txt +4 -0
  9. {pyframe-0.5.1 → pyframe-0.6.0}/README.md +322 -28
  10. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/__init__.py +5 -4
  11. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/common/arrays.py +63 -0
  12. {pyframe-0.5.1/pyframe/embedding → pyframe-0.6.0/pyframe/common}/combination_rules.py +7 -1
  13. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/common/lennard_jones.py +5 -5
  14. pyframe-0.5.1/pyframe/common/potential_document.py → pyframe-0.6.0/pyframe/common/potential_dict.py +24 -15
  15. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/common/tests/log_test.py +8 -0
  16. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/common/tests/simulation_box_test.py +4 -4
  17. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/common/tests/tensor_components_test.py +9 -0
  18. pyframe-0.6.0/pyframe/common/tests/units_test.py +49 -0
  19. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/common/units.py +1 -1
  20. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/data/alep.csv +1 -0
  21. pyframe-0.6.0/pyframe/construction/data/aliases/alep-amber.csv +383 -0
  22. pyframe-0.6.0/pyframe/construction/data/aliases/cp3-amber.csv +8499 -0
  23. pyframe-0.6.0/pyframe/construction/data/aliases/residues.csv +28 -0
  24. pyframe-0.6.0/pyframe/construction/data/aliases/sep-amber.csv +18 -0
  25. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/data/cp3.csv +5997 -2260
  26. pyframe-0.6.0/pyframe/construction/data/elements/uff.csv +107 -0
  27. pyframe-0.6.0/pyframe/construction/data/ff03.csv +4179 -0
  28. pyframe-0.6.0/pyframe/construction/data/ff94.csv +4180 -0
  29. pyframe-0.6.0/pyframe/construction/data/lipid14.csv +568 -0
  30. pyframe-0.6.0/pyframe/construction/data/lipid17.csv +552 -0
  31. pyframe-0.6.0/pyframe/construction/data/lipid21.csv +664 -0
  32. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/data/tip3p.csv +1 -0
  33. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/exact_coordinates.py +22 -25
  34. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/fragments.py +8 -8
  35. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/from_system.py +5 -5
  36. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/potential_builder.py +709 -31
  37. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/potentials.py +14 -14
  38. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/readers.py +380 -12
  39. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/regions.py +159 -64
  40. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/conftest.py +2 -1
  41. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/exact_coordinates_test.py +238 -8
  42. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/fragments_test.py +68 -1
  43. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/from_system_test.py +9 -3
  44. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/parameter_sets_test.py +155 -16
  45. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/potential_builder_test.py +513 -51
  46. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/potentials_test.py +26 -7
  47. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/readers_test.py +562 -34
  48. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/regions_test.py +104 -4
  49. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/trajectory_test.py +211 -33
  50. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/utilities_test.py +11 -0
  51. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/writers_test.py +176 -43
  52. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/trajectory.py +205 -41
  53. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/writers.py +113 -59
  54. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/__init__.py +2 -2
  55. pyframe-0.6.0/pyframe/embedding/combination_rules.py +41 -0
  56. pyframe-0.6.0/pyframe/embedding/device.py +950 -0
  57. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/dispersion_interactions.py +1 -1
  58. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/electrostatic_interactions.py +81 -37
  59. pyframe-0.6.0/pyframe/embedding/engine/computation.cpp +1506 -0
  60. pyframe-0.6.0/pyframe/embedding/engine/computation.h +204 -0
  61. pyframe-0.6.0/pyframe/embedding/engine/dipole_fields.cu +204 -0
  62. pyframe-0.6.0/pyframe/embedding/engine/dipole_fields_fp32.cu +160 -0
  63. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/engine/engine.cpp +738 -131
  64. pyframe-0.6.0/pyframe/embedding/engine/environment_energy.cu +270 -0
  65. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/engine/global.cpp +9 -8
  66. pyframe-0.6.0/pyframe/embedding/engine/global.h +177 -0
  67. pyframe-0.6.0/pyframe/embedding/engine/lennard_jones_energy.cu +63 -0
  68. pyframe-0.6.0/pyframe/embedding/engine/multipole_fields.cu +268 -0
  69. pyframe-0.6.0/pyframe/embedding/engine/near_dipole_fields.cu +132 -0
  70. pyframe-0.6.0/pyframe/embedding/engine/pair_kernels.h +296 -0
  71. pyframe-0.6.0/pyframe/embedding/engine/pair_kernels_given.inc +276 -0
  72. pyframe-0.6.0/pyframe/embedding/engine/target_lanes.h +951 -0
  73. pyframe-0.6.0/pyframe/embedding/engine/target_lanes_kernels.inc +646 -0
  74. pyframe-0.6.0/pyframe/embedding/engine/unrolled_derivatives.cuh +95 -0
  75. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/engine.pyi +32 -8
  76. pyframe-0.5.1/pyframe/embedding/repulsion_interactions.py → pyframe-0.6.0/pyframe/embedding/exchange_repulsion_interactions.py +13 -13
  77. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/fragment.py +4 -0
  78. pyframe-0.6.0/pyframe/embedding/induction_decomposition.py +622 -0
  79. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/induction_interactions.py +153 -72
  80. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/integral_driver_template.py +17 -14
  81. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/interaction_tensor.py +11 -1
  82. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/model.py +446 -46
  83. pyframe-0.6.0/pyframe/embedding/options.py +370 -0
  84. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/particle.py +29 -14
  85. pyframe-0.6.0/pyframe/embedding/potential_file.py +224 -0
  86. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/read_input.py +320 -32
  87. pyframe-0.6.0/pyframe/embedding/shared_memory.py +431 -0
  88. pyframe-0.6.0/pyframe/embedding/sites.py +644 -0
  89. pyframe-0.6.0/pyframe/embedding/solvers.py +2463 -0
  90. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/subsystem.py +1025 -328
  91. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tensor_tools.py +215 -17
  92. pyframe-0.6.0/pyframe/embedding/tests/closed_form_test.py +297 -0
  93. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/conftest.py +65 -10
  94. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/data/HF.json +2 -2
  95. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/data/Ne_test.json +2 -2
  96. pyframe-0.6.0/pyframe/embedding/tests/data/kernel_characterization.json +1401 -0
  97. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/data/two_oxygen_nine_six_test.json +2 -2
  98. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/data/two_oxygen_split_lj_test.json +2 -2
  99. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/data/two_oxygen_test.json +2 -2
  100. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/data/two_wat_test.json +6 -6
  101. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/data/wat_in_wat_missing_lj_test.json +14 -14
  102. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/data/wat_in_wat_split_lj_test.json +15 -15
  103. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/data/wat_in_wat_test.json +15 -15
  104. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/data/wat_in_wat_zero_lj_test.json +15 -15
  105. pyframe-0.6.0/pyframe/embedding/tests/device_mpi_worker.py +228 -0
  106. pyframe-0.6.0/pyframe/embedding/tests/device_parallel_test.py +120 -0
  107. pyframe-0.6.0/pyframe/embedding/tests/device_solvers_test.py +846 -0
  108. pyframe-0.6.0/pyframe/embedding/tests/device_test.py +880 -0
  109. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/dispersion_interactions_test.py +12 -4
  110. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/electrostatic_interactions_test.py +94 -23
  111. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/engine_arguments_test.py +88 -19
  112. pyframe-0.6.0/pyframe/embedding/tests/engine_in_place_test.py +160 -0
  113. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/engine_test.py +6 -3
  114. pyframe-0.6.0/pyframe/embedding/tests/environment_pairs_test.py +247 -0
  115. pyframe-0.5.1/pyframe/embedding/tests/repulsion_interactions_test.py → pyframe-0.6.0/pyframe/embedding/tests/exchange_repulsion_interactions_test.py +25 -17
  116. pyframe-0.6.0/pyframe/embedding/tests/frozen_arrays_test.py +154 -0
  117. pyframe-0.6.0/pyframe/embedding/tests/induction_decomposition_test.py +911 -0
  118. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/induction_interactions_test.py +68 -20
  119. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/induction_mpi_worker.py +227 -9
  120. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/induction_parallel_test.py +133 -6
  121. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/integral_driver_template_test.py +13 -0
  122. pyframe-0.6.0/pyframe/embedding/tests/inverse_distance_derivatives_test.py +252 -0
  123. pyframe-0.6.0/pyframe/embedding/tests/kernel_characterization_test.py +319 -0
  124. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/lj_characterization_test.py +109 -98
  125. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/lj_mpi_worker.py +15 -7
  126. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/lj_parallel_test.py +49 -15
  127. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/minimum_image_test.py +60 -0
  128. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/model_test.py +193 -25
  129. pyframe-0.6.0/pyframe/embedding/tests/near_field_test.py +406 -0
  130. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/options_test.py +91 -9
  131. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/particle_test.py +16 -7
  132. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/polytensor_test.py +6 -0
  133. pyframe-0.6.0/pyframe/embedding/tests/potential_file_test.py +156 -0
  134. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/read_input_test.py +62 -5
  135. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/serial_test.py +1 -1
  136. pyframe-0.6.0/pyframe/embedding/tests/shared_memory_mpi_worker.py +76 -0
  137. pyframe-0.6.0/pyframe/embedding/tests/shared_memory_test.py +209 -0
  138. pyframe-0.6.0/pyframe/embedding/tests/sites_test.py +503 -0
  139. pyframe-0.6.0/pyframe/embedding/tests/solvers_mpi_worker.py +75 -0
  140. pyframe-0.6.0/pyframe/embedding/tests/solvers_parallel_test.py +53 -0
  141. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/solvers_test.py +689 -93
  142. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/subsystem_test.py +640 -49
  143. pyframe-0.6.0/pyframe/embedding/tests/target_lanes_test.py +768 -0
  144. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/tensor_tools_test.py +242 -1
  145. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/totals_test.py +24 -5
  146. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/totals.py +35 -13
  147. pyframe-0.6.0/pyframe/tests/api_test.py +336 -0
  148. pyframe-0.6.0/pyframe/tests/notices_test.py +101 -0
  149. pyframe-0.6.0/pyframe/typing.py +141 -0
  150. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/version.py +1 -1
  151. {pyframe-0.5.1 → pyframe-0.6.0}/pyproject.toml +48 -17
  152. {pyframe-0.5.1 → pyframe-0.6.0}/setup.py +42 -2
  153. pyframe-0.5.1/CHANGELOG.md +0 -217
  154. pyframe-0.5.1/CONTRIBUTORS +0 -10
  155. pyframe-0.5.1/pyframe/construction/data/ff03.csv +0 -3390
  156. pyframe-0.5.1/pyframe/construction/data/ff94.csv +0 -3389
  157. pyframe-0.5.1/pyframe/construction/data/lipid14.csv +0 -565
  158. pyframe-0.5.1/pyframe/construction/data/lipid17.csv +0 -549
  159. pyframe-0.5.1/pyframe/embedding/engine/computation.cpp +0 -882
  160. pyframe-0.5.1/pyframe/embedding/engine/computation.h +0 -142
  161. pyframe-0.5.1/pyframe/embedding/engine/global.h +0 -62
  162. pyframe-0.5.1/pyframe/embedding/options.py +0 -166
  163. pyframe-0.5.1/pyframe/embedding/solvers.py +0 -1272
  164. pyframe-0.5.1/pyframe/embedding/tests/performance.py +0 -97
  165. pyframe-0.5.1/pyframe/tests/api_test.py +0 -97
  166. {pyframe-0.5.1 → pyframe-0.6.0}/LICENSE +0 -0
  167. {pyframe-0.5.1 → pyframe-0.6.0}/MANIFEST.in +0 -0
  168. {pyframe-0.5.1 → pyframe-0.6.0}/PyFraME.egg-info/dependency_links.txt +0 -0
  169. {pyframe-0.5.1 → pyframe-0.6.0}/PyFraME.egg-info/top_level.txt +0 -0
  170. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/common/__init__.py +0 -0
  171. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/common/constants.py +0 -0
  172. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/common/elements.py +0 -0
  173. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/common/log.py +0 -0
  174. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/common/simulation_box.py +0 -0
  175. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/common/tensor_components.py +0 -0
  176. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/common/tests/constants_test.py +0 -0
  177. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/common/tests/elements_test.py +0 -0
  178. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/common/tests/lennard_jones_test.py +0 -0
  179. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/__init__.py +0 -0
  180. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/atoms.py +0 -0
  181. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/data/sep.csv +0 -0
  182. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/project.py +0 -0
  183. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/system.py +0 -0
  184. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/task_farming.py +0 -0
  185. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/atoms_test.py +0 -0
  186. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/data/README.md +0 -0
  187. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/data/precision_water.gro +0 -0
  188. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/data/precision_water.trr +0 -0
  189. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/data/precision_water.xtc +0 -0
  190. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/data/precision_water_double.trr +0 -0
  191. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/data/trajectory.gro +0 -0
  192. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/data/trajectory.mdp +0 -0
  193. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/data/trajectory.top +0 -0
  194. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/data/trajectory.tpr +0 -0
  195. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/data/trajectory.xtc +0 -0
  196. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/system_test.py +0 -0
  197. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/tests/task_farming_test.py +0 -0
  198. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/construction/utilities.py +0 -0
  199. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/polytensor.py +0 -0
  200. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/data/acrolein_wat_test.json +0 -0
  201. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/data/act_wat_2.json +0 -0
  202. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/data/act_wat_big.json +0 -0
  203. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/data/act_wat_mid.json +0 -0
  204. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/data/act_wat_small.json +0 -0
  205. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/data/act_wat_test.json +0 -0
  206. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/data/butadiene_water.json +0 -0
  207. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/data/missing_classical_fragments_two_atoms_test.json +0 -0
  208. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/data/missing_nuclei_two_atoms_test.json +0 -0
  209. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/data/no_subsystems.json +0 -0
  210. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/data/two_atom_test.json +0 -0
  211. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/engine_stub_test.py +0 -0
  212. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/fragment_test.py +0 -0
  213. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/embedding/tests/interaction_tensor_test.py +0 -0
  214. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/py.typed +0 -0
  215. {pyframe-0.5.1 → pyframe-0.6.0}/pyframe/tests/layering_test.py +0 -0
  216. {pyframe-0.5.1 → pyframe-0.6.0}/setup.cfg +0 -0
@@ -0,0 +1,376 @@
1
+ # Changelog
2
+
3
+ The format is based on [Keep a Changelog](http://keepachangelog.com/)
4
+ and this project adheres to [Semantic Versioning](http://semver.org/).
5
+
6
+ <!-- How to write an entry: see the "Changelog" section of CONTRIBUTING.md. -->
7
+
8
+ ## [0.6.0] 2026-11-20
9
+ ### Added
10
+ - Potentials can be written as HDF5 files, which read in seconds even at a million sites
11
+ (`write_potential(filetype='h5')`, or `pyframe.embedding.potential_file.write` for an existing JSON potential).
12
+ `read_input.reader` reads them as it reads JSON potentials.
13
+ - A frozen embedding gives the derivatives of its Fock matrix contribution with respect to the nuclei
14
+ (`fock_derivatives`), which a host program needs for the nuclear gradients of correlated and excited-state methods.
15
+ - `pyframe.typing`, the types that PyFraME's classes and functions take and return, e.g. `FloatArray`, `Snapshot`, and
16
+ `Relaxation`, for annotating a program that uses PyFraME.
17
+ - The `lipid21` parameter set, with the charges and Lennard-Jones parameters of AMBER Lipid21.
18
+ - Lipids named as in the AMBER Lipid force fields, i.e. a head group (`PC`, `PS`) and its tails (`PA`, `OL`, `MY`) as
19
+ residues of their own, are recognized as DMPC, POPC, and POPS by `alep` and the default parameter set.
20
+ - The `ff94`, `ff03`, `lipid14`, and `lipid17` parameter sets have Lennard-Jones parameters, which a region takes
21
+ unless it is given `use_lennard_jones=False`.
22
+ - More names of protonation states in `cp3`, `ff94`, `ff03`, and the default parameter set: `LYSN`, `LSN`, `ASPP`,
23
+ `GLUP`, and `HIS1`, as GROMACS and CHARMM name them, and every such name at the ends of a chain, e.g. `NLYSH`.
24
+ - The energy of the environment with itself is also reported as its electrostatic, exchange repulsion, and dispersion
25
+ energies (`environment_terms` of `energy_contributions` and of an embedding).
26
+ - An embedding combines the Lennard-Jones parameters of a potential by the combination rule they were made for, which
27
+ the potential records. Where the parameter sets of a system state different rules, `create_embedding_potential` asks
28
+ for one with `combination_rule`.
29
+ - A region can take its Lennard-Jones parameters from parameter sets or tables of elements of its choice, and the core
30
+ region from a list of them as well (`lennard_jones`). A fragment that no source covers whole is refused, unless the
31
+ list ends with `'none'`.
32
+ - The AMBER parameter sets find the ions of `sep`, the lipids of `alep`, and the amino acids of `cp3` under their own
33
+ names, so that `['ff94', 'lipid21', 'tip3p']` covers everything of the default parameter set but its organic
34
+ solvents and bromide.
35
+ - `uff`, the Lennard-Jones parameters of the Universal Force Field for every element. Adding it to the sources of a
36
+ region or the core region, e.g. `['ff94', 'tip3p', 'uff']`, covers molecules that no parameter set has, such as
37
+ ligands.
38
+ - A polarizable embedding can split its induction energy into the environment's polarization of itself and its
39
+ interaction with the quantum region (`induction_decomposition` in the options, then `induction_decomposition` of
40
+ `energy_contributions`), with error-corrected terms and error bounds.
41
+ - The induced dipoles, and the fields and energy of the environment, can be computed on NVIDIA GPUs, one for each MPI
42
+ process, with `'device': 'gpu'` in the `induced_dipoles` options (`pip install pyframe[gpu]`). The results are the
43
+ CPU's but for rounding; `PyFraME_GPU_FMA=0` and `PyFraME_GPU_SPLIT=1` make the GPU round as the CPU does.
44
+ - The `cg` solver, conjugate gradients, which takes some 40 % fewer iterations than `jidiis` and is the default where the
45
+ sites that do not polarize each other are excluded both ways; `preconditioner` and `near_field_cutoff` in the
46
+ `induced_dipoles` options set how it is preconditioned, and `'solver': 'jacobi'` solves as before.
47
+ - The `cg` solver takes most of its arithmetic in single precision where it can, on a GPU and on a CPU with AVX2 or
48
+ AVX-512, which is up to several times faster, and still converges the induced dipoles in double precision.
49
+ `'precision': 'double'` computes in double precision throughout.
50
+ - The electrostatic interactions are computed by closed formulas, which are faster than the general recursion and give
51
+ the same results but for rounding. `'tensors': 'recursion'` in the options computes them as before.
52
+ - Under MPI, the processes of a node that share a NUMA domain hold one copy of the potential between them rather than
53
+ one each, in the same time; `PyFraME_SHARED_MEMORY` shares it across the whole node instead, or turns this off.
54
+
55
+ ### Changed
56
+ - On a CPU with AVX2 or AVX-512, as most recent x86-64 CPUs have, the induced dipoles and the fields and energy of the
57
+ environment take several times less time, with the same results to the last bit. `PyFraME_CPU_SIMD=off` turns it off.
58
+ - The Lennard-Jones energies of the environment take some 3 to 5 times less time, with the same results.
59
+ - The `jidiis` and `dcjidiis` solvers keep only the iterations their extrapolation uses, so that a large environment
60
+ takes far less memory and time to solve for. The dipoles are the same.
61
+ - The exclusion lists and multipoles of a large environment take a small fraction of the memory they did, and the
62
+ induced dipoles a little less time to solve for. `exclusions` and `degenerate_multipoles_with_taylor_coefficients`
63
+ of a classical subsystem are read-only sequences rather than lists; they compare equal to the lists they were.
64
+ - The nuclear gradient and Hessian of a polarizable embedding no longer hold the field derivatives of every nucleus
65
+ at every site at once, which for large environments took many gigabytes.
66
+ - Reading a potential of many sites takes a fraction of the time and memory it did. Its fragments and atoms are
67
+ made only where `classical_fragments` is asked for.
68
+ - The `dcji` and `dcjidiis` solvers divide the environment into clusters of about 1,000 sites, as many as its size
69
+ needs, rather than always five, and form them in seconds even at a million sites. The dipoles are the same to the
70
+ threshold, in a different number of iterations. `k_cluster` still sets the number of clusters.
71
+ - Under the minimum image convention (`mic`), the fields of the permanent multipoles that polarize the induced dipoles
72
+ are taken between the nearest periodic images too, as the interactions between the induced dipoles already were.
73
+ Calculations with `mic` give other induced dipoles and induction energies than before.
74
+ - On CPUs over several nodes, the processes exchange the induced dipoles some ten times as fast, which made a solve of a
75
+ million sites on two nodes 1.4 times as fast.
76
+ - A large environment takes some 40 % less memory, 0.85 GB rather than 1.5 GB a process at a million sites, and an
77
+ embedding given subsystems already read no longer holds a second copy of them.
78
+ - An integral driver's methods are handed the multipoles as a sequence of an array a site rather than a list, which takes
79
+ 100 MB less at a million sites. It indexes and iterates as the list did; a driver that needs a list makes one with
80
+ `list(multipoles)`, and one checked for types annotates them `Sequence[FloatArray]`.
81
+ - `PotentialDocument` of `pyframe.common.potential_document` is now `PotentialDict` of `pyframe.typing`. The old module
82
+ is gone, so scripts that import it need updating.
83
+ - `nuclear_terms` of an embedding is now `density_independent_terms`, since it includes the Lennard-Jones energies. The
84
+ old name still works, with a warning, and will be removed.
85
+ - The Lennard-Jones repulsion is now called exchange repulsion, which tells it apart from the repulsion between charges
86
+ that is part of the electrostatic energy. Several names have changed, and scripts and potential files that use them
87
+ need updating:
88
+ - `exchange_repulsion` replaces `repulsion` as the key of a site's exchange repulsion parameters in a potential
89
+ file. A file written by an earlier version is refused, with a message that names the new key, until the key is
90
+ renamed.
91
+ - `"exchange_repulsion"` replaces `"repulsion"` among the terms of `energy_contributions` and
92
+ `density_independent_terms`.
93
+ - `exchange_repulsion` of a site of a potential replaces `repulsion`.
94
+ - `pyframe.embedding.exchange_repulsion_interactions` replaces `repulsion_interactions`, and its functions are named
95
+ accordingly, e.g. `compute_exchange_repulsion_interactions`.
96
+ - A parameter set of one's own that gives an atom of a fragment twice, with different values, is refused with an error
97
+ that names the atom. The last of the two rows was taken before. An atom given twice alike is still read.
98
+ - A residue whose charges in its parameter set do not add up to a whole charge, e.g. one with atoms missing or named
99
+ after another protonation state, is refused with an error that names it. It was silently made to carry the charge
100
+ the structure stated.
101
+ - A residue keeps the charge of its parameter set where the structure states another, e.g. a lysine that a PDB file
102
+ marks neutral, and is named in a warning. A PDB file states a residue's charge only where its charge column has an
103
+ entry for one of its atoms.
104
+ - A fragment calculation or core region with an odd number of electrons at its charge, e.g. a ligand of charge -1 that
105
+ a PDB file without charges leaves neutral, is refused with an error that names it. Such a molecule was calculated
106
+ with an electron too many or too few.
107
+ - A parameter set of one's own that has Lennard-Jones parameters states the combination rule they were made for, on a
108
+ line `# combination rule: Lorentz-Berthelot` above its column labels, and is refused without one.
109
+ - The combination rule of the embedding options (`combination_rule` of `vdw`) defaults to the one the potential states,
110
+ and to Lorentz-Berthelot, as before, where it states none. A rule given there that differs is followed, with a
111
+ warning.
112
+ - A core region whose Lennard-Jones source lacks an atom of one of its fragments, e.g. a ligand that `ff94` does not
113
+ have, is refused with an error that names the atoms. Its nuclei were given no parameters without saying so. Sources
114
+ that end with `'none'`, e.g. `['ff94', 'none']`, leave such a fragment without them.
115
+ - A region that takes its parameters from a parameter set, e.g. a protein with the default parameter set or `cp3`,
116
+ uses MFCC exclusion lists by default (`parameter_set_exclusion_type='mfcc'`), so that neighboring residues polarize
117
+ each other alike in both directions. Pass `parameter_set_exclusion_type='fragment'` to build potentials as before.
118
+ - Embedding calculations are substantially faster on a single core, scale better with the number of OpenMP threads, and
119
+ spend less time on communication between MPI processes.
120
+ - An MPI calculation warns if it was initialized for a single thread, e.g. with `mpi4py.rc.thread_level =
121
+ 'single'`, since the embedding computes with several. With `OMP_NUM_THREADS=1` it computes with one and does not
122
+ warn.
123
+
124
+ ### Fixed
125
+ - The energy of the environment with itself is summed accurately in large environments. Its pairs were added into a few
126
+ running sums, which lost those of the far pairs: at a million sites the dispersion was off by 1.5e-8 of itself.
127
+ - PyFraME built from source with Intel's oneAPI compilers computes as it does built with GCC or clang. Intel's
128
+ compilers reorder floating-point arithmetic by default, which changed results.
129
+ - On macOS, embedding calculations no longer crash in a program that has already used another package with its own
130
+ OpenMP runtime, e.g. a Qiskit Aer simulation. Setting `OMP_NUM_THREADS=1`, which avoided the crash, is no longer
131
+ needed.
132
+ - The charged residues of `ff03`, e.g. its termini, keep their charge in a structure without formal charges, e.g. a
133
+ PDB file without a charge column. They were made neutral.
134
+ - A lysine named `LYSH`, as GROMOS and OPLS-AA name the protonated lysine, is given the charges of the protonated lysine
135
+ by `cp3`, `ff94`, `ff03`, and the default parameter set. It was given those of the neutral lysine.
136
+ - A protonated histidine named `HISH` and a cysteine named `CYSH`, as GROMOS names them, are accepted by `ff94` and
137
+ `ff03`, which refused them.
138
+ - The ring carbons `CD1` and `CE1` of an N-terminal phenylalanine in `ff94`, and the hydrogen `HD2` of proline in
139
+ `ff03`, have the charges of AMBER. Each had that of another atom of the residue, differing in the fourth or the sixth
140
+ decimal.
141
+ - A neutral N-terminal residue under its plain name, e.g. an alanine named `ALA` with two amine hydrogens, is given
142
+ the charges of the neutral N-terminus by `cp3`. It was given those of the charged one and then made neutral.
143
+ - The nuclei of a terminal residue in the core region, e.g. an N-terminal alanine, take the Lennard-Jones parameters of
144
+ that end of the residue. Its terminal atoms, e.g. `H1` to `H3` or `OXT`, were given none.
145
+ - Residues that the structure gives no charge for, e.g. those of a PDB file without a charge column, are calculated
146
+ with their charges from PyFraME's parameter sets, in the core region as well. A protein read from such a file was
147
+ calculated as neutral, residue by residue.
148
+ - A structure with a molecule of only hydrogens, e.g. H2, is read, and so is a split that leaves a part of only
149
+ hydrogens, e.g. the hydrogens of a water. Both failed with an error about the columns of an array.
150
+ - The `dcji` and `dcjidiis` solvers give the induced dipoles that `jacobi` and `jidiis` give for a potential whose
151
+ exclusion lists are not mutual, such as a protein built with `parameter_set_exclusion_type='fragment'`. Their dipoles
152
+ differed by up to 15 percent, and depended on the number of clusters.
153
+ - Where two regions meet, e.g. a computed region and one of a parameter set on either side of a peptide bond, their
154
+ sites polarize each other both ways or not at all. Some polarized each other in one direction only.
155
+ - The Fock matrix contribution, gradient, Hessian, and response of a polarizable embedding are the derivatives of its
156
+ energy also for a potential whose exclusion lists are not mutual, such as a protein built with
157
+ `parameter_set_exclusion_type='fragment'`. An SCF converged where that energy was not stationary.
158
+ - The energy of the environment with itself, `environment` of `energy_contributions`, is calculated for environments of
159
+ more than 46,341 sites, where the calculation crashed or stopped with an error. For a large environment it also no
160
+ longer takes several gigabytes of memory, which it took in every MPI process of a calculation as well.
161
+ - A parameter set table of your own with a value that is not a number, e.g. an empty cell, is refused with the atom and
162
+ the table it is in. The error named neither.
163
+ - Multipoles of order 4 and above, hexadecapoles and higher, are made traceless, as PyFraME has always said it makes
164
+ them. Part of their trace was left. Energies, fields, and everything else computed from them were not affected,
165
+ since a trace contributes nothing to them.
166
+
167
+ ## [0.5.1] 2026-10-20
168
+ ### Fixed
169
+ - PyFraME imports again on Python 3.12 and newer, where a recent release of pint, which PyFraME uses through
170
+ qcelemental, made the import fail.
171
+
172
+ ## [0.5.0] 2026-10-13
173
+ ### Added
174
+ - Embedding calculations. The new embedding module computes the interaction of a quantum region with its environment
175
+ through electrostatics, polarization, repulsion, and dispersion, with its contributions to the Fock matrix and to the
176
+ gradients and Hessians of the energy. The computationally intensive parts run in a compiled C++ engine. Contributed by
177
+ Jonas Vester with support from Georg Berger.
178
+ - A quantum chemistry program hands PyFraME its integrals through an integral driver: any class with the three methods
179
+ of `pyframe.IntegralDriver`, or a subclass of `pyframe.IntegralDriverTemplate`. Type checkers such as mypy check a
180
+ driver against `IntegralDriver`, so a missing or mistyped method shows before the program is run.
181
+ - Induced dipole solvers (JI-DIIS, DC-JI, and DC-JI-DIIS). Contributed by Toke Nørremølle Heegaard.
182
+ - Lennard-Jones repulsion and dispersion, with separate parameters for each and a choice of combination rules.
183
+ - Potentials from molecular dynamics: `Trajectory` reads a trajectory using MDAnalysis and builds a potential for every
184
+ frame, with the regions given as MDAnalysis atom selections. A region can be narrowed down to the fragments within a
185
+ distance of a reference, e.g. the water around a solute, measured across the periodic boundary if asked for.
186
+ Fragments can be split into named parts, e.g. a lipid into its head group and tails, with `split_fragments`.
187
+ - A JSON potential format that holds everything an embedding calculation needs. A molecular system can also be passed
188
+ to an embedding calculation directly, without a file.
189
+ - The quantum region includes its link or capping atoms, whose basis set can be chosen separately from the other atoms.
190
+ - Control over where PyFraME's messages go, to the console, to log files, or to memory (`pyframe.configure_logging`).
191
+ - More control over how jobs are run: the MPI command, the host, and commands to run before each job can be set, and
192
+ connections can be verified before a run.
193
+ - A dry run, `create_embedding_potential(only_create_inputs=True)`, which writes the input files and run scripts
194
+ without running anything.
195
+ - Files written by PyFraME record the version that wrote them.
196
+ - Ready-built packages for Linux (x86_64 and aarch64) and macOS (Apple silicon) for Python 3.11 to 3.14, so no compiler
197
+ is needed to install PyFraME there.
198
+ - PyFraME is marked as typed, so type checkers such as mypy and pyright check scripts against the types of its
199
+ functions and classes.
200
+ - Host programs and scripts can list the parameter sets shipped with PyFraME and describe each, with the fragments it
201
+ covers and its parameters (`pyframe.available_parameter_sets` and `pyframe.describe_parameter_set`).
202
+ - Lipids of `alep` (DMPC, POPC, and POPS) can be selected whole, e.g. `'resname POPC'`, in a region shared with other
203
+ molecules: the parameter set splits them and sets their exclusions, so they need neither splitting by hand nor MFCC
204
+ settings of their own. A lipid split by hand is corrected to the charge of the whole lipid.
205
+ - A parameter set of one's own can state the exclusions of its fragments and assemble fragments from parts, with
206
+ `# exclusion:` and `# parts:` lines above its header.
207
+ - The citation names all the authors of PyFraME, and is also given in `CITATION.cff`, which reference managers and
208
+ other tools read citation metadata from.
209
+
210
+ ### Changed
211
+ - PyFraME is licensed under the Mozilla Public License 2.0 instead of the GPLv3+.
212
+ - Python 3.11 or newer is required. MDAnalysis, mpi4py, scikit-learn, QCElemental, and Fabric are new requirements,
213
+ and Dalton support is optional (`pip install pyframe[dalton]`). An MPI library is needed only for parallel embedding
214
+ calculations, and building from source needs a C++ compiler with OpenMP and the Eigen library.
215
+ - Parameter set files name the component and unit of each column, e.g. `M_000[e]` or `epsilon[kJ/mol]`. Files in the
216
+ old format are rejected; the bundled ones have been converted.
217
+ - Several names have changed, and scripts that use them need updating:
218
+ - Standard potentials are now called parameter sets: `use_standard_potentials`, `standard_potential_model`, and
219
+ `standard_potential_exclusion_type` are now `use_parameter_set`, `parameter_set`, and
220
+ `parameter_set_exclusion_type`. An old name is refused with an error that gives the new one.
221
+ - `Project` is now `CreatePotential`.
222
+ - `Potential` and `PotentialDict` are now `pyframe.Site` and `pyframe.SiteList`. Sites are numbered from zero
223
+ (potential files still count from one), their multipoles and polarizabilities are arrays instead of `M0`, `P11`,
224
+ and similar attributes, and `repulsion` and `dispersion` replace `sigma` and `epsilon`.
225
+ - Atoms and fragments can no longer be changed in place. `copy_with` makes a changed copy, and
226
+ `add_hydrogen_links` and `add_cap_links` are now `with_hydrogen_links` and `with_cap_atoms`, which return a new
227
+ fragment.
228
+ - `FragmentDict` is removed. Fragments are held in read-only mappings keyed by the index of their residue, as
229
+ `Fragment.index` gives it, rather than by a name such as `10_A_ILE`.
230
+ - Bonds between fragments are in the `topology` of a snapshot instead of `Fragment.bonded_fragments`, and MFCC belongs
231
+ to the region instead of the fragment: `Region.create_mfcc_fragments`, `Region.capped_fragments`, and
232
+ `Region.concaps` replace their `Fragment` counterparts. `Fragment.region` is removed, since a fragment can be in
233
+ more than one region, and a cap can span several fragments.
234
+ - `number_of_atoms` is now `num_atoms`, `analyse_bonding` is now `analyze_bonding`, and `omp_threads` is now
235
+ `omp_num_threads`.
236
+ - The default parameter set is `pyframe-2026` instead of `sep`: the amino acids of `cp3`, the water, solvents, and ions
237
+ of `sep`, and the lipids of `alep`, so a protein in a membrane with its solvent and ions can be a single region.
238
+ - In `sep`, phenol is `PHN` instead of `PHE`, which is phenylalanine; rename the residue where phenol is called `PHE`.
239
+ - Environment sites where the core region cuts a bond are adjusted: a site replaced by a capping atom is removed, and
240
+ sites close to a link atom move their charge and polarizability to the rest of their region.
241
+ - Fragment charges are rounded to the nearest integer.
242
+ - Running the fragment calculations is more robust: results come back in order, a run whose workers have died stops
243
+ with an error instead of hanging, paths with spaces work, and a job stops at its first failing command. The
244
+ communication port is chosen automatically, and a scratch directory is looked for under `$SCRATCH` and `/scratch`
245
+ first.
246
+ - PyFraME reports through Python's logging instead of printing, and importing it prints nothing.
247
+ - The fragment calculations are named after the index of the residue of their fragment, e.g.
248
+ `fragment-9_dalton_multipoles.out`, and a file `fragments.txt` beside them says which fragment each is of, so the
249
+ calculations of a work directory of 0.4 are run again. Messages about a fragment say where to find it, e.g.
250
+ `ILE 10, chain A, resindex 9, atoms index 120:138`.
251
+
252
+ ### Removed
253
+ - `MolecularSystem`: a structure is read as a `Trajectory` of one frame, and regions are given as MDAnalysis atom
254
+ selections. [Moving from MolecularSystem](README.md#moving-from-molecularsystem) lists what replaces each call.
255
+
256
+ ### Fixed
257
+ - PDB and PQR files with more than 9999 residues, where residue numbers repeat, are read correctly.
258
+ - The elements of HSD and HSE residues are recognized.
259
+ - SSH jobs no longer fail on hosts that are not yet known; their host keys are accepted automatically.
260
+ - MFCC could leave some lone atoms out; proteins at the default MFCC order of 2 were not affected.
261
+ - PDE calculations could take the fragment densities from the wrong calculation.
262
+ - Writing the core region removed the atoms replaced by caps from the environment.
263
+ - Writing a potential file changed the sites' exclusion lists.
264
+ - A core region without fragments gave an unclear error.
265
+ - A potential built from parameter sets alone no longer leaves an empty directory for every snapshot, and the core can
266
+ be written before the potential, since `write_core` and `write_potential` make the directory they write into.
267
+
268
+ ## [0.4.0] 2021-06-07
269
+ ### Added
270
+ - Added a `get_remaining_fragments` method to the `MolecularSystem` class that will return all remaining fragments.
271
+ - Added AMBER Lipid14 and Lipid17 charges.
272
+
273
+ ### Changed
274
+ - Reduced cost of PDE calculations by combining the SCFs used to calculate polarizability and fragment densities.
275
+ - Region options, '*x*\_program', '*x*\_method', '*x*\_xcfun', and '*x*\_basis', where *x* can be multipoles,
276
+ polarizabilites, etc., have been unified to single options 'program', 'method', 'xcfun', and 'basis', that
277
+ apply to all properties associated with a given region. All unused '*x*\_model' properties have been removed.
278
+ - Regular expressions can now be used for selecting atoms for new fragment definitions when splitting fragments.
279
+ - Minimum requirement changed to Python 3.7 (though Python 3.6 should still work but is not guaranteed
280
+ starting from this release).
281
+ - Redistribute surplus charge of non-MFCC standard potential fragments if total fragment charge is not integer.
282
+
283
+ ### Fixed
284
+ - Process jobs without ssh when using only a single local machine. This fixes problems with job processing
285
+ that were present on some linux configurations.
286
+ - Reset of the molecular system.
287
+ - IndexError exception that would occur when a charge is missing (i.e. because it is zero).
288
+ - Adjusted averaged lipid embedding parameters to make the total charge integer (was off by -4e-5).
289
+ - Raise Exception when trying to read empty or non-existent Dalton LoProp output file.
290
+
291
+ ## [0.3.0] 2020-05-11
292
+ ### Added
293
+ - Polarizable density embedding (PDE) model.
294
+ - see https://doi.org/10.1021/jp510138k and https://doi.org/10.1021/acs.jpclett.7b02788 for details.
295
+ - Print license (`pyframe.print_license()`).
296
+ - Added [contributing guidelines](https://gitlab.com/pyframe-project/pyframe/-/blob/master/CONTRIBUTING.md).
297
+ - Cost-effective polarizable protein potential (CP3).
298
+ - see https://doi.org/10.1021/acs.jctc.9b00616 for details
299
+ - The PDB input file reader will now try to guess the element based on the atom name, when the element field is missing.
300
+
301
+ ### Fixed
302
+ - Settings, i.e. method, basis set, etc., when computing polarizabilities
303
+ separately from multipoles using Dalton LoProp have been fixed.
304
+ - Fixed bug that in some cases resulted in corrupt core regions when it consisted of two
305
+ fragments or more.
306
+
307
+ ### Changed
308
+ - Minimum requirement changed to Python 3.6.
309
+ - Allow extracting fragments with a single item, e.g. system.get\_fragments\_by\_chain\_id('P'),
310
+ where it was required to always use lists before.
311
+ - Remove use of Numba and instead use SciPy and NumPy only.
312
+
313
+ ## [0.2.0] - 2018-10-03
314
+ ### Added
315
+ - Moved the suggested BibTeX snippet into the [CITATION
316
+ file](https://gitlab.com/pyframe-project/pyframe/-/blob/master/CITATION).
317
+ - Added sodium and chloride charge and isotropic polarizability to
318
+ solvent embedding potential.
319
+ - Added calcium, magnesium, potassium, zinc, and bromine charge and
320
+ isotropic polarizability to solvent embedding potential.
321
+ - New option to choose exclusion type for standard potentials.
322
+ Currently it can be either 'fragment', which excludes all
323
+ interactions within a fragment, or 'mfcc', which is the MFCC type
324
+ exclusions.
325
+ - Added AMBER ff94 and ff03 standard potentials.
326
+ - Improve element recognition.
327
+ - Surplus charge of a region treated using MFCC is now redistributed
328
+ among all sites in the affected region, ensuring that the sum of
329
+ partial charges is equal to the formal charge of the region.
330
+ - Added averaged lipid embedding parameters from S. Witzke et al.
331
+ J. Comput. Chem. 38 (2017) 601-611.
332
+
333
+ ### Fixed
334
+ - Fixed wrong asserts which would have caused errors if octopoles or
335
+ higher were requested.
336
+ - All polarizabilities up to octopole-octopole are now present.
337
+ - Errors when using CAM-B3LYP in serial Dalton calculations (which now
338
+ always use `.DIRECT`).
339
+ - Error when LD\_LIBRARY\_PATH environment variable was not set.
340
+ - Fixed erroneous exclusion lists when different parts of a molecule,
341
+ e.g. protein, are placed in different regions.
342
+ - Radius of Li, Na, Mg, K, and Ca (used in bond detection) adjusted to
343
+ the effective ionic radius by R. D. Shannon, Acta. Cryst. A32 (1976), 751.
344
+ - Naming bug when adding hydrogen-link atoms where the donor-atom name
345
+ would erroneously have _link_ appended to it.
346
+
347
+ ### Changed
348
+ - Running the test suite now requires pytest (unittests can be run by typing `pytest --pyargs pyframe`).
349
+ - The default bond detection threshold factor has been set to 1.15 instead of 1.2.
350
+ - Improved error message when there is a mismatch between the number of sites in
351
+ an output file compared to the number of sites in the fragment read in from input.
352
+ - Default is now to first try to find a free communication port.
353
+
354
+ ## [0.1.1] - 2018-02-08
355
+ ### Changed
356
+ - There is now a check for empty output files from fragment
357
+ calculations to prevent deletion of subdirectories of failed
358
+ fragment calculations.
359
+ - Now hydrogen caps between core region and other regions are always
360
+ used.
361
+ - Efficiency-related changes:
362
+ - compute angles, distances, distance matrices using Numba jit
363
+ decorator (introduces Numba dependency and removes SciPy dependency).
364
+ - removed some unnecessary property decorators.
365
+ - Refactored the atoms module (faster and safer).
366
+
367
+ ### Fixed
368
+ - Bug in MOLCAS LoProp ('Fragment' object has no attribute 'xyz').
369
+ - Using Dalton LoProp with multipole orders lower than two no longer
370
+ fails.
371
+ - Bug in charge redistribution where negative surplus charge would not
372
+ be redistributed.
373
+
374
+ ## [0.1.0] - 2017-02-20
375
+ ### Added
376
+ - Initial version.
@@ -1,6 +1,6 @@
1
- @misc{pyframe:0.5.1,
1
+ @misc{pyframe:0.6.0,
2
2
  author = {Olsen, J. M. H. and Reinholdt, P. and Vester, J. and Heegaard, T. N. and Berger, G.},
3
- title = {{PyFraME}: {P}ython framework for {F}ragment-based {M}ultiscale {E}mbedding (version 0.5.1)},
3
+ title = {{PyFraME}: {P}ython framework for {F}ragment-based {M}ultiscale {E}mbedding (version 0.6.0)},
4
4
  year = {2026},
5
- doi = {10.5281/zenodo.23496949},
5
+ doi = {10.5281/zenodo.24406807},
6
6
  note = {See https://gitlab.com/pyframe-project/pyframe}}
@@ -2,13 +2,13 @@ cff-version: 1.2.0
2
2
  message: If you use PyFraME, please cite the version you used as below.
3
3
  title: "PyFraME: Python framework for Fragment-based Multiscale Embedding"
4
4
  type: software
5
- version: 0.5.1
6
- date-released: "2026-10-20"
7
- doi: 10.5281/zenodo.23496949
5
+ version: 0.6.0
6
+ date-released: "2026-11-20"
7
+ doi: 10.5281/zenodo.24406807
8
8
  identifiers:
9
9
  - type: doi
10
- value: 10.5281/zenodo.23496949
11
- description: This version, 0.5.1.
10
+ value: 10.5281/zenodo.24406807
11
+ description: This version, 0.6.0.
12
12
  - type: doi
13
13
  value: 10.5281/zenodo.775113
14
14
  description: All versions, resolving to the latest.
@@ -0,0 +1,49 @@
1
+ PyFraME Contributors
2
+ ====================
3
+
4
+ The following people have contributed to PyFraME (chronologically ordered):
5
+
6
+ - Jógvan Magnus Haugaard Olsen (2017)
7
+ - Peter Reinholdt (2018)
8
+ - Jonas Vester (2023)
9
+ - Toke Nørremølle Heegaard (2024)
10
+ - Georg Berger (2024)
11
+
12
+ Years indicate the first recorded contribution.
13
+
14
+
15
+ Areas of contribution
16
+ ---------------------
17
+
18
+ The areas below highlight contributions. Names follow the order above;
19
+ areas overlap and do not indicate exclusive ownership.
20
+
21
+ Potential construction and fragmentation
22
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23
+
24
+ - Jógvan Magnus Haugaard Olsen
25
+ - Peter Reinholdt
26
+
27
+ Embedding models and interfaces
28
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
29
+
30
+ - Jógvan Magnus Haugaard Olsen
31
+ - Jonas Vester
32
+
33
+ Numerical engine and solvers
34
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35
+
36
+ - Jógvan Magnus Haugaard Olsen
37
+ - Jonas Vester
38
+ - Toke Nørremølle Heegaard
39
+ - Georg Berger
40
+
41
+ Maintenance and documentation
42
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
43
+
44
+ - Jógvan Magnus Haugaard Olsen
45
+ - Peter Reinholdt
46
+ - Jonas Vester
47
+
48
+ These areas include implementation, testing, and supporting documentation.
49
+ See CHANGELOG.md for release notes.