{ "info": { "author": "Simon J.L. Billinge group", "author_email": "sb2896@columbia.edu", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "Intended Audience :: Education", "Intended Audience :: Science/Research", "License :: OSI Approved :: BSD License", "Operating System :: MacOS :: MacOS X", "Operating System :: POSIX", "Operating System :: Unix", "Programming Language :: C++", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Scientific/Engineering :: Chemistry", "Topic :: Scientific/Engineering :: Physics", "Topic :: Software Development :: Libraries" ], "description": ".. image:: https://travis-ci.org/diffpy/diffpy.srreal.svg?branch=master\n :target: https://travis-ci.org/diffpy/diffpy.srreal\n\n.. image:: https://codecov.io/gh/diffpy/diffpy.srreal/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/diffpy/diffpy.srreal\n\ndiffpy.srreal\n========================================================================\n\nCalculators for PDF, bond valence sum and other pair quantities\n\nThe diffpy.srreal package provides calculators for atomic pair distribution\nfunction (PDF), bond valence sums (BVS), atom overlaps for a hard-sphere\nmodel, bond distances and directions up to specified maximum distance. The\natomic structure models are represented with internal classes as non-periodic,\nperiodic or structures with space group symmetries. The package provides\nimplicit adapters from diffpy.structure classes or from Crystal or Molecule\nobjects from pyobjcryst. Adapters can be easily defined for any other\nstructure representations in Python allowing their direct use with the\ncalculators. Calculators support two evaluation models - BASIC, which\nperforms a full pair-summation every time, and OPTIMIZED, which updates only\npair contributions that have changed since the last evaluation. Calculations\ncan be split among parallel jobs using Python multiprocessing package or any\nother library that provides parallel map function. PDF calculations can\nbe done in two modes - either as a real-space summation of peak profiles\n(PDFCalculator) or as a reciprocal-space Debye summation and Fourier\ntransform of the total scattering structure function (DebyePDFCalculator).\n\nThe diffpy.srreal package is a Python binding to the C++ library libdiffpy\n(https://github.com/diffpy/libdiffpy). Calculators are created as\nobjects of a given calculator type and so multiple instances of the same\ncalculator type can exist with different configurations. Calculators are\ncomposed of other objects that perform lower-level tasks, such as calculating\npeak profile or looking up atom scattering factors. These objects can be\nre-assigned at runtime allowing to easily customize the calculation procedure.\nNew classes can be defined using object inheritance either in Python or in C++\nand used with the existing calculators; as an example, this allows to\ncalculate PDF with a user-defined profile function. A new calculator class\ncan be also defined for any quantity that is obtained by iteration over atom\npairs, by defining only the function that processes atom-pair contributions.\n\nFor more information about the diffpy.srreal library, see users manual at\nhttp://diffpy.github.io/diffpy.srreal.\n\n\nREQUIREMENTS\n------------------------------------------------------------------------\n\nThe diffpy.srreal package requires Python 3.7, 3.6, 3.5 or 2.7,\nC++ compiler and the following software:\n\n* ``setuptools`` - tools for installing Python packages\n* ``NumPy`` - library for scientific computing with Python\n* ``python-dev`` - header files for interfacing Python with C\n* ``libboost-all-dev`` - Boost C++ libraries and development files (1.43 or later)\n* ``libdiffpy`` - C++ library for PDF, bond valence sum and other pair\n quantity calculators https://github.com/diffpy/libdiffpy\n* ``diffpy.structure`` - simple storage and manipulation of atomic structures\n https://github.com/diffpy/diffpy.structure\n* ``scons`` - software construction tool (optional)\n\nOptional software:\n\n* ``periodictable`` - periodic table of elements in Python\n http://www.reflectometry.org/danse/elements.html\n* ``pyobjcryst`` - Python bindings to ObjCryst++, the Object Oriented\n Crystallographic library for C++, https://github.com/diffpy/pyobjcryst.\n\nWe recommend to use `Anaconda Python `_\nas it allows to install all software dependencies together with\ndiffpy.srreal. For other Python distributions it is necessary to\ninstall the required software separately. As an example, on Ubuntu\nLinux some of the required software can be installed using ::\n\n sudo apt-get install \\\n python-setuptools python-numpy scons \\\n build-essential python-dev libboost-all-dev\n\nTo install the remaining packages see the installation instructions\nat their respective web pages.\n\n\nINSTALLATION\n------------------------------------------------------------------------\n\nThe preferred method is to use Anaconda Python and install from the\n\"diffpy\" channel of Anaconda packages ::\n\n conda config --add channels diffpy\n conda install diffpy.srreal\n\ndiffpy.srreal is also included in the \"diffpy-cmi\" collection\nof packages for structure analysis ::\n\n conda install diffpy-cmi\n\nIf you prefer to install from sources, make sure all required software\npackages are in place and then run ::\n\n python setup.py install\n\nYou may need to use ``sudo`` with system Python so the process is\nallowed to copy files to the system directories. If administrator (root)\naccess is not available, see the output from\n``python setup.py install --help`` for options to install to\na user-writable location. The installation integrity can be\nverified by executing the included tests with ::\n\n python -m diffpy.srreal.tests.run\n\nAn alternative way of installing diffpy.srreal is to use the SCons tool,\nwhich can speed up the process by compiling C++ files in several\nparallel jobs (-j4) ::\n\n sudo scons -j4 install\n\nSee ``scons -h`` for decription of build targets and options.\n\n\nDEVELOPMENT\n------------------------------------------------------------------------\n\ndiffpy.srreal is an open-source software developed as a part of the\nDiffPy-CMI complex modeling initiative at the Brookhaven National\nLaboratory. The diffpy.srreal sources are hosted at\nhttps://github.com/diffpy/diffpy.srreal.\n\nFeel free to fork the project and contribute. To install diffpy.srreal\nin a development mode, where the sources are directly used by Python\nrather than copied to a system directory, use ::\n\n python setup.py develop --user\n\nTo rebuild the C++ extension module and then optionally test the code\nintegrity, use ::\n\n scons -j4 build=debug develop [test]\n\nWhen developing with Anaconda Python it is essential to specify\nheader path, library path and runtime library path for the active\nAnaconda environment. This can be achieved by setting the ``CPATH``,\n``LIBRARY_PATH`` and ``LDFLAGS`` environment variables as follows::\n\n # resolve the prefix directory P of the active Anaconda environment\n P=\"$(conda info --json | grep default_prefix | cut -d\\\" -f4)\"\n export CPATH=$P/include\n export LIBRARY_PATH=$P/lib\n export LDFLAGS=-Wl,-rpath,$P/lib\n # compile and re-install diffpy.srreal\n scons -j4 build=debug develop\n\nOn Mac OS X the distributed Anaconda packages are built for operating\nsystem version 10.7, which may be incompatible with codes compiled on a\nnewer OS. To avoid this problem set the environment variable\n``MACOSX_DEPLOYMENT_TARGET=10.7``. This allows to build diffpy.srreal\nagainst the Anaconda package for the libdiffpy library.\n\n\nCONTACTS\n------------------------------------------------------------------------\n\nFor more information on diffpy.srreal please visit the project web-page\n\nhttp://www.diffpy.org\n\nor email Prof. Simon Billinge at sb2896@columbia.edu.", "description_content_type": "text/x-rst", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/diffpy/diffpy.srreal/", "keywords": "PDF BVS atom overlap calculator real-space", "license": "BSD-style license", "maintainer": "Pavol Juhas", "maintainer_email": "pavol.juhas@gmail.com", "name": "diffpy.srreal", "package_url": "https://pypi.org/project/diffpy.srreal/", "platform": "", "project_url": "https://pypi.org/project/diffpy.srreal/", "project_urls": { "Homepage": "https://github.com/diffpy/diffpy.srreal/" }, "release_url": "https://pypi.org/project/diffpy.srreal/1.3.0/", "requires_dist": null, "requires_python": "", "summary": "calculators for PDF, bond valence sum, and other quantities based on atom pair interaction.", "version": "1.3.0" }, "last_serial": 4936676, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "73904208f3f08c7fb7357d8a860545dc", "sha256": "fec5dffe5184e607354fc68a2737362d568b972d601b7eec3552da8451101260" }, "downloads": -1, "filename": "diffpy.srreal-1.0.tar.gz", "has_sig": false, "md5_digest": "73904208f3f08c7fb7357d8a860545dc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 116320, "upload_time": "2014-03-21T23:40:21", "url": "https://files.pythonhosted.org/packages/02/8e/46426b6265e467b9c8bc9eefd594167291cc653174d8fa83cec178e1379b/diffpy.srreal-1.0.tar.gz" } ], "1.0a0": [ { "comment_text": "", "digests": { "md5": "bcf54cc48686addd94b06db84b080a81", "sha256": "67678271205d9fe68ba64fe8d9a169c05d47790f6ecc8119b7665c4ddea15475" }, "downloads": -1, "filename": "diffpy.srreal-1.0a0.tar.gz", "has_sig": false, "md5_digest": "bcf54cc48686addd94b06db84b080a81", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 116112, "upload_time": "2014-03-06T21:41:01", "url": "https://files.pythonhosted.org/packages/09/7a/54a4491cdb0f5c48513473391f7ed2ff5f70b5bc915883fd786872932d80/diffpy.srreal-1.0a0.tar.gz" } ], "1.1": [ { "comment_text": "", "digests": { "md5": "6cd6ca02aa244ae268f39686991efac9", "sha256": "eec7d67a7fcf3d7b9680dc7c57e5f426f7ff99d1b1c819268dbd6cfc8b3a604c" }, "downloads": -1, "filename": "diffpy.srreal-1.1.tar.gz", "has_sig": false, "md5_digest": "6cd6ca02aa244ae268f39686991efac9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 134076, "upload_time": "2016-01-29T22:47:12", "url": "https://files.pythonhosted.org/packages/42/e5/f601f67554c345ea5d0a70acd899c1b8ac9e2e6dc53f440bafe41239516a/diffpy.srreal-1.1.tar.gz" } ], "1.1.1": [ { "comment_text": "", "digests": { "md5": "d205fe335ef520f1c7c6f7e54d374ee7", "sha256": "a974a59a57dce4879ef6a68bb363b234998ae88279eafb26fc15e9c1e373a1bd" }, "downloads": -1, "filename": "diffpy.srreal-1.1.1.tar.gz", "has_sig": false, "md5_digest": "d205fe335ef520f1c7c6f7e54d374ee7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 128624, "upload_time": "2016-10-03T19:42:33", "url": "https://files.pythonhosted.org/packages/32/4b/1ac15843ac29543a0478ebee6cab2f2cef89913625effc8f8354a94f2bfb/diffpy.srreal-1.1.1.tar.gz" } ], "1.1.2": [ { "comment_text": "", "digests": { "md5": "21492c6eaa8ab58dfd7c3f26ad04c247", "sha256": "b569e44b6c8b9662dbf92b5fe46ba9feb9d6a7d448daf8c88c7c677490135acf" }, "downloads": -1, "filename": "diffpy.srreal-1.1.2.tar.gz", "has_sig": false, "md5_digest": "21492c6eaa8ab58dfd7c3f26ad04c247", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 128910, "upload_time": "2016-10-28T20:38:07", "url": "https://files.pythonhosted.org/packages/9e/f3/eb57e1cdf03308de2bbccfc574b82c69365dace97f55d1f1a6f305e732c9/diffpy.srreal-1.1.2.tar.gz" } ], "1.1.3": [ { "comment_text": "", "digests": { "md5": "b84017dd8fd3bf5ec64d87b7e55cc6ce", "sha256": "47822a1c0c7e448d8c6fb9ae31930778fa10b98f63444ed7c7b0cd4b3fb6b932" }, "downloads": -1, "filename": "diffpy.srreal-1.1.3.tar.gz", "has_sig": false, "md5_digest": "b84017dd8fd3bf5ec64d87b7e55cc6ce", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 129195, "upload_time": "2016-12-08T01:25:05", "url": "https://files.pythonhosted.org/packages/f4/6b/ca1bc39479bd74429fbc00f23d8e11f5ebb9b2e8860246893ae5f7e9c2df/diffpy.srreal-1.1.3.tar.gz" } ], "1.1a0": [ { "comment_text": "", "digests": { "md5": "af4261cffa72d2e26060fc01b215d982", "sha256": "fb83f870d7db735c8e12885cda9dbae465f520e6bfe82787fff18ae118077e3a" }, "downloads": -1, "filename": "diffpy.srreal-1.1a0.tar.gz", "has_sig": false, "md5_digest": "af4261cffa72d2e26060fc01b215d982", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 120517, "upload_time": "2015-09-08T19:32:48", "url": "https://files.pythonhosted.org/packages/1f/9e/5270eac9c716ea30f585bc57109ec44e5c14c82be4a8578953cc43603271/diffpy.srreal-1.1a0.tar.gz" } ], "1.2": [ { "comment_text": "", "digests": { "md5": "bb8745dd2fcc03562fee633c3a5798b7", "sha256": "150cad8abc4aa7bdd82f7507d9909c32bd66b92d50dcd52ea944a08de65e8fe9" }, "downloads": -1, "filename": "diffpy.srreal-1.2.tar.gz", "has_sig": false, "md5_digest": "bb8745dd2fcc03562fee633c3a5798b7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 131799, "upload_time": "2017-07-06T20:26:40", "url": "https://files.pythonhosted.org/packages/e8/de/d100d3b7c0ad234e5db39e39676a82a140b0000b859bd9de79645fc35312/diffpy.srreal-1.2.tar.gz" } ], "1.3.0": [ { "comment_text": "", "digests": { "md5": "23ecd9e489c75d034e163ab2370bf463", "sha256": "c3e4bf318a2e1e9dfcb81a520adc1bb174f09c0c9100d3910f660b33400510cb" }, "downloads": -1, "filename": "diffpy.srreal-1.3.0.tar.gz", "has_sig": false, "md5_digest": "23ecd9e489c75d034e163ab2370bf463", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 138183, "upload_time": "2019-03-13T22:13:38", "url": "https://files.pythonhosted.org/packages/12/62/874ff44c26ac69af42afaf70afc79bcc8776a1b3213ad1c16c6feff78c4f/diffpy.srreal-1.3.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "23ecd9e489c75d034e163ab2370bf463", "sha256": "c3e4bf318a2e1e9dfcb81a520adc1bb174f09c0c9100d3910f660b33400510cb" }, "downloads": -1, "filename": "diffpy.srreal-1.3.0.tar.gz", "has_sig": false, "md5_digest": "23ecd9e489c75d034e163ab2370bf463", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 138183, "upload_time": "2019-03-13T22:13:38", "url": "https://files.pythonhosted.org/packages/12/62/874ff44c26ac69af42afaf70afc79bcc8776a1b3213ad1c16c6feff78c4f/diffpy.srreal-1.3.0.tar.gz" } ] }