{ "info": { "author": "Benjamin J. Morgan", "author_email": "b.j.morgan@bath.ac.uk", "bugtrack_url": null, "classifiers": [], "description": "[![PyPI version](https://badge.fury.io/py/bsym.svg)](https://badge.fury.io/py/bsym)\n[![DOI](https://zenodo.org/badge/19279643.svg)](https://zenodo.org/badge/latestdoi/19279643)\n[![status](http://joss.theoj.org/papers/6696543fc631bf66feb99a9cde808a39/status.svg)](http://joss.theoj.org/papers/6696543fc631bf66feb99a9cde808a39)\n[![Build Status](https://travis-ci.org/bjmorgan/bsym.svg?branch=master)](https://travis-ci.org/bjmorgan/bsym)\n[![Test Coverage](https://codeclimate.com/github/bjmorgan/bsym/badges/coverage.svg)](https://codeclimate.com/github/bjmorgan/bsym/coverage)\n[![Documentation Status](https://readthedocs.org/projects/bsym/badge/?version=latest)](http://bsym.readthedocs.io/en/latest/?badge=latest)\n\n\n`bsym` is a basic Python symmetry module. It consists of core classes that describe configuration vector spaces, their symmetry operations, and specific configurations of objects within these spaces. The module also contains an interface for working with [`pymatgen`](http://pymatgen.org) `Structure` objects, to allow simple generation of disordered symmetry-inequivalent structures from a symmetric parent crystal structure.\n\nExamples are provided in a Jupyter notebook [here][example_notebook]. \nAPI documentation is [here][API]. \nSource code is available as a git repository at [https://github.com/bjmorgan/bsym][github].\n\n\n## Installation\n\n```\npip install bsym\n```\n\nOr download the latest release from [GitHub](httpsL//github.com/bjmorgan/bsym/releases), and install\n```\ncd bsym\npython setup.py install\n```\n\nOr clone the latest development version\n```\ngit clone git@github.com:bjmorgan/bsym.git\n```\nand install the same way.\n```\ncd bsym\npython setup.py install \n```\n\n## Tests\n\nAutomated testing of the latest commit happens [here](https://travis-ci.org/bjmorgan/bsym).\n\nManual tests can be run using\n```\npython -m unittest discover\n```\n\nThe code has been tested with Python versions 3.5 and above.\n\n## Documentation\nAn overview of the capabilities of `bsym` along with example code is contained in a [Jupyter notebook](http://jupyter-notebook.readthedocs.io/en/latest/#) in the repository `examples` directory [examples/bsym_examples.ipynb][example_notebook].\n\nAPI documentation is available [here](http://bsym.readthedocs.io).\n\n## I want to generate a set of symmetry-inequivalent crystal structures\n`bsym` can enumerate symmetry-inequivalent crystal structures generated by partial substitutions, starting from a parent structure described by a `pymatgen` `Structure` object. \nExample code is in the [example notebook][example_notebook]. \nAlso refer to the [`bsym.interface.pymatgen.unique_structure_substitutions`](http://bsym.readthedocs.io/en/latest/api/interface/pymatgen.html#bsym.interface.pymatgen.unique_structure_substitutions) documentation.\n\n## Citing `bsym`\n\nThis code can be cited as:\n\nMorgan, Benjamin J. (2017). *bsym - a Basic Symmetry Module*. The Journal of Open Source Software. http://doi.org/10.21105/joss.00370\n\n### BibTeX\n\n```\n@article{Morgan_JOSS2017b,\n doi = {10.21105/joss.00370},\n url = {https://doi.org/10.21105/joss.00370},\n year = {2017},\n month = {aug},\n publisher = {The Open Journal},\n volume = {2},\n number = {16},\n author = {Benjamin J. Morgan},\n title = {bsym: A basic symmetry module},\n journal = {The Journal of Open Source Software}\n}\n```\n\n[example_notebook]:http://nbviewer.jupyter.org/github/bjmorgan/bsym/blob/master/examples/bsym_examples.ipynb\n[github]: https://github.com/bjmorgan/bsym\n[doi]: https://zenodo.org/badge/latestdoi/19279643\n[API]: http://bsym.readthedocs.io/en/latest/modules.html\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "https://github.com/bjmorgan/bsym/archive/1.1.1.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/bjmorgan/bsym", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "bsym", "package_url": "https://pypi.org/project/bsym/", "platform": "", "project_url": "https://pypi.org/project/bsym/", "project_urls": { "Download": "https://github.com/bjmorgan/bsym/archive/1.1.1.tar.gz", "Homepage": "https://github.com/bjmorgan/bsym" }, "release_url": "https://pypi.org/project/bsym/1.1.1/", "requires_dist": [ "codeclimate-test-reporter", "pymatgen (>=v2017.10.16)", "numpy", "tqdm", "coverage (==4.3.4)" ], "requires_python": ">=3.5", "summary": "A Basic Symmetry Module", "version": "1.1.1" }, "last_serial": 4802004, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "7bfa55f8810be01e0b197913cbf3287e", "sha256": "f25f38c351c3d7c2f593891e1c4e1003b9206dc9afbb5ef8d6114c16cdecc924" }, "downloads": -1, "filename": "bsym-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "7bfa55f8810be01e0b197913cbf3287e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 16261, "upload_time": "2017-08-18T09:34:36", "url": "https://files.pythonhosted.org/packages/d6/93/0cb7f9e27806ff6936da7c5eb924eca515253fee1431e74e9102ab4d43a8/bsym-1.0.0-py3-none-any.whl" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "49730eddb5f5e18cdfcaa379917355bd", "sha256": "f9c4d1e4269a00904e1b1a533c99d0a5191706d77f4d4cdde365a95e5e7267da" }, "downloads": -1, "filename": "bsym-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "49730eddb5f5e18cdfcaa379917355bd", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 16388, "upload_time": "2017-08-18T09:39:45", "url": "https://files.pythonhosted.org/packages/5e/22/5500956695e64c8199398722dec40f2686477a9caee6464f8ccb2116e900/bsym-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1cb61fedbf2891bc591b6ebf5087b891", "sha256": "5d7131f82d4b11e780aabc653dd51d3bfb55b3111796075f374f71e464fb6253" }, "downloads": -1, "filename": "bsym-1.0.1.tar.gz", "has_sig": false, "md5_digest": "1cb61fedbf2891bc591b6ebf5087b891", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10687, "upload_time": "2017-08-18T09:39:47", "url": "https://files.pythonhosted.org/packages/5a/8d/58ef96d47a2d143be5cf7e2cccc02ae85159eea6e9be295eac5f5b463c12/bsym-1.0.1.tar.gz" } ], "1.0b1": [ { "comment_text": "", "digests": { "md5": "4ba41084a2759f15100f7e0ec5562335", "sha256": "728b271e6110654435ed3efa7088740ea09f4b3cb5c0daab92bccebbdec13e4b" }, "downloads": -1, "filename": "bsym-1.0b1-py3-none-any.whl", "has_sig": false, "md5_digest": "4ba41084a2759f15100f7e0ec5562335", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 13829, "upload_time": "2017-08-02T21:28:50", "url": "https://files.pythonhosted.org/packages/b9/87/5251c20e9b0e151048f96f016c2816cb047332d8c3a79b8a165ffd2f9bce/bsym-1.0b1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "63a8481d1cd71d43c67827f816f2ee35", "sha256": "614c99e0c0c8b58d28489d0597569673670d435e7f234b6bac91e92d1420c58e" }, "downloads": -1, "filename": "bsym-1.0b1.tar.gz", "has_sig": false, "md5_digest": "63a8481d1cd71d43c67827f816f2ee35", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8791, "upload_time": "2017-08-02T21:28:51", "url": "https://files.pythonhosted.org/packages/bb/7e/c8c7a6a4e77c5e6654dbfd718ebca0c63ac19eaf3f2b226dea25366d53ef/bsym-1.0b1.tar.gz" } ], "1.0b2": [ { "comment_text": "", "digests": { "md5": "04f86494435d878f8fa748e73f9b6484", "sha256": "5795aa86e12012ae75c4de0144c1db9456bf4c19a62d03dae0ffb3130c293e6d" }, "downloads": -1, "filename": "bsym-1.0b2-py3-none-any.whl", "has_sig": false, "md5_digest": "04f86494435d878f8fa748e73f9b6484", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 13877, "upload_time": "2017-08-03T07:59:23", "url": "https://files.pythonhosted.org/packages/55/d8/c713778b28f393675b99e480dc020aa9eff567e6b934acf56f789a8ea908/bsym-1.0b2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6719b4bf3e4fce0a5290fa4609a05e9b", "sha256": "8f7110404b62bdc6376d980ef1352ce8edfb96400d46031687b25174c5df92e7" }, "downloads": -1, "filename": "bsym-1.0b2.tar.gz", "has_sig": false, "md5_digest": "6719b4bf3e4fce0a5290fa4609a05e9b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8836, "upload_time": "2017-08-03T07:59:24", "url": "https://files.pythonhosted.org/packages/6d/0b/8692634de3c33fcf14e251b0173cc8ef82e5955f558a740c5791f27a1c95/bsym-1.0b2.tar.gz" } ], "1.0b3": [ { "comment_text": "", "digests": { "md5": "3af74c586267d2f25b5c0419eb780c83", "sha256": "24aeb0c9df637845d4dcfe10b7dc7e5d4f29432d0c5a6a8325bb3c5d821c2e51" }, "downloads": -1, "filename": "bsym-1.0b3-py3-none-any.whl", "has_sig": false, "md5_digest": "3af74c586267d2f25b5c0419eb780c83", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 13874, "upload_time": "2017-08-17T11:52:41", "url": "https://files.pythonhosted.org/packages/d7/87/d17ed12ba05a1b4820be64fb81695e95721525d4aad2352d603ce563f6ab/bsym-1.0b3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d13563356b24e48ed32b07a7470e2c7f", "sha256": "5e2ee1819107dc30681e789d8d54212e9a5b6de18919a56e847d927bd8099de1" }, "downloads": -1, "filename": "bsym-1.0b3.tar.gz", "has_sig": false, "md5_digest": "d13563356b24e48ed32b07a7470e2c7f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8826, "upload_time": "2017-08-17T11:52:42", "url": "https://files.pythonhosted.org/packages/88/97/18ef26cc0df4fa9f7db70b7cf29c556b33ca54f2754a599139d68f72ed9a/bsym-1.0b3.tar.gz" } ], "1.0b4": [ { "comment_text": "", "digests": { "md5": "a1e6af79678c164e95e1c43d58901e3e", "sha256": "1004f4c96d2c95b2cc0888d3adb6a53b09cabf70ad82fb75512ec59c9cb5e449" }, "downloads": -1, "filename": "bsym-1.0b4-py3-none-any.whl", "has_sig": false, "md5_digest": "a1e6af79678c164e95e1c43d58901e3e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 13873, "upload_time": "2017-08-17T12:08:44", "url": "https://files.pythonhosted.org/packages/13/ec/d66147482cb8dfc90602cbe5c3d50f10961933962f38f74c406a54557943/bsym-1.0b4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9ab898400fa9a50975b9e7c28f801e6f", "sha256": "9de02ca89d4e66086a5636488efbecd010ed15fb18947ff7f3bf35c521932ef6" }, "downloads": -1, "filename": "bsym-1.0b4.tar.gz", "has_sig": false, "md5_digest": "9ab898400fa9a50975b9e7c28f801e6f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8829, "upload_time": "2017-08-17T12:08:45", "url": "https://files.pythonhosted.org/packages/bb/84/497fd76a9d4c7756de8d43604b645c7dc14d7160623b75329274596376d3/bsym-1.0b4.tar.gz" } ], "1.0b5": [ { "comment_text": "", "digests": { "md5": "4fa5dd7e9c2ed3c9205f91e100a280cf", "sha256": "fa937f5f9aa0ed0943a161c7005b545075f8ca44d176ef13e6feb3bc7ada9934" }, "downloads": -1, "filename": "bsym-1.0b5.tar.gz", "has_sig": false, "md5_digest": "4fa5dd7e9c2ed3c9205f91e100a280cf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10341, "upload_time": "2017-08-17T12:25:29", "url": "https://files.pythonhosted.org/packages/f4/e3/485354c0aee985ee703c157e8dd4c27994fec43cd741da93da5bb7209cc2/bsym-1.0b5.tar.gz" } ], "1.0b6": [ { "comment_text": "", "digests": { "md5": "bf5eea6b7bbc6189573564cc622ce497", "sha256": "a76c3bbe21178f873cc59cf8c1baa48fcc6f256f6b5b505bf546069f8c2e7275" }, "downloads": -1, "filename": "bsym-1.0b6-py3-none-any.whl", "has_sig": false, "md5_digest": "bf5eea6b7bbc6189573564cc622ce497", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 15959, "upload_time": "2017-08-17T12:32:54", "url": "https://files.pythonhosted.org/packages/04/52/5fcd518ff467290d767fac806f3580143096e29b79288a7097d60f9210e0/bsym-1.0b6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "967526fa7bf07ca5b49ef25f9e8c5b2d", "sha256": "2d0c0d18046a363d207e1f13f63360f841ef11de0a13dc5c9f974b009092133f" }, "downloads": -1, "filename": "bsym-1.0b6.tar.gz", "has_sig": false, "md5_digest": "967526fa7bf07ca5b49ef25f9e8c5b2d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10348, "upload_time": "2017-08-17T12:32:55", "url": "https://files.pythonhosted.org/packages/f0/68/6b26b9edea09073bd85ff9cfbb609890975bf4f1933ad39639f2aad7ef62/bsym-1.0b6.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "68219b77e5f3b890d6af99e2c0cf3dd7", "sha256": "9c01650e67421f909ace359c06e7b66a84a89165e44d10de0ffd91fa27302a3b" }, "downloads": -1, "filename": "bsym-1.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "68219b77e5f3b890d6af99e2c0cf3dd7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 17087, "upload_time": "2018-09-14T09:51:49", "url": "https://files.pythonhosted.org/packages/cd/54/848f6a2ac2f8de24d425a9f4c528135bc42a9f8cccb3edc7b552e2a12501/bsym-1.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "09f0ca4f8ec2160713ce501e979c2779", "sha256": "2f81e6110861035d8c4d95b4c1b8ad80857e996a9554f1f771e976c374b9c450" }, "downloads": -1, "filename": "bsym-1.1.0.tar.gz", "has_sig": false, "md5_digest": "09f0ca4f8ec2160713ce501e979c2779", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 14327, "upload_time": "2018-09-14T09:51:50", "url": "https://files.pythonhosted.org/packages/a2/65/3b7ca0beb7e620f7c0b8e36b73723b965e65cd6b4538fd5c61e35fa13f65/bsym-1.1.0.tar.gz" } ], "1.1.1": [ { "comment_text": "", "digests": { "md5": "ff102b7dd8d3196e921918c129a48885", "sha256": "2586ec7ff2456902670e55764ba7e9ce74c34eb3538b95b7d5417d84cfc48fb1" }, "downloads": -1, "filename": "bsym-1.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "ff102b7dd8d3196e921918c129a48885", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 18635, "upload_time": "2019-02-10T12:05:47", "url": "https://files.pythonhosted.org/packages/04/f1/dc21182d5d547d04f8afe2b66eacaa61d388fd83e3686427505fc28d5c9e/bsym-1.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9e43e2c86d868b052499c4662609c260", "sha256": "4f52992b27043302f55d1ec5e80fd24b01f99cd1ae4607d563c7c129e141f4fc" }, "downloads": -1, "filename": "bsym-1.1.1.tar.gz", "has_sig": false, "md5_digest": "9e43e2c86d868b052499c4662609c260", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 15321, "upload_time": "2019-02-10T12:05:49", "url": "https://files.pythonhosted.org/packages/43/79/fb236a558c13ab6b480a1fb15b31c4180b5d7c70eb0ef2752e90972b4cd2/bsym-1.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ff102b7dd8d3196e921918c129a48885", "sha256": "2586ec7ff2456902670e55764ba7e9ce74c34eb3538b95b7d5417d84cfc48fb1" }, "downloads": -1, "filename": "bsym-1.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "ff102b7dd8d3196e921918c129a48885", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 18635, "upload_time": "2019-02-10T12:05:47", "url": "https://files.pythonhosted.org/packages/04/f1/dc21182d5d547d04f8afe2b66eacaa61d388fd83e3686427505fc28d5c9e/bsym-1.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9e43e2c86d868b052499c4662609c260", "sha256": "4f52992b27043302f55d1ec5e80fd24b01f99cd1ae4607d563c7c129e141f4fc" }, "downloads": -1, "filename": "bsym-1.1.1.tar.gz", "has_sig": false, "md5_digest": "9e43e2c86d868b052499c4662609c260", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 15321, "upload_time": "2019-02-10T12:05:49", "url": "https://files.pythonhosted.org/packages/43/79/fb236a558c13ab6b480a1fb15b31c4180b5d7c70eb0ef2752e90972b4cd2/bsym-1.1.1.tar.gz" } ] }