{ "info": { "author": "Zaid Hassan aka RexGalilae", "author_email": "mdzaidgr8@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 2 - Pre-Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "VASP Tools\n==========\n\n|Build Status| |Documentation Status|\n\nVASP Tools is a set of modules and scripts that automate routine tasks\ninvolving VASP files using a very intuitive CLI. The ``/scripts``\ndirectory contains the scripts that implement the ``/vasp`` module to\nperform routine tasks on VASP files. This project is still a WIP and new\nscripts/modules will be added regularly over the next few weeks.\n\nRequirements\n------------\n\nAs of now, this package is only supported on ``Python>=3.5``. Since\nsupport for ``Python 2.7`` is set to be pulled by 2020, updates in the\nnear future extending support to ``Python<=3.0`` seems unlikely.\n\nThe following libraries are required to run all the scripts and modules.\n- `numpy `__ -\n`argparse `__ -\n`sympy `__ -\n`ujson `__ -\n`jsonschema `__ -\n`tabulate `__\n\nFor a full list of requirements, read requirements.txt. If not already\npresent within the environment, they'll be installed as dependencies\nduring setup.\n\nInstallation\n------------\n\nThe installation process is quite simple, ensure you have a working\nversion of ``Python>=3.5`` installed and type the following into the\nconsole,\n\n::\n\n pip install vasp-tools\n\nAny required libraries that aren't installed in the current environment\nwill be automatically installed. This will also automatically install\nthe scripts and add them to $PATH for easy access.\n\nCompatibility\n-------------\n\nThe package, so far, was only tested within a Linux environment and\nisn't officially compatible with Windows yet. The scripts can be\ncompiled into executables using\n`PyInstaller `__ to work\nindependently of python on any system, though it should be run in an\nenvironment with an identical OS. Use of VMs/Containers is suggested,\nthough not tested as of yet.\n\nUsage\n-----\n\nThe code present in ``/vasp`` can be imported in the form of standard\nmodules. However, the primary purpose of this project was the creation\nof scripts (present in ``/scripts``) to automate daily tasks faced by\nthe Computational Chemist/Material Scientist. With this in mind, the\nscripts were designed to be extremely modular and user-friendly by\nimplementing a\n```dplyr`` `__-esque piping\nparadigm. For example, the process of:\n\n1. Importing a molecule from a ``POSCAR`` file.\n2. Rotating it into a certain configuration (90 degrees wrt the x-axis)\n3. Positioning it at a specified point above a crystal taken from\n another ``POSCAR`` file\n4. Fixing atomic positions within the crystal below a certain cutoff\n height\n5. Converting the coordinates to ``Direct`` from ``Cartesian`` or vice\n versa\n6. Save to a new ``POSCAR`` file.\n\ncan be implemented in a single line like so.\n\n::\n\n cat POSCAR1 | ./rotate.py -x 90 -y 10 | ./place-at.py \"POSCAR2\" 0.5 0.5 2.0 | ./fix-upto.py 10.0 | ./cart-direct > POSCARnew\n\nAlternatively, you can also call each script individually or pass\n\"POSCAR1\" as one of the positional arguments. For example,\n\n``./place-at.py \"POSCAR2\" \"POSCAR1\" 0.5 0.5 2.0``\n\nis perfectly equivalent to\n\n``cat POSCAR1 | ./place-at.py \"POSCAR2\" 0.5 0.5 2.0``\n\nDetailed instructions on how to use the scripts are available in\n`docs `__.\n\n--------------\n\n*Written with `StackEdit `__*\n\n.. |Build Status| image:: https://travis-ci.com/RexGalilae/vasp-tools.svg?branch=master\n :target: https://travis-ci.com/RexGalilae/vasp-tools\n.. |Documentation Status| image:: https://readthedocs.org/projects/vasp-tools/badge/?version=latest\n :target: https://vasp-tools.readthedocs.io/en/latest/?badge=latest\n\n\n=======\nHistory\n=======\n\n0.1.0 (2019-07-19)\n------------------\n\n* First release on PyPI.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/RexGalilae/vasp_tools", "keywords": "vasp python computation dft", "license": "MIT license", "maintainer": "", "maintainer_email": "", "name": "vasp-tools", "package_url": "https://pypi.org/project/vasp-tools/", "platform": "", "project_url": "https://pypi.org/project/vasp-tools/", "project_urls": { "Homepage": "https://github.com/RexGalilae/vasp_tools" }, "release_url": "https://pypi.org/project/vasp-tools/0.1.0/", "requires_dist": [ "Cython (==0.29.2)", "tabulate (==0.8.3)", "lxml (==4.2.5)", "mpmath (==1.1.0)", "numpy (==1.16.4)", "matplotlib (==3.0.2)", "sympy (==1.4)", "cryptography (==2.7)", "seaborn (==0.9.0)", "pyOpenSSL (==19.0.0)", "brotli (==1.0.7)", "protobuf (==3.9.0)", "ipaddr (==2.2.0)", "mock (==3.0.5)", "ordereddict (==1.1)", "simplejson (==3.16.0)", "usercustomize (==1.0.0)", "wincertstore (==0.2)", "PyYAML (==5.1.1)" ], "requires_python": "", "summary": "A suite of scripts that perform menial, tedious and repetitive tasks and operations on VASP files that were hurriedly and haphazardly put together by some intern.", "version": "0.1.0" }, "last_serial": 5570559, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "89f3d8908201b73bf71030b10b2ed32d", "sha256": "5a77b85e57e2d987d4e56abc92af4289a2f6f518216b45ab34234083c53f7581" }, "downloads": -1, "filename": "vasp_tools-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "89f3d8908201b73bf71030b10b2ed32d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 18588, "upload_time": "2019-07-23T05:16:13", "url": "https://files.pythonhosted.org/packages/41/3c/f6eb794baae7ccf1b12a21309597cb652117485c60e529ca49f0e514b67a/vasp_tools-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "08f0fc700de59d8a99ce65c78bf43d48", "sha256": "b936a7d0962d70b386bd8828ed16f074e260d67ffa8748d462218820fd9a34d8" }, "downloads": -1, "filename": "vasp_tools-0.1.0.tar.gz", "has_sig": false, "md5_digest": "08f0fc700de59d8a99ce65c78bf43d48", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 24266, "upload_time": "2019-07-23T05:16:16", "url": "https://files.pythonhosted.org/packages/20/10/5aca5c5ca4890005d4a9d18ad71820945e966fa1c62b4a3110922d6e1f19/vasp_tools-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "89f3d8908201b73bf71030b10b2ed32d", "sha256": "5a77b85e57e2d987d4e56abc92af4289a2f6f518216b45ab34234083c53f7581" }, "downloads": -1, "filename": "vasp_tools-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "89f3d8908201b73bf71030b10b2ed32d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 18588, "upload_time": "2019-07-23T05:16:13", "url": "https://files.pythonhosted.org/packages/41/3c/f6eb794baae7ccf1b12a21309597cb652117485c60e529ca49f0e514b67a/vasp_tools-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "08f0fc700de59d8a99ce65c78bf43d48", "sha256": "b936a7d0962d70b386bd8828ed16f074e260d67ffa8748d462218820fd9a34d8" }, "downloads": -1, "filename": "vasp_tools-0.1.0.tar.gz", "has_sig": false, "md5_digest": "08f0fc700de59d8a99ce65c78bf43d48", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 24266, "upload_time": "2019-07-23T05:16:16", "url": "https://files.pythonhosted.org/packages/20/10/5aca5c5ca4890005d4a9d18ad71820945e966fa1c62b4a3110922d6e1f19/vasp_tools-0.1.0.tar.gz" } ] }