diffpy.structure 3.2.0__py3-none-any.whl

diffpy.structure-3.2.0.dist-info/METADATA

@@ -0,0 +1,197 @@
+Metadata-Version: 2.1
+Name: diffpy.structure
+Version: 3.2.0
+Summary: Crystal structure container and parsers for structure formats.
+Author-email: "Simon J.L. Billinge group" <simon.billinge@gmail.com>
+Maintainer-email: "Simon J.L. Billinge group" <simon.billinge@gmail.com>
+Project-URL: Homepage, https://github.com/diffpy/diffpy.structure/
+Project-URL: Issues, https://github.com/diffpy/diffpy.structure/issues/
+Keywords: diffpy,crystal structure data storage CIF PDB
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Scientific/Engineering :: Chemistry
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE.rst
+License-File: LICENSE_DANSE.rst
+License-File: LICENSE_pymmlib.rst
+License-File: AUTHORS.rst
+
+|Icon| |title|_
+===============
+
+.. |title| replace:: diffpy.structure
+.. _title: https://diffpy.github.io/diffpy.structure
+
+.. |Icon| image:: https://avatars.githubusercontent.com/diffpy
+        :target: https://diffpy.github.io/diffpy.structure
+        :height: 100px
+
+|PyPi| |Forge| |PythonVersion| |PR|
+
+|CI| |Codecov| |Black| |Tracking|
+
+.. |Black| image:: https://img.shields.io/badge/code_style-black-black
+        :target: https://github.com/psf/black
+
+.. |CI| image:: https://github.com/diffpy/diffpy.structure/actions/workflows/main.yml/badge.svg
+        :target: https://github.com/diffpy/diffpy.structure/actions/workflows/main.yml
+
+.. |Codecov| image:: https://codecov.io/gh/diffpy/diffpy.structure/branch/main/graph/badge.svg
+        :target: https://codecov.io/gh/diffpy/diffpy.structure
+
+.. |Forge| image:: https://img.shields.io/conda/vn/conda-forge/diffpy.structure
+        :target: https://anaconda.org/conda-forge/diffpy.structure
+
+.. |PR| image:: https://img.shields.io/badge/PR-Welcome-29ab47ff
+
+.. |PyPi| image:: https://img.shields.io/pypi/v/diffpy.structure
+        :target: https://pypi.org/project/diffpy.structure/
+
+.. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/diffpy.structure
+        :target: https://pypi.org/project/diffpy.structure/
+
+.. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue
+        :target: https://github.com/diffpy/diffpy.structure/issues
+
+Crystal structure container and parsers for structure formats.
+
+The diffpy.structure package provides objects for storing atomic
+coordinates, displacement parameters and other crystal structure data.
+diffpy.structure supports import and export of structure data in several
+structure formats such as CIF, PDB, and xyz.  It provides conversion
+between fractional and absolute Cartesian coordinates, functions for
+symmetry expansion of atom sites in the asymmetric unit and generation
+of symmetry constraints for atom positions and displacement parameters.
+diffpy.structure includes definitions of all space groups in over 500
+symmetry settings.
+
+For more information about the diffpy.structure library, please consult our `online documentation <https://diffpy.github.io/diffpy.structure>`_.
+
+Citation
+--------
+
+If you use this program for a scientific research that leads
+to publication, we ask that you acknowledge use of the program
+by citing the following paper in your publication:
+
+   P. Juhás, C. L. Farrow, X. Yang, K. R. Knox and S. J. L. Billinge,
+   `Complex modeling: a strategy and software program for combining
+   multiple information sources to solve ill posed structure and
+   nanostructure inverse problems
+   <http://dx.doi.org/10.1107/S2053273315014473>`__,
+   *Acta Crystallogr. A* **71**, 562-568 (2015).
+
+Requirements
+------------------------------------------------------------------------
+
+The diffpy.structure package requires Python 3.7 or later and
+the following software:
+
+* ``setuptools`` - software distribution tools for Python
+* ``NumPy`` - numerical mathematics and fast array operations for Python
+
+We recommend to use `Anaconda Python <https://www.anaconda.com/download>`_
+as it allows to install all software dependencies together with
+diffpy.structure.  For other Python distributions it is necessary to
+install the required software separately.  As an example on Ubuntu
+Linux the required software can be installed with ::
+
+   sudo aptitude install python3-setuptools python3-numpy
+
+diffpy.structure also uses the
+`PyCifRW <https://bitbucket.org/jamesrhester/pycifrw>`_
+library, which is automatically deployed during the
+installation process.
+
+Installation
+------------
+
+The preferred method is to use `Miniconda Python
+<https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html>`_
+and install from the "conda-forge" channel of Conda packages.
+
+To add "conda-forge" to the conda channels, run the following in a terminal. ::
+
+        conda config --add channels conda-forge
+
+We want to install our packages in a suitable conda environment.
+The following creates and activates a new environment named ``diffpy.structure_env`` ::
+
+        conda create -n diffpy.structure_env python=3
+        conda activate diffpy.structure_env
+
+Then, to fully install ``diffpy.structure`` in our active environment, run ::
+
+        conda install diffpy.structure
+
+Another option is to use ``pip`` to download and install the latest release from
+`Python Package Index <https://pypi.python.org>`_.
+To install using ``pip`` into your ``diffpy.structure_env`` environment, we will also have to install dependencies ::
+
+        pip install -r https://raw.githubusercontent.com/diffpy/diffpy.structure/main/requirements/run.txt
+
+and then install the package ::
+
+        pip install diffpy.structure
+
+If you prefer to install from sources, after installing the dependencies, obtain the source archive from
+`GitHub <https://github.com/diffpy/diffpy.structure/>`_. Once installed, ``cd`` into your ``diffpy.structure`` directory
+and run the following ::
+
+        pip install .
+
+Support and Contribute
+----------------------
+
+`Diffpy user group <https://groups.google.com/g/diffpy-users>`_ is the discussion forum for general questions and discussions about the use of diffpy.structure. Please join the diffpy.structure users community by joining the Google group. The diffpy.structure project welcomes your expertise and enthusiasm!
+
+If you see a bug or want to request a feature, please `report it as an issue <https://github.com/diffpy/diffpy.structure/issues>`_ and/or `submit a fix as a PR <https://github.com/diffpy/diffpy.structure/pulls>`_. You can also post it to the `Diffpy user group <https://groups.google.com/g/diffpy-users>`_. 
+
+Feel free to fork the project and contribute. To install diffpy.structure
+in a development mode, with its sources being directly used by Python
+rather than copied to a package directory, use the following in the root
+directory ::
+
+        pip install -e .
+
+To ensure code quality and to prevent accidental commits into the default branch, please set up the use of our pre-commit
+hooks.
+
+1. Install pre-commit in your working environment by running ``conda install pre-commit``.
+
+2. Initialize pre-commit (one time only) ``pre-commit install``.
+
+Thereafter your code will be linted by black and isort and checked against flake8 before you can commit.
+If it fails by black or isort, just rerun and it should pass (black and isort will modify the files so should
+pass after they are modified). If the flake8 test fails please see the error messages and fix them manually before
+trying to commit again.
+
+Improvements and fixes are always appreciated.
+
+Before contribuing, please read our `Code of Conduct <https://github.com/diffpy/diffpy.structure/blob/main/CODE_OF_CONDUCT.rst>`_.
+
+Acknowledgement
+---------------
+
+Space group codes in *spacegroupmod.py* and *mmlibspacegroups.py*
+originate from the `pymmlib project <http://pymmlib.sourceforge.net>`_.
+
+Less common settings of space groups were generating using the
+`Computational Crystallography Toolbox <http://cctbx.sourceforge.net>`_.
+
+Contact
+-------
+
+For more information on diffpy.structure please visit the project `web-page <https://diffpy.github.io/>`_ or email Prof. Simon Billinge at sb2896@columbia.edu.

diffpy.structure-3.2.0.dist-info/RECORD

@@ -0,0 +1,42 @@
+diffpy/Structure.py,sha256=qBWWvx2GV65SJqgS6qK933SDfZc1yUQCBtJpW_wFqj8,1005
+diffpy/__init__.py,sha256=WntnKrzS4hxw7YDYxwU-2hCJYNSFBf3gvjbPOrci0dk,673
+diffpy/structure/__init__.py,sha256=EPy-CMdt1GkwzPmFs6vBPFjxygb-xMCsrxZMEEnrODo,2600
+diffpy/structure/_legacy_importer.py,sha256=IXoPovMWIEY7tQTp1prTjICudfiVsR_Blmae-zDcHKA,2574
+diffpy/structure/atom.py,sha256=njq7vUr2yop9Rw8lgW2DX63cpTO0r4rToIcjAfQdIf0,17702
+diffpy/structure/lattice.py,sha256=NhSYxFMyfPRJYwiLCyObEPC7vlZBAsP0x9PYSzJ1O7U,22499
+diffpy/structure/mmlibspacegroups.py,sha256=J4F8nbcZ2OmjhzxtOnFVKLQpzXgyQ-S8wh3EnNxqz-w,245608
+diffpy/structure/pdffitstructure.py,sha256=lzARAIDN-FiuMnQJIeFbfRMdRXCGgv2J2qPmOctkN_I,3202
+diffpy/structure/sgtbxspacegroups.py,sha256=9Mz_vVfC3CYpKBYFeYc2Un0VdsqNIx8e9KdZ-Szhw3Y,135078
+diffpy/structure/spacegroupmod.py,sha256=xMeWjiODk21koPQo7aQnwdWf4wzZ82PnVl3MmlTj5yU,15176
+diffpy/structure/spacegroups.py,sha256=BPKW75UNGqDlfi6lkntrjAJiqyxcKmIAeaUScrKA7LA,23359
+diffpy/structure/structure.py,sha256=wYIIdZpjXE4h-8gv5mv0dfFYlLJ-AAxmmwc-NdNPHP0,27337
+diffpy/structure/structureerrors.py,sha256=9T4Fwy-_dafyiMRGeK0qAmZ6TXBpRqlhSnOxIfV5mxM,880
+diffpy/structure/symmetryutilities.py,sha256=jxR8Sxp7Fw8seSX_8y8GgrbfpVadj4_leXFukTkDPKQ,37377
+diffpy/structure/utils.py,sha256=IMgzeIPg0WOIVeACpg2YZX4wL0NZhu_tZRuGctSmLuM,3320
+diffpy/structure/version.py,sha256=SZtloZcpk7K1AnEKzefhXcEjxiJI6uXue0_3kQz_fp8,845
+diffpy/structure/apps/__init__.py,sha256=8_LEH7mLoHMV1JWCV8g6ROTQVUap2QbYIvF11s5_Fts,595
+diffpy/structure/apps/anyeye.py,sha256=DFWDAw7MKwyVAGK8Ysqlz3_EDJQFgsnjqbZtFTa_4d8,8031
+diffpy/structure/apps/transtru.py,sha256=VUfjEwefSsF-ca16Rq6rjtCw24-P-hybyLMS_6y2qZ4,3655
+diffpy/structure/expansion/__init__.py,sha256=lgVDh9UxVR63lDl0trCBt042Rw3nNzPGnuWna45nTms,870
+diffpy/structure/expansion/makeellipsoid.py,sha256=R8dhKtRW6KxdeectCI39PyRTLpNFUFvj6M5UWVvify8,3456
+diffpy/structure/expansion/shapeutils.py,sha256=gAQnsVa2puE-sn7sIjEHhZU9U8EEk1gHIbEHErp-iMc,1130
+diffpy/structure/expansion/supercell_mod.py,sha256=t8kfDCNp92_PWURjCdm-KRryTk6AvAN6SI271mAyFh4,2712
+diffpy/structure/parsers/__init__.py,sha256=qq0grT2qDKBG5LE2DlSdpnUc-JA1UtaUSN-KF3iGNOQ,2730
+diffpy/structure/parsers/p_auto.py,sha256=yNcSmLsIiyERtlnLWZkh5TqHwU8b2q2fVtbrTtgeAWk,6030
+diffpy/structure/parsers/p_cif.py,sha256=KlrLoxTnypOMZyJtKbccdgt3U0rR1UxP2Cm_SOjy1Ao,29218
+diffpy/structure/parsers/p_discus.py,sha256=3cIN9oXv9uKIJ-5G7B5HtJYnlO91UCUkHnMXu0Fd-QY,10505
+diffpy/structure/parsers/p_pdb.py,sha256=AkFHFWbNj6ihjj_LtdOqQzA56Rb5u2P_gecUpoJMzeg,13938
+diffpy/structure/parsers/p_pdffit.py,sha256=1VnEvKfaKjLnBfgNWW7um4xG7sQ3gbSGlc9cFSw5as4,11021
+diffpy/structure/parsers/p_rawxyz.py,sha256=gdEWdzCxMl1_JV1KNgurgPdEAp4RO3tEYLnasi672cw,4550
+diffpy/structure/parsers/p_xcfg.py,sha256=QIaaq30FoRnZwYIlAsLUMVRWGPoQaivRwMPWqXE5VMI,17947
+diffpy/structure/parsers/p_xyz.py,sha256=PDmkc_MyHRP5wqJsHxxa7W4bce60YHhkurUrmrhU8Ks,5017
+diffpy/structure/parsers/parser_index_mod.py,sha256=QWwV0tPpbIlk2i-gwR6MlKkUF0H05lGzO0yBq5nPOxk,3045
+diffpy/structure/parsers/structureparser.py,sha256=p6eXkziF0sBOR6p9tyfvs8O6D9oRqETrr_v54h3C5mg,2254
+diffpy.structure-3.2.0.dist-info/AUTHORS.rst,sha256=-15SGTrM2oMYIlTjqw81R2YKVMvWepQGgrG00jJWK44,212
+diffpy.structure-3.2.0.dist-info/LICENSE.rst,sha256=nXbHfaJU5pWBgoiK0ed_aJDs1icKfjV7bJwOZl-BaV0,6007
+diffpy.structure-3.2.0.dist-info/LICENSE_DANSE.rst,sha256=BC6IAe60b_BSdb-hI0GulJ5uPAu-RvuYdI8GKYtNL4U,2282
+diffpy.structure-3.2.0.dist-info/LICENSE_pymmlib.rst,sha256=eLh3rsGOgX3byYIbQlJ2jeGbpvjYK_7p25Dn6W7Gw_M,9599
+diffpy.structure-3.2.0.dist-info/METADATA,sha256=7x_IOt_u5518l1BujfJ82RufthvZp-U0VwzhOu1zotQ,8598
+diffpy.structure-3.2.0.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+diffpy.structure-3.2.0.dist-info/top_level.txt,sha256=34qLZyi9mxikpHepVDTMHrrNbe8VoOuz3ShYeiWA7KA,7
+diffpy.structure-3.2.0.dist-info/RECORD,,

diffpy.structure-3.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (72.1.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

diffpy.structure-3.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+diffpy