{ "info": { "author": "Tomasz Necio", "author_email": "Tomasz.Necio@fuw.edu.pl", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Science/Research", "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Topic :: Scientific/Engineering :: Physics" ], "description": "# supercell-core\nPackage for investigation of mulitlayer 2D heterostructures lattices\n\nAuthor: Tomasz Necio, University of Warsaw\n\nCopyright (C) 2019 University of Warsaw\n\n# Installation:\n`pip3 install supercell-core --user`\n\n# Documentation\n\nhttps://readthedocs.org/projects/supercell-core/\n\n# Usage example\n\n```\n# Load supercell_core\nimport supercell_core as sc\n\n# Read NiPS3 data from a POSCAR file into `nips3` Lattice object\n# We need to provide names of chemical elements because they don't have to\n# appear in POSCAR, but supercell-core needs them\n# This will only work if you actually have a file named \"POSCAR_nips3\",\n# you can copy it from /supercell_core/resources/vasp/NiPS3 directory\nnips3 = sc.read_POSCAR(\"POSCAR_nips3\", [\"Ni\", \"P\", \"S\"])\n\n# Let's create `graphene` Lattice object by hand\ngraphene = sc.lattice()\ngraphene.set_vectors([2.133, -1.23], [2.133, 1.23])\n# atom \"C\" at position (0, 0, 0)\ngraphene.add_atom(\"C\", (0, 0, 0))\n\n# Methods can be chained\nnips3_with_a_rouge_atom = sc.lattice().set_vectors(*nips3.vectors()) \\\n .add_atom(\"U\", (0, 0, 1), spin=(0, 0, 1))\n\n# Define heterostructure\nh = sc.heterostructure().set_substrate(graphene).add_layer(nips3)\n\n# Calculate strain tensor for particular supercell configuration\n# (see help(sc.heterostructure()) for details)\nM = [[1, -9], [8, 1]]\ntheta = 21.9 * sc.DEGREE\nres = h.calc(M=M, thetas=[theta])\nprint(res.strain_tensors()) # Use help(res) to see all public methods of `Result`\n\n# Optimise strain to find best supercell, with max repetition along any\n# axis <= 12 substrate unit cells, and relative angle only from 0 to 7 degrees\n# with resolution 0.1 deg\nres = h.opt(max_el=12, thetas=[np.arange(0, 7*sc.DEGREE, 0.1*sc.DEGREE)])\nsuperlattice = res.superlattice() # Lattice object\nsuperlattice.save_POSCAR(\"POSCAR_sc\") # save to file\n\nfig, ax = superlattice.draw()\nfig.show() # Show unit cell using matplotlib library\n\n# To learn more use built-in documentation, e.g.:\nhelp(nips3) # shows help on Lattice object when Python is in interactive mode (use 'q' to quit)\nprint(help(nips3)) # prints to stdout\n```\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/tnecio/supercell-core", "keywords": "", "license": "GPLv3", "maintainer": "", "maintainer_email": "", "name": "supercell-core", "package_url": "https://pypi.org/project/supercell-core/", "platform": "", "project_url": "https://pypi.org/project/supercell-core/", "project_urls": { "Homepage": "https://github.com/tnecio/supercell-core" }, "release_url": "https://pypi.org/project/supercell-core/0.0.3/", "requires_dist": [ "numpy", "matplotlib" ], "requires_python": "", "summary": "Package for investigation of 2D van der Waals heterostructures' lattices", "version": "0.0.3" }, "last_serial": 5893608, "releases": { "0.0.2": [ { "comment_text": "", "digests": { "md5": "6630e4076e2cd49e45280d8afc240684", "sha256": "9a03a54bd788cc391c70a4bb61192dc13ff8669f3036ff43df9d226cffc89688" }, "downloads": -1, "filename": "supercell_core-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "6630e4076e2cd49e45280d8afc240684", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 48090, "upload_time": "2019-09-27T00:07:25", "url": "https://files.pythonhosted.org/packages/ff/b7/2b2057fcddd4555116608d6370f81cb2842b0a7b44fe14ff1c567b610220/supercell_core-0.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a2b2bd7177ff8a25390281cfbe730f43", "sha256": "2b883b80bac3c7109892100dc779b38bbedd8edcbedab456023a36d1892bc995" }, "downloads": -1, "filename": "supercell_core-0.0.2.tar.gz", "has_sig": false, "md5_digest": "a2b2bd7177ff8a25390281cfbe730f43", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 30362, "upload_time": "2019-09-27T00:07:27", "url": "https://files.pythonhosted.org/packages/bd/da/7d3cf66be4c022d81bb32a5245906933e335febe10217d7ec25e8d4f28c5/supercell_core-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "0bfb862dbc36a5f63471d6f2ba63f7e7", "sha256": "97933599831ff9bf32b4322e6f69b9a6e0e186bd3788737f3a1b9146bafd5d11" }, "downloads": -1, "filename": "supercell_core-0.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "0bfb862dbc36a5f63471d6f2ba63f7e7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 48177, "upload_time": "2019-09-27T01:51:35", "url": "https://files.pythonhosted.org/packages/55/b6/e3556d696a35420eb84c1091f9845eea4ab16b8308564c939bb2de409733/supercell_core-0.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8be4c697712c92650f6320c47e34ebf5", "sha256": "0e2ae6f3382a7f3435aa7fdabbd7c4642acac84f0cfd90dc009ddf9133c55443" }, "downloads": -1, "filename": "supercell_core-0.0.3.tar.gz", "has_sig": false, "md5_digest": "8be4c697712c92650f6320c47e34ebf5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 30582, "upload_time": "2019-09-27T01:51:37", "url": "https://files.pythonhosted.org/packages/02/ef/b73632aaf56738023104eaef6149bbd58dafb551e229102d6a24f378fae9/supercell_core-0.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "0bfb862dbc36a5f63471d6f2ba63f7e7", "sha256": "97933599831ff9bf32b4322e6f69b9a6e0e186bd3788737f3a1b9146bafd5d11" }, "downloads": -1, "filename": "supercell_core-0.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "0bfb862dbc36a5f63471d6f2ba63f7e7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 48177, "upload_time": "2019-09-27T01:51:35", "url": "https://files.pythonhosted.org/packages/55/b6/e3556d696a35420eb84c1091f9845eea4ab16b8308564c939bb2de409733/supercell_core-0.0.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8be4c697712c92650f6320c47e34ebf5", "sha256": "0e2ae6f3382a7f3435aa7fdabbd7c4642acac84f0cfd90dc009ddf9133c55443" }, "downloads": -1, "filename": "supercell_core-0.0.3.tar.gz", "has_sig": false, "md5_digest": "8be4c697712c92650f6320c47e34ebf5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 30582, "upload_time": "2019-09-27T01:51:37", "url": "https://files.pythonhosted.org/packages/02/ef/b73632aaf56738023104eaef6149bbd58dafb551e229102d6a24f378fae9/supercell_core-0.0.3.tar.gz" } ] }