pyobjcryst 2.2.5.post1__tar.gz → 2025.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pyobjcryst-2025.1.0/AUTHORS.rst +13 -0
- pyobjcryst-2025.1.0/LICENSE-DANSE.rst +45 -0
- pyobjcryst-2025.1.0/LICENSE.rst +141 -0
- pyobjcryst-2025.1.0/MANIFEST.in +14 -0
- pyobjcryst-2025.1.0/PKG-INFO +274 -0
- pyobjcryst-2025.1.0/README.rst +238 -0
- pyobjcryst-2025.1.0/pyproject.toml +94 -0
- pyobjcryst-2025.1.0/requirements/build.txt +0 -0
- pyobjcryst-2025.1.0/requirements/conda.txt +11 -0
- pyobjcryst-2025.1.0/requirements/docs.txt +8 -0
- pyobjcryst-2025.1.0/requirements/pip.txt +2 -0
- pyobjcryst-2025.1.0/requirements/tests.txt +6 -0
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/setup.cfg +4 -4
- pyobjcryst-2025.1.0/setup.py +119 -0
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/asymmetricunit_ext.cpp +45 -45
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/atom_ext.cpp +72 -72
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/crystal_ext.cpp +431 -431
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/diffractiondatasinglecrystal_ext.cpp +199 -116
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/general_ext.cpp +78 -78
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/globaloptim_ext.cpp +220 -220
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/globalscatteringpower_ext.cpp +40 -40
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/helpers.cpp +133 -133
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/helpers.hpp +158 -158
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/indexing_ext.cpp +444 -444
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/io_ext.cpp +96 -96
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/lsq_ext.cpp +110 -110
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/molatom_ext.cpp +95 -95
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/molbond_ext.cpp +108 -108
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/molbondangle_ext.cpp +115 -115
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/moldihedralangle_ext.cpp +118 -118
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/molecule_ext.cpp +863 -844
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/objregistry_ext.cpp +208 -208
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/polyhedron_ext.cpp +89 -89
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/powderpattern_ext.cpp +369 -369
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/powderpatternbackground_ext.cpp +95 -95
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/powderpatterncomponent_ext.cpp +39 -39
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/powderpatterndiffraction_ext.cpp +79 -79
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/pyobjcryst.cpp +140 -140
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/pyobjcryst_numpy_setup.hpp +29 -29
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/python_streambuf.cpp +60 -60
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/python_streambuf.hpp +541 -541
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/quaternion_ext.cpp +114 -114
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/radiation_ext.cpp +55 -55
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/refinableobj_ext.cpp +598 -598
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/refinableobjclock_ext.cpp +103 -103
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/refinablepar_ext.cpp +164 -164
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/reflectionprofile_ext.cpp +88 -88
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/refobjopt_ext.cpp +75 -75
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/refpartype_ext.cpp +51 -51
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/registerconverters.cpp +327 -327
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/restraint_ext.cpp +102 -102
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/rigidgroup_ext.cpp +49 -49
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/scatterer_ext.cpp +276 -276
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/scatteringcomponent_ext.cpp +62 -62
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/scatteringcomponentlist_ext.cpp +92 -92
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/scatteringdata_ext.cpp +172 -172
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/scatteringpower_ext.cpp +295 -295
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/scatteringpoweratom_ext.cpp +53 -53
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/scatteringpowersphere_ext.cpp +49 -49
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/spacegroup_ext.cpp +160 -160
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/stretchmode_ext.cpp +275 -275
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/unitcell_ext.cpp +201 -201
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/zatom_ext.cpp +82 -82
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/zpolyhedron_ext.cpp +68 -68
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/extensions/zscatterer_ext.cpp +106 -106
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst/__init__.py +115 -109
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst/atom.py +27 -28
- pyobjcryst-2025.1.0/src/pyobjcryst/crystal.py +1059 -0
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst/diffractiondatasinglecrystal.py +65 -59
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst/fourier.py +128 -95
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst/general.py +27 -24
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst/globaloptim.py +221 -164
- pyobjcryst-2025.1.0/src/pyobjcryst/globals.py +46 -0
- pyobjcryst-2025.1.0/src/pyobjcryst/indexing.py +169 -0
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst/io.py +90 -75
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst/lsq.py +22 -22
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst/molecule.py +151 -136
- pyobjcryst-2025.1.0/src/pyobjcryst/polyhedron.py +41 -0
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst/powderpattern.py +660 -521
- pyobjcryst-2025.1.0/src/pyobjcryst/pyobjcryst_app.py +33 -0
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst/radiation.py +22 -24
- pyobjcryst-2025.1.0/src/pyobjcryst/refinableobj.py +194 -0
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst/reflectionprofile.py +22 -24
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst/scatterer.py +33 -34
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst/scatteringdata.py +23 -23
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst/scatteringpower.py +40 -35
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst/scatteringpowersphere.py +23 -23
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst/spacegroup.py +23 -24
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst/unitcell.py +23 -23
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst/utils.py +132 -129
- pyobjcryst-2025.1.0/src/pyobjcryst/version.py +25 -0
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst/zscatterer.py +63 -57
- pyobjcryst-2025.1.0/src/pyobjcryst.egg-info/PKG-INFO +274 -0
- pyobjcryst-2025.1.0/src/pyobjcryst.egg-info/SOURCES.txt +139 -0
- pyobjcryst-2025.1.0/src/pyobjcryst.egg-info/requires.txt +2 -0
- pyobjcryst-2025.1.0/tests/conftest.py +41 -0
- pyobjcryst-2.2.5.post1/src/pyobjcryst/tests/pyobjcrysttest.py → pyobjcryst-2025.1.0/tests/pyobjcryst_test_mem.py +170 -159
- pyobjcryst-2.2.5.post1/src/pyobjcryst/tests/testcif.py → pyobjcryst-2025.1.0/tests/test_cif.py +276 -306
- pyobjcryst-2.2.5.post1/src/pyobjcryst/tests/testclocks.py → pyobjcryst-2025.1.0/tests/test_clocks.py +60 -62
- pyobjcryst-2.2.5.post1/src/pyobjcryst/tests/testconverters.py → pyobjcryst-2025.1.0/tests/test_converters.py +44 -41
- pyobjcryst-2.2.5.post1/src/pyobjcryst/tests/testcrystal.py → pyobjcryst-2025.1.0/tests/test_crystal.py +174 -167
- pyobjcryst-2.2.5.post1/src/pyobjcryst/tests/testglobaloptim.py → pyobjcryst-2025.1.0/tests/test_globaloptim.py +126 -122
- pyobjcryst-2.2.5.post1/src/pyobjcryst/tests/testindexing.py → pyobjcryst-2025.1.0/tests/test_indexing.py +134 -78
- pyobjcryst-2.2.5.post1/src/pyobjcryst/tests/testlsq.py → pyobjcryst-2025.1.0/tests/test_lsq.py +87 -83
- pyobjcryst-2.2.5.post1/src/pyobjcryst/tests/testmolecule.py → pyobjcryst-2025.1.0/tests/test_molecule.py +892 -874
- pyobjcryst-2.2.5.post1/src/pyobjcryst/tests/testpowderpattern.py → pyobjcryst-2025.1.0/tests/test_powderpattern.py +319 -294
- pyobjcryst-2.2.5.post1/src/pyobjcryst/tests/testradiation.py → pyobjcryst-2025.1.0/tests/test_radiation.py +49 -48
- pyobjcryst-2.2.5.post1/src/pyobjcryst/tests/testrefinableobj.py → pyobjcryst-2025.1.0/tests/test_refinableobj.py +428 -421
- pyobjcryst-2025.1.0/tests/test_single_crystal_data.py +63 -0
- pyobjcryst-2.2.5.post1/src/pyobjcryst/tests/testspacegroup.py → pyobjcryst-2025.1.0/tests/test_spacegroup.py +57 -60
- pyobjcryst-2.2.5.post1/src/pyobjcryst/tests/testutils.py → pyobjcryst-2025.1.0/tests/test_utils.py +51 -47
- pyobjcryst-2025.1.0/tests/test_version.py +15 -0
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/Ag_silver.cif +236 -236
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/BaTiO3.cif +743 -743
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/C_graphite_hex.cif +56 -56
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/CaF2_fluorite.cif +235 -235
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/CaTiO3.cif +95 -95
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/CdSe_cadmoselite.cif +57 -57
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/CeO2.cif +237 -237
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/NaCl.cif +95 -95
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/Ni.cif +236 -236
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/PbS_galena.cif +236 -236
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/PbTe.cif +237 -237
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/Si.cif +224 -224
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/Si_setting2.cif +281 -281
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/SrTiO3_tausonite.cif +85 -85
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/TiO2_anatase.cif +76 -76
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/TiO2_rutile.cif +52 -52
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/ZnS_sphalerite.cif +128 -128
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/ZnS_wurtzite.cif +57 -57
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/Zn_zinc.cif +68 -68
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/caffeine.cif +101 -101
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/cime.fhz +19 -19
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/lidocainementhol.cif +388 -388
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/ni.stru +33 -33
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/paracetamol.cif +318 -318
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/paracetamol_monomethanolate.cif +303 -303
- {pyobjcryst-2.2.5.post1/src/pyobjcryst → pyobjcryst-2025.1.0}/tests/testdata/paracetamol_monomethanolate_data_single_crystal.cif +1713 -1713
- pyobjcryst-2.2.5.post1/src/pyobjcryst/tests/pyobjcrysttestutils.py → pyobjcryst-2025.1.0/tests/testutils.py +152 -161
- pyobjcryst-2.2.5.post1/AUTHORS.txt +0 -10
- pyobjcryst-2.2.5.post1/LICENSE.txt +0 -137
- pyobjcryst-2.2.5.post1/LICENSE_DANSE.txt +0 -33
- pyobjcryst-2.2.5.post1/MANIFEST.in +0 -16
- pyobjcryst-2.2.5.post1/PKG-INFO +0 -229
- pyobjcryst-2.2.5.post1/README.rst +0 -193
- pyobjcryst-2.2.5.post1/SConstruct +0 -239
- pyobjcryst-2.2.5.post1/setup.py +0 -210
- pyobjcryst-2.2.5.post1/src/extensions/SConscript +0 -66
- pyobjcryst-2.2.5.post1/src/extensions/SConscript.configure +0 -89
- pyobjcryst-2.2.5.post1/src/pyobjcryst/crystal.py +0 -647
- pyobjcryst-2.2.5.post1/src/pyobjcryst/globals.py +0 -35
- pyobjcryst-2.2.5.post1/src/pyobjcryst/indexing.py +0 -101
- pyobjcryst-2.2.5.post1/src/pyobjcryst/polyhedron.py +0 -32
- pyobjcryst-2.2.5.post1/src/pyobjcryst/refinableobj.py +0 -161
- pyobjcryst-2.2.5.post1/src/pyobjcryst/tests/__init__.py +0 -76
- pyobjcryst-2.2.5.post1/src/pyobjcryst/tests/debug.py +0 -30
- pyobjcryst-2.2.5.post1/src/pyobjcryst/tests/run.py +0 -31
- pyobjcryst-2.2.5.post1/src/pyobjcryst/version.cfg +0 -6
- pyobjcryst-2.2.5.post1/src/pyobjcryst/version.py +0 -74
- pyobjcryst-2.2.5.post1/src/pyobjcryst.egg-info/PKG-INFO +0 -229
- pyobjcryst-2.2.5.post1/src/pyobjcryst.egg-info/SOURCES.txt +0 -185
- pyobjcryst-2.2.5.post1/src/pyobjcryst.egg-info/not-zip-safe +0 -1
- pyobjcryst-2.2.5.post1/src/pyobjcryst.egg-info/requires.txt +0 -15
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst.egg-info/dependency_links.txt +0 -0
- {pyobjcryst-2.2.5.post1 → pyobjcryst-2025.1.0}/src/pyobjcryst.egg-info/top_level.txt +0 -0
|
@@ -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,274 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: pyobjcryst
|
|
3
|
+
Version: 2025.1.0
|
|
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
|
+
For more information about the pyobjcryst library, please consult our `online documentation <https://diffpy.github.io/pyobjcryst>`_.
|
|
78
|
+
|
|
79
|
+
``pyobjcryst`` is an open-source software package originally developed as a part of the DiffPy-CMI
|
|
80
|
+
complex modeling initiative which originated in the DANSE project
|
|
81
|
+
at Columbia University. It was further developed at Brookhaven National Laboratory,
|
|
82
|
+
and Columbia University and the European Synchrotron Radiation Source (ESRF) and is now
|
|
83
|
+
maintained at Columbia and ESRF.
|
|
84
|
+
The pyobjcryst sources are hosted at https://github.com/diffpy/pyobjcryst.
|
|
85
|
+
|
|
86
|
+
Citation
|
|
87
|
+
--------
|
|
88
|
+
|
|
89
|
+
If you use diffpy.srfit in a scientific publication, we would like you to cite this package as
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
P. Juhás, C. L. Farrow, X. Yang, K. R. Knox and S. J. L. Billinge,
|
|
93
|
+
`Complex modeling: a strategy and software program for combining
|
|
94
|
+
multiple information sources to solve ill posed structure and
|
|
95
|
+
nanostructure inverse problems
|
|
96
|
+
<http://dx.doi.org/10.1107/S2053273315014473>`__,
|
|
97
|
+
*Acta Crystallogr. A* **71**, 562-568 (2015).
|
|
98
|
+
|
|
99
|
+
and
|
|
100
|
+
|
|
101
|
+
V. Favre-Nicolin and R. Cerný,
|
|
102
|
+
`FOX, 'free objects for crystallography': a modular approach to
|
|
103
|
+
ab initio structure determination from powder diffraction
|
|
104
|
+
<https://doi.org/10.1107/S0021889802015236>`__,
|
|
105
|
+
*J. Appl. Cryst.* **35**, 734-743 (2002)
|
|
106
|
+
|
|
107
|
+
The second paper describes the c++ crystallographic objects in
|
|
108
|
+
``ObjCryst++`` that are wrapped by ``pyobjcryst``
|
|
109
|
+
|
|
110
|
+
Installation
|
|
111
|
+
------------
|
|
112
|
+
|
|
113
|
+
The latest release of ``pyobjcryst`` runs in python versions 3.11, 3.12 and 3.13. You may
|
|
114
|
+
specify an earlier release if you need it to run in an earlier version of Python.
|
|
115
|
+
|
|
116
|
+
The preferred method is to use `Miniconda Python
|
|
117
|
+
<https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html>`_
|
|
118
|
+
or `mamba <https://mamba.readthedocs.io/en/latest/>`__
|
|
119
|
+
and install from the "conda-forge" channel of Conda packages.
|
|
120
|
+
mamba works in the same way as conda but has the advantage of being much
|
|
121
|
+
faster when resolving dependencies during installation. It also uses by
|
|
122
|
+
default the conda-forge repository, which is what almost all users would want.
|
|
123
|
+
|
|
124
|
+
To add "conda-forge" to the conda channels, run the following in a terminal. ::
|
|
125
|
+
|
|
126
|
+
conda config --add channels conda-forge
|
|
127
|
+
|
|
128
|
+
We want to install our packages in a suitable conda environment.
|
|
129
|
+
The following creates and activates a new environment named ``pyobjcryst_env`` ::
|
|
130
|
+
|
|
131
|
+
conda create -n pyobjcryst_env pyobjcryst
|
|
132
|
+
conda activate pyobjcryst_env
|
|
133
|
+
|
|
134
|
+
To confirm that the installation was successful, type ::
|
|
135
|
+
|
|
136
|
+
python -c "import pyobjcryst; print(pyobjcryst.__version__)"
|
|
137
|
+
|
|
138
|
+
The output should print the latest version displayed on the badges above.
|
|
139
|
+
|
|
140
|
+
To use mamba, replace ``conda`` with ``mamba`` in the commands above.
|
|
141
|
+
|
|
142
|
+
pyobjcryst is also included in the ``diffpy.cmi`` collection of packages for
|
|
143
|
+
structure analysis and so can be installed by ::
|
|
144
|
+
|
|
145
|
+
conda install -c conda-forge diffpy.cmi
|
|
146
|
+
|
|
147
|
+
Optional graphical dependencies for jupyter notebooks
|
|
148
|
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
149
|
+
Some of the classes can produce graphical outputs, which can be
|
|
150
|
+
displayed in a jupyter notebook:
|
|
151
|
+
|
|
152
|
+
* a Crystal structure can be displayed in 3D: this requires the
|
|
153
|
+
``py3dmol`` and ``ipywidgets`` modules. See the notebook
|
|
154
|
+
``docs/examples/cystal_3d_widget.ipynb``
|
|
155
|
+
* a PowderPattern can be displayed (and live-updated) if
|
|
156
|
+
``matplotlib`` and ``ipympl`` are installed. See the
|
|
157
|
+
notebook ``docs/examples/structure-solution-powder-cimetidine.ipynb``
|
|
158
|
+
|
|
159
|
+
Getting Started
|
|
160
|
+
---------------
|
|
161
|
+
|
|
162
|
+
You may consult our `online documentation <https://diffpy.github.io/pyobjcryst>`_ for tutorials and API references.
|
|
163
|
+
|
|
164
|
+
Alternative methods of installation
|
|
165
|
+
-----------------------------------
|
|
166
|
+
|
|
167
|
+
These approaches are not recommended but reproduced here for advanced users.
|
|
168
|
+
You can use ``pip`` to download and install the latest release from
|
|
169
|
+
`Python Package Index <https://pypi.python.org>`_.
|
|
170
|
+
To install using ``pip`` into your ``pyobjcryst_env`` environment, type ::
|
|
171
|
+
|
|
172
|
+
pip install pyobjcryst
|
|
173
|
+
|
|
174
|
+
If you prefer to install from sources, after installing the dependencies, obtain the source archive from
|
|
175
|
+
`GitHub <https://github.com/diffpy/pyobjcryst/>`_. Once installed, ``cd`` into your ``pyobjcryst`` directory
|
|
176
|
+
and run the following ::
|
|
177
|
+
|
|
178
|
+
pip install .
|
|
179
|
+
|
|
180
|
+
An alternative way of installing pyobjcryst is to use the SCons tool,
|
|
181
|
+
which can speed up the process by compiling C++ files in several
|
|
182
|
+
parallel jobs (-j4)::
|
|
183
|
+
|
|
184
|
+
conda install scons
|
|
185
|
+
conda install --file requirements/conda.txt
|
|
186
|
+
scons -j4 dev
|
|
187
|
+
|
|
188
|
+
See ``scons -h`` for description of build targets and options.
|
|
189
|
+
|
|
190
|
+
Alternatively, on Ubuntu Linux the required software can be installed using ::
|
|
191
|
+
|
|
192
|
+
sudo apt-get install \
|
|
193
|
+
python-setuptools python-numpy scons \
|
|
194
|
+
build-essential python-dev libboost-all-dev
|
|
195
|
+
|
|
196
|
+
If this doesn't work, please see the `requirements/conda.txt` file for the
|
|
197
|
+
latest list of requirements.
|
|
198
|
+
|
|
199
|
+
The ``libobjcryst`` library can also be installed as per the instructions at
|
|
200
|
+
https://github.com/diffpy/libobjcryst. Make sure other required software are
|
|
201
|
+
also in place and then run from the pyobjcryst directory ::
|
|
202
|
+
|
|
203
|
+
pip install .
|
|
204
|
+
|
|
205
|
+
You may need to use sudo with system Python so the process is allowed to copy files to system
|
|
206
|
+
directories, unless you are installing into a conda environment. If administrator (root) access is not
|
|
207
|
+
available, see the usage information from python setup.py install --help for options to install
|
|
208
|
+
to a user-writable location.
|
|
209
|
+
|
|
210
|
+
Testing your installation
|
|
211
|
+
-------------------------
|
|
212
|
+
|
|
213
|
+
The installation integrity can be verified by executing the included tests with
|
|
214
|
+
|
|
215
|
+
First install test dependencies then type pytest::
|
|
216
|
+
|
|
217
|
+
conda install --file requirements/tests.txt
|
|
218
|
+
pytest
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
Support and Contribute
|
|
222
|
+
----------------------
|
|
223
|
+
|
|
224
|
+
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>`_.
|
|
225
|
+
|
|
226
|
+
Feel free to fork the project and contribute. To install pyobjcryst
|
|
227
|
+
in a development mode, with its sources being directly used by Python
|
|
228
|
+
rather than copied to a package directory, use the following in the root
|
|
229
|
+
directory ::
|
|
230
|
+
|
|
231
|
+
pip install -e .
|
|
232
|
+
|
|
233
|
+
To ensure code quality and to prevent accidental commits into the default branch, please set up the use of our pre-commit
|
|
234
|
+
hooks.
|
|
235
|
+
|
|
236
|
+
1. Install pre-commit in your working environment by running ``conda install pre-commit``.
|
|
237
|
+
|
|
238
|
+
2. Initialize pre-commit (one time only) ``pre-commit install``.
|
|
239
|
+
|
|
240
|
+
Thereafter your code will be linted by black and isort and checked against flake8 before you can commit.
|
|
241
|
+
If it fails by black or isort, just rerun and it should pass (black and isort will modify the files so should
|
|
242
|
+
pass after they are modified). If the flake8 test fails please see the error messages and fix them manually before
|
|
243
|
+
trying to commit again.
|
|
244
|
+
|
|
245
|
+
When developing it is preferable to compile the C++ files with
|
|
246
|
+
SCons using the ``build=debug`` option, which compiles the extension
|
|
247
|
+
module with debug information and C-assertions checks ::
|
|
248
|
+
|
|
249
|
+
scons -j4 build=debug dev
|
|
250
|
+
|
|
251
|
+
Improvements and fixes are always appreciated.
|
|
252
|
+
|
|
253
|
+
Before contributing, please read our `Code of Conduct <https://github.com/diffpy/pyobjcryst/blob/main/CODE-OF-CONDUCT.rst>`_.
|
|
254
|
+
|
|
255
|
+
Contact
|
|
256
|
+
-------
|
|
257
|
+
|
|
258
|
+
For more information on pyobjcryst please visit the project `web-page <https://diffpy.github.io/>`_ or email Simon Billinge at sb2896@columbia.edu.
|
|
259
|
+
|
|
260
|
+
You can also contact Vincent Favre-Nicolin (favre@esrf.fr) if you are using pyobjcryst outside diffpy, e.g. to display structures in a notebook, refine powder patterns or solve structures using the global optimisation algorithms, etc..
|
|
261
|
+
|
|
262
|
+
Acknowledgements
|
|
263
|
+
----------------
|
|
264
|
+
|
|
265
|
+
This package bundles the following IUCr data files for bona fide research use:
|
|
266
|
+
|
|
267
|
+
- **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>`_.
|
|
268
|
+
|
|
269
|
+
Source: https://www.iucr.org/__data/iucr/powder/QARR/col/cpd-1a.prn
|
|
270
|
+
|
|
271
|
+
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.
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
``pyobjcryst`` is built and maintained with `scikit-package <https://scikit-package.github.io/scikit-package/>`_.
|