supercell-step


Namesupercell-step JSON
Version 2023.11.5 PyPI version JSON
download
home_pagehttps://github.com/molssi-seamm/supercell_step
SummaryA SEAMM plug-in for building supercells of periodic systems.
upload_time2023-11-05 22:13:33
maintainer
docs_urlNone
authorPaul Saxe
requires_python
licenseBSD-3-Clause
keywords seamm plug-in flowchart supercell unitcell periodic atomistic
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            ==============
Supercell Step
==============

.. image:: https://img.shields.io/github/issues-pr-raw/molssi-seamm/supercell_step
   :target: https://github.com/molssi-seamm/supercell_step/pulls
   :alt: GitHub pull requests

.. image:: https://github.com/molssi-seamm/supercell_step/workflows/CI/badge.svg
   :target: https://github.com/molssi-seamm/supercell_step/actions
   :alt: Build Status

.. image:: https://codecov.io/gh/molssi-seamm/supercell_step/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/molssi-seamm/supercell_step
   :alt: Code Coverage

.. image:: https://github.com/molssi-seamm/supercell_step/workflows/CodeQL/badge.svg
   :target: https://github.com/molssi-seamm/supercell_step/security/code-scanning
   :alt: Code Quality

.. image:: https://github.com/molssi-seamm/supercell_step/workflows/Release/badge.svg
   :target: https://molssi-seamm.github.io/supercell_step/index.html
   :alt: Documentation Status

.. image:: https://pyup.io/repos/github/molssi-seamm/supercell_step/shield.svg
   :target: https://pyup.io/repos/github/molssi-seamm/supercell_step/
   :alt: Updates for Dependencies

.. image:: https://img.shields.io/pypi/v/supercell_step.svg
   :target: https://pypi.python.org/pypi/supercell_step
   :alt: PyPi VERSION

A SEAMM plug-in for building supercells of periodic systems.

* Free software: BSD-3-Clause
* Documentation: https://molssi-seamm.github.io/supercell_step/index.html
* Code: https://github.com/molssi-seamm/supercell_step

Features
--------

* Currently only accepts na, nb, and nc, the numbers of cells in the
  three directions.
* To do:

  - Create a supercell with a minimum dimension, e.g. 10 Å.
  - Create orthorhombic cells from hexagonal ones.
  - Build using the primitive cell rather than conventional.

Acknowledgements
----------------

This package was created with Cookiecutter_ and the `molssi-seamm/cookiecutter-seamm-plugin`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`molssi-seamm/cookiecutter-seamm-plugin`: https://github.com/molssi-seamm/cookiecutter-seamm-plugin

Developed by the Molecular Sciences Software Institute (MolSSI_),
which receives funding from the `National Science Foundation`_ under
award OAC-1547580 and CHE-2136142.

.. _MolSSI: https://www.molssi.org
.. _`National Science Foundation`: https://www.nsf.gov


=======
History
=======
2023.11.5 -- Updated to handle symmetry in systems

2021.2.12 --
    * Updated the README file to give a better description.
    * Updated the short description in setup.py to work with the new installer.
    * Added keywords for better searchability.

2021.2.4 --
    * Updated for compatibility with the new system classes in MolSystem
      2021.2.2 release.

2020.12.5 -- 
    * Added support for non-orthorhombic cells.
    * Updated to be compatible with the new system classes in MolSystem.
    * Internal: switching CI from TravisCI to GitHub Actions, and in the
      process moving documentation from ReadTheDocs to GitHub Pages where
      it is consolidated with the main SEAMM documentation.

0.9.1 -- 20 June 2020
    * Bugfix: Was not properly copying charges to the new system.

0.9 -- 18 June 2020
    * First release on PyPI.
    * Working but only for orthorhombic cells

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/molssi-seamm/supercell_step",
    "name": "supercell-step",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "SEAMM,plug-in,flowchart,supercell,unitcell,periodic,atomistic",
    "author": "Paul Saxe",
    "author_email": "psaxe@molssi.org",
    "download_url": "https://files.pythonhosted.org/packages/d9/df/4e1c1b42e9ab916e3298aeac2df0352cf211554f7145a69207aaa2aeb867/supercell_step-2023.11.5.tar.gz",
    "platform": "Linux",
    "description": "==============\nSupercell Step\n==============\n\n.. image:: https://img.shields.io/github/issues-pr-raw/molssi-seamm/supercell_step\n   :target: https://github.com/molssi-seamm/supercell_step/pulls\n   :alt: GitHub pull requests\n\n.. image:: https://github.com/molssi-seamm/supercell_step/workflows/CI/badge.svg\n   :target: https://github.com/molssi-seamm/supercell_step/actions\n   :alt: Build Status\n\n.. image:: https://codecov.io/gh/molssi-seamm/supercell_step/branch/master/graph/badge.svg\n   :target: https://codecov.io/gh/molssi-seamm/supercell_step\n   :alt: Code Coverage\n\n.. image:: https://github.com/molssi-seamm/supercell_step/workflows/CodeQL/badge.svg\n   :target: https://github.com/molssi-seamm/supercell_step/security/code-scanning\n   :alt: Code Quality\n\n.. image:: https://github.com/molssi-seamm/supercell_step/workflows/Release/badge.svg\n   :target: https://molssi-seamm.github.io/supercell_step/index.html\n   :alt: Documentation Status\n\n.. image:: https://pyup.io/repos/github/molssi-seamm/supercell_step/shield.svg\n   :target: https://pyup.io/repos/github/molssi-seamm/supercell_step/\n   :alt: Updates for Dependencies\n\n.. image:: https://img.shields.io/pypi/v/supercell_step.svg\n   :target: https://pypi.python.org/pypi/supercell_step\n   :alt: PyPi VERSION\n\nA SEAMM plug-in for building supercells of periodic systems.\n\n* Free software: BSD-3-Clause\n* Documentation: https://molssi-seamm.github.io/supercell_step/index.html\n* Code: https://github.com/molssi-seamm/supercell_step\n\nFeatures\n--------\n\n* Currently only accepts na, nb, and nc, the numbers of cells in the\n  three directions.\n* To do:\n\n  - Create a supercell with a minimum dimension, e.g. 10 \u00c5.\n  - Create orthorhombic cells from hexagonal ones.\n  - Build using the primitive cell rather than conventional.\n\nAcknowledgements\n----------------\n\nThis package was created with Cookiecutter_ and the `molssi-seamm/cookiecutter-seamm-plugin`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`molssi-seamm/cookiecutter-seamm-plugin`: https://github.com/molssi-seamm/cookiecutter-seamm-plugin\n\nDeveloped by the Molecular Sciences Software Institute (MolSSI_),\nwhich receives funding from the `National Science Foundation`_ under\naward OAC-1547580 and CHE-2136142.\n\n.. _MolSSI: https://www.molssi.org\n.. _`National Science Foundation`: https://www.nsf.gov\n\n\n=======\nHistory\n=======\n2023.11.5 -- Updated to handle symmetry in systems\n\n2021.2.12 --\n    * Updated the README file to give a better description.\n    * Updated the short description in setup.py to work with the new installer.\n    * Added keywords for better searchability.\n\n2021.2.4 --\n    * Updated for compatibility with the new system classes in MolSystem\n      2021.2.2 release.\n\n2020.12.5 -- \n    * Added support for non-orthorhombic cells.\n    * Updated to be compatible with the new system classes in MolSystem.\n    * Internal: switching CI from TravisCI to GitHub Actions, and in the\n      process moving documentation from ReadTheDocs to GitHub Pages where\n      it is consolidated with the main SEAMM documentation.\n\n0.9.1 -- 20 June 2020\n    * Bugfix: Was not properly copying charges to the new system.\n\n0.9 -- 18 June 2020\n    * First release on PyPI.\n    * Working but only for orthorhombic cells\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "A SEAMM plug-in for building supercells of periodic systems.",
    "version": "2023.11.5",
    "project_urls": {
        "Homepage": "https://github.com/molssi-seamm/supercell_step"
    },
    "split_keywords": [
        "seamm",
        "plug-in",
        "flowchart",
        "supercell",
        "unitcell",
        "periodic",
        "atomistic"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "142b23f3193d08a1aa20f193f7950b5a27e06d652c17b4c54fd92a293765921c",
                "md5": "37e87bdfa7f732e8a5d106b014b6b567",
                "sha256": "a0179df5d1664b213063a478950b3d508a85bb131a8babcdab494e47cb8f5e55"
            },
            "downloads": -1,
            "filename": "supercell_step-2023.11.5-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "37e87bdfa7f732e8a5d106b014b6b567",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 12938,
            "upload_time": "2023-11-05T22:13:32",
            "upload_time_iso_8601": "2023-11-05T22:13:32.313091Z",
            "url": "https://files.pythonhosted.org/packages/14/2b/23f3193d08a1aa20f193f7950b5a27e06d652c17b4c54fd92a293765921c/supercell_step-2023.11.5-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d9df4e1c1b42e9ab916e3298aeac2df0352cf211554f7145a69207aaa2aeb867",
                "md5": "0705d09a77edca232286f3c7fa4a9b46",
                "sha256": "62a2605af829aa4e5d673c66df12b0dfaa44e197194a5c44386014d398bf223c"
            },
            "downloads": -1,
            "filename": "supercell_step-2023.11.5.tar.gz",
            "has_sig": false,
            "md5_digest": "0705d09a77edca232286f3c7fa4a9b46",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 282682,
            "upload_time": "2023-11-05T22:13:33",
            "upload_time_iso_8601": "2023-11-05T22:13:33.752061Z",
            "url": "https://files.pythonhosted.org/packages/d9/df/4e1c1b42e9ab916e3298aeac2df0352cf211554f7145a69207aaa2aeb867/supercell_step-2023.11.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-05 22:13:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "molssi-seamm",
    "github_project": "supercell_step",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "supercell-step"
}
        
Elapsed time: 0.30772s