pyobjcryst 2.2.6__tar.gz → 2025.1.0rc0__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 (165) hide show
  1. pyobjcryst-2025.1.0rc0/AUTHORS.rst +13 -0
  2. pyobjcryst-2025.1.0rc0/LICENSE-DANSE.rst +45 -0
  3. pyobjcryst-2025.1.0rc0/LICENSE.rst +141 -0
  4. pyobjcryst-2025.1.0rc0/MANIFEST.in +14 -0
  5. pyobjcryst-2025.1.0rc0/PKG-INFO +201 -0
  6. pyobjcryst-2025.1.0rc0/README.rst +165 -0
  7. pyobjcryst-2025.1.0rc0/pyproject.toml +97 -0
  8. pyobjcryst-2025.1.0rc0/requirements/build.txt +0 -0
  9. pyobjcryst-2025.1.0rc0/requirements/conda.txt +11 -0
  10. pyobjcryst-2025.1.0rc0/requirements/docs.txt +5 -0
  11. pyobjcryst-2025.1.0rc0/requirements/pip.txt +2 -0
  12. pyobjcryst-2025.1.0rc0/requirements/tests.txt +6 -0
  13. pyobjcryst-2025.1.0rc0/setup.py +119 -0
  14. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/crystal_ext.cpp +5 -5
  15. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/diffractiondatasinglecrystal_ext.cpp +85 -2
  16. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/molecule_ext.cpp +19 -0
  17. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/refinableobjclock_ext.cpp +1 -1
  18. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/refinablepar_ext.cpp +1 -1
  19. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst/__init__.py +25 -19
  20. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst/atom.py +2 -3
  21. pyobjcryst-2025.1.0rc0/src/pyobjcryst/crystal.py +1059 -0
  22. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst/diffractiondatasinglecrystal.py +15 -9
  23. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst/fourier.py +57 -24
  24. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst/general.py +7 -4
  25. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst/globaloptim.py +105 -48
  26. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst/globals.py +23 -12
  27. pyobjcryst-2025.1.0rc0/src/pyobjcryst/indexing.py +169 -0
  28. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst/io.py +29 -14
  29. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst/lsq.py +4 -4
  30. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst/molecule.py +45 -30
  31. pyobjcryst-2025.1.0rc0/src/pyobjcryst/polyhedron.py +41 -0
  32. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst/powderpattern.py +269 -137
  33. pyobjcryst-2025.1.0rc0/src/pyobjcryst/pyobjcryst_app.py +33 -0
  34. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst/radiation.py +2 -4
  35. pyobjcryst-2025.1.0rc0/src/pyobjcryst/refinableobj.py +194 -0
  36. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst/reflectionprofile.py +3 -5
  37. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst/scatterer.py +2 -3
  38. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst/scatteringdata.py +2 -2
  39. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst/scatteringpower.py +16 -11
  40. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst/scatteringpowersphere.py +3 -3
  41. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst/spacegroup.py +3 -4
  42. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst/unitcell.py +3 -3
  43. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst/utils.py +12 -9
  44. pyobjcryst-2025.1.0rc0/src/pyobjcryst/version.py +30 -0
  45. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst/zscatterer.py +19 -13
  46. pyobjcryst-2025.1.0rc0/src/pyobjcryst.egg-info/PKG-INFO +201 -0
  47. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst.egg-info/SOURCES.txt +54 -52
  48. pyobjcryst-2025.1.0rc0/src/pyobjcryst.egg-info/entry_points.txt +2 -0
  49. pyobjcryst-2025.1.0rc0/src/pyobjcryst.egg-info/requires.txt +2 -0
  50. pyobjcryst-2025.1.0rc0/tests/conftest.py +41 -0
  51. pyobjcryst-2.2.6/src/pyobjcryst/tests/pyobjcrysttest.py → pyobjcryst-2025.1.0rc0/tests/pyobjcryst_test_mem.py +23 -12
  52. pyobjcryst-2.2.6/src/pyobjcryst/tests/testcif.py → pyobjcryst-2025.1.0rc0/tests/test_cif.py +81 -111
  53. pyobjcryst-2.2.6/src/pyobjcryst/tests/testclocks.py → pyobjcryst-2025.1.0rc0/tests/test_clocks.py +11 -13
  54. pyobjcryst-2.2.6/src/pyobjcryst/tests/testconverters.py → pyobjcryst-2025.1.0rc0/tests/test_converters.py +8 -5
  55. pyobjcryst-2.2.6/src/pyobjcryst/tests/testcrystal.py → pyobjcryst-2025.1.0rc0/tests/test_crystal.py +18 -11
  56. pyobjcryst-2.2.6/src/pyobjcryst/tests/testglobaloptim.py → pyobjcryst-2025.1.0rc0/tests/test_globaloptim.py +20 -16
  57. pyobjcryst-2.2.6/src/pyobjcryst/tests/testindexing.py → pyobjcryst-2025.1.0rc0/tests/test_indexing.py +76 -20
  58. pyobjcryst-2.2.6/src/pyobjcryst/tests/testlsq.py → pyobjcryst-2025.1.0rc0/tests/test_lsq.py +18 -14
  59. pyobjcryst-2.2.6/src/pyobjcryst/tests/testmolecule.py → pyobjcryst-2025.1.0rc0/tests/test_molecule.py +67 -49
  60. pyobjcryst-2.2.6/src/pyobjcryst/tests/testpowderpattern.py → pyobjcryst-2025.1.0rc0/tests/test_powderpattern.py +47 -22
  61. pyobjcryst-2.2.6/src/pyobjcryst/tests/testradiation.py → pyobjcryst-2025.1.0rc0/tests/test_radiation.py +10 -9
  62. pyobjcryst-2.2.6/src/pyobjcryst/tests/testrefinableobj.py → pyobjcryst-2025.1.0rc0/tests/test_refinableobj.py +31 -24
  63. pyobjcryst-2025.1.0rc0/tests/test_single_crystal_data.py +63 -0
  64. pyobjcryst-2.2.6/src/pyobjcryst/tests/testspacegroup.py → pyobjcryst-2025.1.0rc0/tests/test_spacegroup.py +3 -6
  65. pyobjcryst-2.2.6/src/pyobjcryst/tests/testutils.py → pyobjcryst-2025.1.0rc0/tests/test_utils.py +11 -7
  66. pyobjcryst-2025.1.0rc0/tests/test_version.py +15 -0
  67. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/BaTiO3.cif +3 -3
  68. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/lidocainementhol.cif +2 -2
  69. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/paracetamol.cif +1 -1
  70. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/paracetamol_monomethanolate.cif +1 -1
  71. pyobjcryst-2.2.6/src/pyobjcryst/tests/pyobjcrysttestutils.py → pyobjcryst-2025.1.0rc0/tests/testutils.py +23 -32
  72. pyobjcryst-2.2.6/AUTHORS.txt +0 -10
  73. pyobjcryst-2.2.6/LICENSE.txt +0 -137
  74. pyobjcryst-2.2.6/LICENSE_DANSE.txt +0 -33
  75. pyobjcryst-2.2.6/MANIFEST.in +0 -16
  76. pyobjcryst-2.2.6/PKG-INFO +0 -245
  77. pyobjcryst-2.2.6/README.rst +0 -209
  78. pyobjcryst-2.2.6/SConstruct +0 -239
  79. pyobjcryst-2.2.6/pyproject.toml +0 -4
  80. pyobjcryst-2.2.6/setup.py +0 -211
  81. pyobjcryst-2.2.6/src/extensions/SConscript +0 -63
  82. pyobjcryst-2.2.6/src/extensions/SConscript.configure +0 -94
  83. pyobjcryst-2.2.6/src/pyobjcryst/crystal.py +0 -649
  84. pyobjcryst-2.2.6/src/pyobjcryst/indexing.py +0 -101
  85. pyobjcryst-2.2.6/src/pyobjcryst/polyhedron.py +0 -32
  86. pyobjcryst-2.2.6/src/pyobjcryst/refinableobj.py +0 -161
  87. pyobjcryst-2.2.6/src/pyobjcryst/tests/__init__.py +0 -76
  88. pyobjcryst-2.2.6/src/pyobjcryst/tests/debug.py +0 -30
  89. pyobjcryst-2.2.6/src/pyobjcryst/tests/run.py +0 -31
  90. pyobjcryst-2.2.6/src/pyobjcryst/version.cfg +0 -6
  91. pyobjcryst-2.2.6/src/pyobjcryst/version.py +0 -74
  92. pyobjcryst-2.2.6/src/pyobjcryst.egg-info/PKG-INFO +0 -245
  93. pyobjcryst-2.2.6/src/pyobjcryst.egg-info/not-zip-safe +0 -1
  94. pyobjcryst-2.2.6/src/pyobjcryst.egg-info/requires.txt +0 -16
  95. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/setup.cfg +0 -0
  96. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/asymmetricunit_ext.cpp +0 -0
  97. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/atom_ext.cpp +0 -0
  98. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/general_ext.cpp +0 -0
  99. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/globaloptim_ext.cpp +0 -0
  100. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/globalscatteringpower_ext.cpp +0 -0
  101. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/helpers.cpp +0 -0
  102. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/helpers.hpp +0 -0
  103. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/indexing_ext.cpp +0 -0
  104. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/io_ext.cpp +0 -0
  105. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/lsq_ext.cpp +0 -0
  106. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/molatom_ext.cpp +0 -0
  107. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/molbond_ext.cpp +0 -0
  108. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/molbondangle_ext.cpp +0 -0
  109. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/moldihedralangle_ext.cpp +0 -0
  110. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/objregistry_ext.cpp +0 -0
  111. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/polyhedron_ext.cpp +0 -0
  112. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/powderpattern_ext.cpp +0 -0
  113. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/powderpatternbackground_ext.cpp +0 -0
  114. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/powderpatterncomponent_ext.cpp +0 -0
  115. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/powderpatterndiffraction_ext.cpp +0 -0
  116. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/pyobjcryst.cpp +0 -0
  117. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/pyobjcryst_numpy_setup.hpp +0 -0
  118. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/python_streambuf.cpp +0 -0
  119. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/python_streambuf.hpp +0 -0
  120. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/quaternion_ext.cpp +0 -0
  121. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/radiation_ext.cpp +0 -0
  122. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/refinableobj_ext.cpp +0 -0
  123. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/reflectionprofile_ext.cpp +0 -0
  124. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/refobjopt_ext.cpp +0 -0
  125. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/refpartype_ext.cpp +0 -0
  126. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/registerconverters.cpp +0 -0
  127. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/restraint_ext.cpp +0 -0
  128. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/rigidgroup_ext.cpp +0 -0
  129. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/scatterer_ext.cpp +0 -0
  130. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/scatteringcomponent_ext.cpp +0 -0
  131. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/scatteringcomponentlist_ext.cpp +0 -0
  132. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/scatteringdata_ext.cpp +0 -0
  133. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/scatteringpower_ext.cpp +0 -0
  134. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/scatteringpoweratom_ext.cpp +0 -0
  135. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/scatteringpowersphere_ext.cpp +0 -0
  136. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/spacegroup_ext.cpp +0 -0
  137. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/stretchmode_ext.cpp +0 -0
  138. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/unitcell_ext.cpp +0 -0
  139. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/zatom_ext.cpp +0 -0
  140. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/zpolyhedron_ext.cpp +0 -0
  141. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/extensions/zscatterer_ext.cpp +0 -0
  142. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst.egg-info/dependency_links.txt +0 -0
  143. {pyobjcryst-2.2.6 → pyobjcryst-2025.1.0rc0}/src/pyobjcryst.egg-info/top_level.txt +0 -0
  144. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/Ag_silver.cif +0 -0
  145. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/C_graphite_hex.cif +0 -0
  146. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/CaF2_fluorite.cif +0 -0
  147. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/CaTiO3.cif +0 -0
  148. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/CdSe_cadmoselite.cif +0 -0
  149. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/CeO2.cif +0 -0
  150. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/NaCl.cif +0 -0
  151. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/Ni.cif +0 -0
  152. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/PbS_galena.cif +0 -0
  153. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/PbTe.cif +0 -0
  154. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/Si.cif +0 -0
  155. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/Si_setting2.cif +0 -0
  156. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/SrTiO3_tausonite.cif +0 -0
  157. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/TiO2_anatase.cif +0 -0
  158. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/TiO2_rutile.cif +0 -0
  159. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/ZnS_sphalerite.cif +0 -0
  160. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/ZnS_wurtzite.cif +0 -0
  161. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/Zn_zinc.cif +0 -0
  162. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/caffeine.cif +0 -0
  163. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/cime.fhz +0 -0
  164. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/ni.stru +0 -0
  165. {pyobjcryst-2.2.6/src/pyobjcryst → pyobjcryst-2025.1.0rc0}/tests/testdata/paracetamol_monomethanolate_data_single_crystal.cif +0 -0
@@ -0,0 +1,13 @@
1
+ Authors
2
+ =======
3
+
4
+ Christopher L. Farrow,
5
+ Pavol Juhas,
6
+ Simon J.L. Billinge,
7
+ Vincent Favre-Nicolin
8
+
9
+ Contributors
10
+ ------------
11
+
12
+ For a list of contributors, visit
13
+ https://github.com/diffpy/pyobjcryst/graphs/contributors
@@ -0,0 +1,45 @@
1
+ LICENSE
2
+ =======
3
+
4
+ This program is part of the DiffPy and DANSE open-source projects
5
+ and is available subject to the conditions and terms laid out below.
6
+
7
+ Copyright (c) 2009-2012, The Trustees of Columbia University in
8
+ the City of New York. All rights reserved.
9
+
10
+ For more information please visit the project web-page:
11
+
12
+ http://www.diffpy.org/
13
+
14
+ or email Prof. Simon Billinge at sb2896@columbia.edu
15
+
16
+ Redistribution and use in source and binary forms, with or without
17
+ modification, are permitted provided that the following conditions
18
+ are met:
19
+
20
+ - Redistributions of source code must retain the above copyright
21
+ notice, this list of conditions and the following disclaimer.
22
+
23
+ - Redistributions in binary form must reproduce the above copyright
24
+ notice, this list of conditions and the following disclaimer in the
25
+ documentation and/or other materials provided with the distribution.
26
+
27
+ - Neither the name of the copyright holder nor the names of its
28
+ contributors may be used to endorse or promote products derived from
29
+ this software without specific prior written permission.
30
+
31
+ THIS SOFTWARE IS PROVIDED BY COPYRIGHT HOLDER "AS IS". COPYRIGHT HOLDER
32
+ EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES AND CONDITIONS, EITHER
33
+ EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
34
+ WARRANTIES OF MERCHANTABILITY, TITLE, FITNESS, ADEQUACY OR SUITABILITY
35
+ FOR A PARTICULAR PURPOSE, AND ANY WARRANTIES OF FREEDOM FROM
36
+ INFRINGEMENT OF ANY DOMESTIC OR FOREIGN PATENT, COPYRIGHTS, TRADE
37
+ SECRETS OR OTHER PROPRIETARY RIGHTS OF ANY PARTY. IN NO EVENT SHALL
38
+ COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR ANY DIRECT, INDIRECT,
39
+ INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
40
+ NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
41
+ USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
42
+ ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
43
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
44
+ THIS SOFTWARE OR RELATING TO THIS AGREEMENT, EVEN IF ADVISED OF THE
45
+ POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,141 @@
1
+ OPEN SOURCE LICENSE AGREEMENT
2
+ =============================
3
+
4
+ Copyright (c) 2009-2011, University of Tennessee
5
+
6
+ Copyright (c) 1989, 1991 Free Software Foundation, Inc.
7
+
8
+ Copyright (c) 2006, The Regents of the University of California through Lawrence Berkeley National Laboratory
9
+
10
+ Copyright (c) 2014, Australian Synchrotron Research Program Inc., ("ASRP")
11
+
12
+ Copyright (c) 2006-2007, Board of Trustees of Michigan State University
13
+
14
+ Copyright (c) 2008-2012, The Trustees of Columbia University in the City of New York
15
+
16
+ Copyright (c) 2014-2019, Brookhaven Science Associates, Brookhaven National Laboratory
17
+
18
+ Copyright (c) 2024-2025, The Trustees of Columbia University in the City of New York.
19
+ All rights reserved.
20
+
21
+ The "DiffPy-CMI" is distributed subject to the following license conditions:
22
+
23
+ .. code-block:: text
24
+
25
+ SOFTWARE LICENSE AGREEMENT
26
+
27
+ Software: DiffPy-CMI
28
+
29
+
30
+ (1) The "Software", below, refers to the aforementioned DiffPy-CMI (in either
31
+ source code, or binary form and accompanying documentation).
32
+
33
+ Part of the software was derived from the DANSE, ObjCryst++ (with permission),
34
+ PyCifRW, Python periodictable, CCTBX, and SasView open source projects, of
35
+ which the original Copyrights are contained in each individual file.
36
+
37
+ Each licensee is addressed as "you" or "Licensee."
38
+
39
+
40
+ (2) The copyright holders shown above and their third-party Licensors hereby
41
+ grant licensee a royalty-free nonexclusive license, subject to the limitations
42
+ stated herein and U.S. Government license rights.
43
+
44
+
45
+ (3) You may modify and make a copy or copies of the software for use within
46
+ your organization, if you meet the following conditions:
47
+
48
+ (a) Copies in source code must include the copyright notice and this
49
+ software license agreement.
50
+
51
+ (b) Copies in binary form must include the copyright notice and this
52
+ Software License Agreement in the documentation and/or other materials
53
+ provided with the copy.
54
+
55
+
56
+ (4) You may modify a copy or copies of the Software or any portion of it, thus
57
+ forming a work based on the Software, and distribute copies of such work
58
+ outside your organization, if you meet all of the following conditions:
59
+
60
+ (a) Copies in source code must include the copyright notice and this
61
+ Software License Agreement;
62
+
63
+ (b) Copies in binary form must include the copyright notice and this
64
+ Software License Agreement in the documentation and/or other materials
65
+ provided with the copy;
66
+
67
+ (c) Modified copies and works based on the Software must carry prominent
68
+ notices stating that you changed specified portions of the Software.
69
+
70
+ (d) Neither the name of Brookhaven Science Associates or Brookhaven
71
+ National Laboratory nor the names of its contributors may be used to
72
+ endorse or promote products derived from this software without specific
73
+ written permission.
74
+
75
+
76
+ (5) Portions of the Software resulted from work developed under a U.S.
77
+ Government contract and are subject to the following license:
78
+ The Government is granted for itself and others acting on its behalf a
79
+ paid-up, nonexclusive, irrevocable worldwide license in this computer software
80
+ to reproduce, prepare derivative works, and perform publicly and display
81
+ publicly.
82
+
83
+
84
+ (6) WARRANTY DISCLAIMER. THE SOFTWARE IS SUPPLIED "AS IS" WITHOUT
85
+ WARRANTY OF ANY KIND. THE COPYRIGHT HOLDERS, THEIR THIRD PARTY
86
+ LICENSORS, THE UNITED STATES, THE UNITED STATES DEPARTMENT OF ENERGY, AND
87
+ THEIR EMPLOYEES: (1) DISCLAIM ANY WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
88
+ BUT NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
89
+ PARTICULAR PURPOSE, TITLE OR NON-INFRINGEMENT, (2) DO NOT ASSUME ANY LEGAL
90
+ LIABILITY OR RESPONSIBILITY FOR THE ACCURACY, COMPLETENESS, OR USEFULNESS OF
91
+ THE SOFTWARE, (3) DO NOT REPRESENT THAT USE OF THE SOFTWARE WOULD NOT INFRINGE
92
+ PRIVATELY OWNED RIGHTS, (4) DO NOT WARRANT THAT THE SOFTWARE WILL FUNCTION
93
+ UNINTERRUPTED, THAT IT IS ERROR-FREE OR THAT ANY ERRORS WILL BE CORRECTED.
94
+
95
+
96
+ (7) LIMITATION OF LIABILITY. IN NO EVENT WILL THE COPYRIGHT HOLDERS, THEIR
97
+ THIRD PARTY LICENSORS, THE UNITED STATES, THE UNITED STATES DEPARTMENT OF
98
+ ENERGY, OR THEIR EMPLOYEES: BE LIABLE FOR ANY INDIRECT, INCIDENTAL,
99
+ CONSEQUENTIAL, SPECIAL OR PUNITIVE DAMAGES OF ANY KIND OR NATURE, INCLUDING
100
+ BUT NOT LIMITED TO LOSS OF PROFITS OR LOSS OF DATA, FOR ANY REASON WHATSOEVER,
101
+ WHETHER SUCH LIABILITY IS ASSERTED ON THE BASIS OF CONTRACT, TORT (INCLUDING
102
+ NEGLIGENCE OR STRICT LIABILITY), OR OTHERWISE, EVEN IF ANY OF SAID PARTIES HAS
103
+ BEEN WARNED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGES.
104
+
105
+
106
+ Brookhaven National Laboratory Notice
107
+ =====================================
108
+
109
+ Acknowledgment of sponsorship
110
+ -----------------------------
111
+
112
+ This software was produced by the Brookhaven National Laboratory, under
113
+ Contract DE-AC02-98CH10886 with the Department of Energy.
114
+
115
+
116
+ Government disclaimer of liability
117
+ ----------------------------------
118
+
119
+ Neither the United States nor the United States Department of Energy, nor
120
+ any of their employees, makes any warranty, express or implied, or assumes
121
+ any legal liability or responsibility for the accuracy, completeness, or
122
+ usefulness of any data, apparatus, product, or process disclosed, or
123
+ represents that its use would not infringe privately owned rights.
124
+
125
+
126
+ Brookhaven disclaimer of liability
127
+ ----------------------------------
128
+
129
+ Brookhaven National Laboratory makes no representations or warranties,
130
+ express or implied, nor assumes any liability for the use of this software.
131
+
132
+
133
+ Maintenance of notice
134
+ ---------------------
135
+
136
+ In the interest of clarity regarding the origin and status of this
137
+ software, Brookhaven National Laboratory requests that any recipient of it
138
+ maintain this notice affixed to any distribution by the recipient that
139
+ contains a copy or derivative of this software.
140
+
141
+ END OF LICENSE
@@ -0,0 +1,14 @@
1
+ graft src
2
+ graft tests
3
+ graft requirements
4
+
5
+ include AUTHORS.rst LICENSE*.rst README.rst
6
+
7
+ # Exclude all bytecode files and __pycache__ directories
8
+ global-exclude *.py[cod] # Exclude all .pyc, .pyo, and .pyd files.
9
+ global-exclude *.so # Exclude shared object files.
10
+ global-exclude .DS_Store # Exclude Mac filesystem artifacts.
11
+ global-exclude __pycache__ # Exclude Python cache directories.
12
+ global-exclude .git* # Exclude git files and directories.
13
+ global-exclude .idea # Exclude PyCharm project settings.
14
+ global-exclude SConscript.configure SConscript # SCons build scripts
@@ -0,0 +1,201 @@
1
+ Metadata-Version: 2.4
2
+ Name: pyobjcryst
3
+ Version: 2025.1.0rc0
4
+ Summary: Python bindings to the ObjCryst++ library.
5
+ Author: Christopher Farrow, Pavol Juhás
6
+ Author-email: Vincent-Favre-Nicolin <favre@esrf.fr>
7
+ Maintainer-email: "Simon J.L. Billinge group" <sb2896@columbia.edu>, Vincent-Favre-Nicolin <favre@esrf.fr>
8
+ Project-URL: Homepage, https://github.com/diffpy/pyobjcryst/
9
+ Project-URL: Issues, https://github.com/diffpy/pyobjcryst/issues/
10
+ Keywords: objcryst,atom structure crystallography,powder diffraction
11
+ Classifier: Development Status :: 5 - Production/Stable
12
+ Classifier: Environment :: Console
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: Intended Audience :: Education
15
+ Classifier: Intended Audience :: Science/Research
16
+ Classifier: License :: OSI Approved :: BSD License
17
+ Classifier: Operating System :: MacOS :: MacOS X
18
+ Classifier: Operating System :: Microsoft :: Windows
19
+ Classifier: Operating System :: POSIX
20
+ Classifier: Operating System :: Unix
21
+ Classifier: Programming Language :: C++
22
+ Classifier: Programming Language :: Python :: 3.11
23
+ Classifier: Programming Language :: Python :: 3.12
24
+ Classifier: Programming Language :: Python :: 3.13
25
+ Classifier: Topic :: Scientific/Engineering :: Physics
26
+ Classifier: Topic :: Scientific/Engineering :: Chemistry
27
+ Classifier: Topic :: Software Development :: Libraries
28
+ Requires-Python: <3.14,>=3.11
29
+ Description-Content-Type: text/x-rst
30
+ License-File: LICENSE-DANSE.rst
31
+ License-File: LICENSE.rst
32
+ License-File: AUTHORS.rst
33
+ Requires-Dist: setuptools
34
+ Requires-Dist: numpy
35
+ Dynamic: license-file
36
+
37
+ |Icon| |title|_
38
+ ===============
39
+
40
+ .. |title| replace:: pyobjcryst
41
+ .. _title: https://diffpy.github.io/pyobjcryst
42
+
43
+ .. |Icon| image:: https://avatars.githubusercontent.com/diffpy
44
+ :target: https://diffpy.github.io/pyobjcryst
45
+ :height: 100px
46
+
47
+ |PyPI| |Forge| |PythonVersion| |PR|
48
+
49
+ |CI| |Codecov| |Black| |Tracking|
50
+
51
+ .. |Black| image:: https://img.shields.io/badge/code_style-black-black
52
+ :target: https://github.com/psf/black
53
+
54
+ .. |CI| image:: https://github.com/diffpy/pyobjcryst/actions/workflows/matrix-and-codecov-on-merge-to-main.yml/badge.svg
55
+ :target: https://github.com/diffpy/pyobjcryst/actions/workflows/matrix-and-codecov-on-merge-to-main.yml
56
+
57
+ .. |Codecov| image:: https://codecov.io/gh/diffpy/pyobjcryst/branch/main/graph/badge.svg
58
+ :target: https://codecov.io/gh/diffpy/pyobjcryst
59
+
60
+ .. |Forge| image:: https://img.shields.io/conda/vn/conda-forge/pyobjcryst
61
+ :target: https://anaconda.org/conda-forge/pyobjcryst
62
+
63
+ .. |PR| image:: https://img.shields.io/badge/PR-Welcome-29ab47ff
64
+ :target: https://github.com/diffpy/pyobjcryst/pulls
65
+
66
+ .. |PyPI| image:: https://img.shields.io/pypi/v/pyobjcryst
67
+ :target: https://pypi.org/project/pyobjcryst/
68
+
69
+ .. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/pyobjcryst
70
+ :target: https://pypi.org/project/pyobjcryst/
71
+
72
+ .. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue
73
+ :target: https://github.com/diffpy/pyobjcryst/issues
74
+
75
+ Python bindings to ObjCryst++, the Object-Oriented Crystallographic Library.
76
+
77
+
78
+ For more information about the pyobjcryst library, please consult our `online documentation <https://diffpy.github.io/pyobjcryst>`_.
79
+
80
+ Citation
81
+ --------
82
+
83
+ If you use pyobjcryst in a scientific publication, we would like you to cite this package as
84
+
85
+ pyobjcryst Package, https://github.com/diffpy/pyobjcryst
86
+
87
+ Installation
88
+ ------------
89
+
90
+ The preferred method is to use `Miniconda Python
91
+ <https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html>`_
92
+ and install from the "conda-forge" channel of Conda packages.
93
+
94
+ To add "conda-forge" to the conda channels, run the following in a terminal. ::
95
+
96
+ conda config --add channels conda-forge
97
+
98
+ We want to install our packages in a suitable conda environment.
99
+ The following creates and activates a new environment named ``pyobjcryst_env`` ::
100
+
101
+ conda create -n pyobjcryst_env pyobjcryst
102
+ conda activate pyobjcryst_env
103
+
104
+ To confirm that the installation was successful, type ::
105
+
106
+ python -c "import pyobjcryst; print(pyobjcryst.__version__)"
107
+
108
+ The output should print the latest version displayed on the badges above.
109
+
110
+ If the above does not work, you can use ``pip`` to download and install the latest release from
111
+ `Python Package Index <https://pypi.python.org>`_.
112
+ To install using ``pip`` into your ``pyobjcryst_env`` environment, type ::
113
+
114
+ pip install pyobjcryst
115
+
116
+ If you prefer to install from sources, after installing the dependencies, obtain the source archive from
117
+ `GitHub <https://github.com/diffpy/pyobjcryst/>`_. Once installed, ``cd`` into your ``pyobjcryst`` directory
118
+ and run the following ::
119
+
120
+ pip install .
121
+
122
+ An alternative way of installing pyobjcryst is to use the SCons tool,
123
+ which can speed up the process by compiling C++ files in several
124
+ parallel jobs (-j4)::
125
+
126
+ conda install scons
127
+ conda install --file requirements/conda.txt
128
+ scons -j4 dev
129
+
130
+ See ``scons -h`` for description of build targets and options. Need to install test dependencies
131
+ (``requirements/test.txt``) to run SCons test mode.
132
+
133
+ Optional graphical dependencies for jupyter notebooks
134
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
135
+ Some of the classes can produce graphical outputs, which can be
136
+ displayed in a jupyter notebook:
137
+
138
+ * a Crystal structure can be displayed in 3D: this requires the
139
+ ``py3dmol`` and ``ipywidgets`` modules. See the notebook
140
+ ``examples/cystal_3d_widget.ipynb``
141
+ * a PowderPattern can be displayed (and live-updated) if
142
+ ``matplotlib`` and ``ipympl`` are installed. See the
143
+ notebook ``examples/cimetidine-structure-solution-powder.ipynb``
144
+
145
+ Getting Started
146
+ ---------------
147
+
148
+ You may consult our `online documentation <https://diffpy.github.io/pyobjcryst>`_ for tutorials and API references.
149
+
150
+ Support and Contribute
151
+ ----------------------
152
+
153
+ If you see a bug or want to request a feature, please `report it as an issue <https://github.com/diffpy/pyobjcryst/issues>`_ and/or `submit a fix as a PR <https://github.com/diffpy/pyobjcryst/pulls>`_.
154
+
155
+ Feel free to fork the project and contribute. To install pyobjcryst
156
+ in a development mode, with its sources being directly used by Python
157
+ rather than copied to a package directory, use the following in the root
158
+ directory ::
159
+
160
+ pip install -e .
161
+
162
+ To ensure code quality and to prevent accidental commits into the default branch, please set up the use of our pre-commit
163
+ hooks.
164
+
165
+ 1. Install pre-commit in your working environment by running ``conda install pre-commit``.
166
+
167
+ 2. Initialize pre-commit (one time only) ``pre-commit install``.
168
+
169
+ Thereafter your code will be linted by black and isort and checked against flake8 before you can commit.
170
+ If it fails by black or isort, just rerun and it should pass (black and isort will modify the files so should
171
+ pass after they are modified). If the flake8 test fails please see the error messages and fix them manually before
172
+ trying to commit again.
173
+
174
+ When developing it is preferable to compile the C++ files with
175
+ SCons using the ``build=debug`` option, which compiles the extension
176
+ module with debug information and C-assertions checks ::
177
+
178
+ scons -j4 build=debug dev
179
+
180
+ Improvements and fixes are always appreciated.
181
+
182
+ Before contributing, please read our `Code of Conduct <https://github.com/diffpy/pyobjcryst/blob/main/CODE_OF_CONDUCT.rst>`_.
183
+
184
+ Contact
185
+ -------
186
+
187
+ For more information on pyobjcryst please visit the project `web-page <https://diffpy.github.io/>`_ or email Simon Billinge at sb2896@columbia.edu.
188
+
189
+ Acknowledgements
190
+ ----------------
191
+
192
+ This package bundles the following IUCr data files for bona fide research use:
193
+
194
+ - **cpd-1a.prn:** Powder diffraction dataset from the `IUCr CPD Round Robin on Quantitative Phase Analysis <https://www.iucr.org/__data/iucr/powder/QARR/index.html>`_.
195
+
196
+ Source: https://www.iucr.org/__data/iucr/powder/QARR/col/cpd-1a.prn
197
+
198
+ Round Robin on Quantitative Phase Analysis: Madsen, I. (1997) ‘Round Robin on Quantitative Phase Analysis’, Powder Diffraction, 12(1), pp. 1–2. Available at: https://doi.org/10.1017/S0885715600020212.
199
+
200
+
201
+ ``pyobjcryst`` is built and maintained with `scikit-package <https://scikit-package.github.io/scikit-package/>`_.
@@ -0,0 +1,165 @@
1
+ |Icon| |title|_
2
+ ===============
3
+
4
+ .. |title| replace:: pyobjcryst
5
+ .. _title: https://diffpy.github.io/pyobjcryst
6
+
7
+ .. |Icon| image:: https://avatars.githubusercontent.com/diffpy
8
+ :target: https://diffpy.github.io/pyobjcryst
9
+ :height: 100px
10
+
11
+ |PyPI| |Forge| |PythonVersion| |PR|
12
+
13
+ |CI| |Codecov| |Black| |Tracking|
14
+
15
+ .. |Black| image:: https://img.shields.io/badge/code_style-black-black
16
+ :target: https://github.com/psf/black
17
+
18
+ .. |CI| image:: https://github.com/diffpy/pyobjcryst/actions/workflows/matrix-and-codecov-on-merge-to-main.yml/badge.svg
19
+ :target: https://github.com/diffpy/pyobjcryst/actions/workflows/matrix-and-codecov-on-merge-to-main.yml
20
+
21
+ .. |Codecov| image:: https://codecov.io/gh/diffpy/pyobjcryst/branch/main/graph/badge.svg
22
+ :target: https://codecov.io/gh/diffpy/pyobjcryst
23
+
24
+ .. |Forge| image:: https://img.shields.io/conda/vn/conda-forge/pyobjcryst
25
+ :target: https://anaconda.org/conda-forge/pyobjcryst
26
+
27
+ .. |PR| image:: https://img.shields.io/badge/PR-Welcome-29ab47ff
28
+ :target: https://github.com/diffpy/pyobjcryst/pulls
29
+
30
+ .. |PyPI| image:: https://img.shields.io/pypi/v/pyobjcryst
31
+ :target: https://pypi.org/project/pyobjcryst/
32
+
33
+ .. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/pyobjcryst
34
+ :target: https://pypi.org/project/pyobjcryst/
35
+
36
+ .. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue
37
+ :target: https://github.com/diffpy/pyobjcryst/issues
38
+
39
+ Python bindings to ObjCryst++, the Object-Oriented Crystallographic Library.
40
+
41
+
42
+ For more information about the pyobjcryst library, please consult our `online documentation <https://diffpy.github.io/pyobjcryst>`_.
43
+
44
+ Citation
45
+ --------
46
+
47
+ If you use pyobjcryst in a scientific publication, we would like you to cite this package as
48
+
49
+ pyobjcryst Package, https://github.com/diffpy/pyobjcryst
50
+
51
+ Installation
52
+ ------------
53
+
54
+ The preferred method is to use `Miniconda Python
55
+ <https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html>`_
56
+ and install from the "conda-forge" channel of Conda packages.
57
+
58
+ To add "conda-forge" to the conda channels, run the following in a terminal. ::
59
+
60
+ conda config --add channels conda-forge
61
+
62
+ We want to install our packages in a suitable conda environment.
63
+ The following creates and activates a new environment named ``pyobjcryst_env`` ::
64
+
65
+ conda create -n pyobjcryst_env pyobjcryst
66
+ conda activate pyobjcryst_env
67
+
68
+ To confirm that the installation was successful, type ::
69
+
70
+ python -c "import pyobjcryst; print(pyobjcryst.__version__)"
71
+
72
+ The output should print the latest version displayed on the badges above.
73
+
74
+ If the above does not work, you can use ``pip`` to download and install the latest release from
75
+ `Python Package Index <https://pypi.python.org>`_.
76
+ To install using ``pip`` into your ``pyobjcryst_env`` environment, type ::
77
+
78
+ pip install pyobjcryst
79
+
80
+ If you prefer to install from sources, after installing the dependencies, obtain the source archive from
81
+ `GitHub <https://github.com/diffpy/pyobjcryst/>`_. Once installed, ``cd`` into your ``pyobjcryst`` directory
82
+ and run the following ::
83
+
84
+ pip install .
85
+
86
+ An alternative way of installing pyobjcryst is to use the SCons tool,
87
+ which can speed up the process by compiling C++ files in several
88
+ parallel jobs (-j4)::
89
+
90
+ conda install scons
91
+ conda install --file requirements/conda.txt
92
+ scons -j4 dev
93
+
94
+ See ``scons -h`` for description of build targets and options. Need to install test dependencies
95
+ (``requirements/test.txt``) to run SCons test mode.
96
+
97
+ Optional graphical dependencies for jupyter notebooks
98
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
99
+ Some of the classes can produce graphical outputs, which can be
100
+ displayed in a jupyter notebook:
101
+
102
+ * a Crystal structure can be displayed in 3D: this requires the
103
+ ``py3dmol`` and ``ipywidgets`` modules. See the notebook
104
+ ``examples/cystal_3d_widget.ipynb``
105
+ * a PowderPattern can be displayed (and live-updated) if
106
+ ``matplotlib`` and ``ipympl`` are installed. See the
107
+ notebook ``examples/cimetidine-structure-solution-powder.ipynb``
108
+
109
+ Getting Started
110
+ ---------------
111
+
112
+ You may consult our `online documentation <https://diffpy.github.io/pyobjcryst>`_ for tutorials and API references.
113
+
114
+ Support and Contribute
115
+ ----------------------
116
+
117
+ If you see a bug or want to request a feature, please `report it as an issue <https://github.com/diffpy/pyobjcryst/issues>`_ and/or `submit a fix as a PR <https://github.com/diffpy/pyobjcryst/pulls>`_.
118
+
119
+ Feel free to fork the project and contribute. To install pyobjcryst
120
+ in a development mode, with its sources being directly used by Python
121
+ rather than copied to a package directory, use the following in the root
122
+ directory ::
123
+
124
+ pip install -e .
125
+
126
+ To ensure code quality and to prevent accidental commits into the default branch, please set up the use of our pre-commit
127
+ hooks.
128
+
129
+ 1. Install pre-commit in your working environment by running ``conda install pre-commit``.
130
+
131
+ 2. Initialize pre-commit (one time only) ``pre-commit install``.
132
+
133
+ Thereafter your code will be linted by black and isort and checked against flake8 before you can commit.
134
+ If it fails by black or isort, just rerun and it should pass (black and isort will modify the files so should
135
+ pass after they are modified). If the flake8 test fails please see the error messages and fix them manually before
136
+ trying to commit again.
137
+
138
+ When developing it is preferable to compile the C++ files with
139
+ SCons using the ``build=debug`` option, which compiles the extension
140
+ module with debug information and C-assertions checks ::
141
+
142
+ scons -j4 build=debug dev
143
+
144
+ Improvements and fixes are always appreciated.
145
+
146
+ Before contributing, please read our `Code of Conduct <https://github.com/diffpy/pyobjcryst/blob/main/CODE_OF_CONDUCT.rst>`_.
147
+
148
+ Contact
149
+ -------
150
+
151
+ For more information on pyobjcryst please visit the project `web-page <https://diffpy.github.io/>`_ or email Simon Billinge at sb2896@columbia.edu.
152
+
153
+ Acknowledgements
154
+ ----------------
155
+
156
+ This package bundles the following IUCr data files for bona fide research use:
157
+
158
+ - **cpd-1a.prn:** Powder diffraction dataset from the `IUCr CPD Round Robin on Quantitative Phase Analysis <https://www.iucr.org/__data/iucr/powder/QARR/index.html>`_.
159
+
160
+ Source: https://www.iucr.org/__data/iucr/powder/QARR/col/cpd-1a.prn
161
+
162
+ Round Robin on Quantitative Phase Analysis: Madsen, I. (1997) ‘Round Robin on Quantitative Phase Analysis’, Powder Diffraction, 12(1), pp. 1–2. Available at: https://doi.org/10.1017/S0885715600020212.
163
+
164
+
165
+ ``pyobjcryst`` is built and maintained with `scikit-package <https://scikit-package.github.io/scikit-package/>`_.
@@ -0,0 +1,97 @@
1
+ [build-system]
2
+ requires = ["setuptools>=62.0", "setuptools-git-versioning>=2.0", "numpy"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "pyobjcryst"
7
+ dynamic=['version', 'dependencies']
8
+ authors = [
9
+ { name="Christopher Farrow" },
10
+ { name="Pavol Juhás" },
11
+ { name="Vincent-Favre-Nicolin", email="favre@esrf.fr" },
12
+ ]
13
+ maintainers = [
14
+ { name="Simon J.L. Billinge group", email="sb2896@columbia.edu" },
15
+ { name="Vincent-Favre-Nicolin", email="favre@esrf.fr" },
16
+ ]
17
+ description = "Python bindings to the ObjCryst++ library."
18
+ keywords = ['objcryst', 'atom structure crystallography', 'powder diffraction']
19
+ readme = "README.rst"
20
+ requires-python = ">=3.11, <3.14"
21
+ classifiers = [
22
+ 'Development Status :: 5 - Production/Stable',
23
+ 'Environment :: Console',
24
+ 'Intended Audience :: Developers',
25
+ 'Intended Audience :: Education',
26
+ 'Intended Audience :: Science/Research',
27
+ 'License :: OSI Approved :: BSD License',
28
+ 'Operating System :: MacOS :: MacOS X',
29
+ 'Operating System :: Microsoft :: Windows',
30
+ 'Operating System :: POSIX',
31
+ 'Operating System :: Unix',
32
+ 'Programming Language :: C++',
33
+ 'Programming Language :: Python :: 3.11',
34
+ 'Programming Language :: Python :: 3.12',
35
+ 'Programming Language :: Python :: 3.13',
36
+ 'Topic :: Scientific/Engineering :: Physics',
37
+ 'Topic :: Scientific/Engineering :: Chemistry',
38
+ 'Topic :: Software Development :: Libraries',
39
+ ]
40
+
41
+ [project.urls]
42
+ Homepage = "https://github.com/diffpy/pyobjcryst/"
43
+ Issues = "https://github.com/diffpy/pyobjcryst/issues/"
44
+
45
+ [tool.setuptools-git-versioning]
46
+ enabled = true
47
+ template = "{tag}"
48
+ dev_template = "{tag}"
49
+ dirty_template = "{tag}"
50
+ # Use this version when git data are not available as in a git zip archive.
51
+ # Update when tagging a new release.
52
+ starting_version = "2024.2.1"
53
+
54
+ [tool.setuptools.packages.find]
55
+ where = ["src"] # list of folders that contain the packages (["."] by default)
56
+ include = ["*"] # package names should match these glob patterns (["*"] by default)
57
+ exclude = [] # exclude packages matching these glob patterns (empty by default)
58
+ namespaces = false # to disable scanning PEP 420 namespaces (true by default)
59
+
60
+ [project.scripts]
61
+ pyobjcryst = "pyobjcryst.app:main"
62
+
63
+ [tool.setuptools.dynamic]
64
+ dependencies = {file = ["requirements/pip.txt"]}
65
+
66
+ [tool.codespell]
67
+ exclude-file = ".codespell/ignore_lines.txt"
68
+ ignore-words = ".codespell/ignore_words.txt"
69
+ skip = "*.cif,*.dat"
70
+
71
+ [tool.docformatter]
72
+ recursive = true
73
+ wrap-summaries = 72
74
+ wrap-descriptions = 72
75
+
76
+ [tool.black]
77
+ line-length = 79
78
+ include = '\.pyi?$'
79
+ exclude = '''
80
+ /(
81
+ \.git
82
+ | \.hg
83
+ | \.mypy_cache
84
+ | \.tox
85
+ | \.venv
86
+ | \.rst
87
+ | \.txt
88
+ | _build
89
+ | buck-out
90
+ | build
91
+ | dist
92
+
93
+ # The following are specific to Black, you probably don't want those.
94
+ | blib2to3
95
+ | tests/data
96
+ )/
97
+ '''
File without changes