{ "info": { "author": "Chris Sewell", "author_email": "chrisj_sewell@hotmail.com", "bugtrack_url": null, "classifiers": [ "Framework :: AiiDA", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.6", "Topic :: Scientific/Engineering :: Chemistry", "Topic :: Scientific/Engineering :: Physics" ], "description": "[![Build Status](https://travis-ci.org/chrisjsewell/aiida-gulp.svg?branch=master)](https://travis-ci.org/chrisjsewell/aiida-gulp)\n[![Coverage Status](https://coveralls.io/repos/github/chrisjsewell/aiida-gulp/badge.svg?branch=master)](https://coveralls.io/github/chrisjsewell/aiida-gulp?branch=master)\n[![Docs status](https://readthedocs.org/projects/aiida-gulp/badge)](http://aiida-gulp.readthedocs.io/)\n[![PyPI](https://img.shields.io/pypi/v/aiida-gulp.svg)](https://pypi.python.org/pypi/aiida-gulp/)\n[![Anaconda](https://anaconda.org/conda-forge/aiida-gulp/badges/version.svg)](https://anaconda.org/conda-forge/aiida-gulp)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n\n# aiida-gulp\n\nAiiDA plugin for running the [GULP](http://gulp.curtin.edu.au) code.\n\n**Documentation**: https://readthedocs.org/projects/aiida-gulp\n\n## Installation\n\nTo install from Conda (recommended)::\n\n```shell\n>> conda install -c conda-forge aiida-gulp aiida-core.services\n```\n\nTo install from pypi::\n\n```shell\n>> pip install aiida-gulp\n```\n\nTo install the development version:\n\n```shell\n>> git clone https://github.com/chrisjsewell/aiida-gulp .\n>> cd aiida-gulp\n>> pip install -e . # also installs aiida, if missing (but not postgres)\n>> #pip install -e .[pre-commit,testing] # install extras for more features\n>> verdi quicksetup # set up a new profile\n>> verdi calculation plugins # should now show the calculation plugins (with prefix gulp.)\n```\n\n## Development\n\n### Testing against mock GULP executables\n\nBecause GULP is a licensed software, it is not possible to source a copy of the executable on Travis CI.\nTherefore, a mock executable (`gulp_mock`) has been created for testing purposes (which also speeds up test runs).\n\nThis executable computes the md5 hash of the supplied input file and tries to match it against a dictionary of\nprecomputed hashes. If found, the executable will write the matching output (from `test/output_files`) to stdout.\n\nThe following will discover and run all unit test:\n\n```shell\n>> pip install -e .[testing]\n>> reentry scan -r aiida\n>> pytest -v\n```\n\nTo omit tests which call external executables (like `gulp`):\n\n```shell\n>> pytest --gulp-skip-exec\n```\n\nTo call the actual executable (e.g. `gulp` instead of `gulp_mock`):\n\n```shell\n>> pytest --gulp-no-mock\n```\n\nTo output the results of calcjob executions to a specific directory:\n\n```shell\n>> pytest --gulp-workdir \"test_workdir\"\n```\n\n### Coding Style Requirements\n\nThe code style is tested using [flake8](http://flake8.pycqa.org),\nwith the configuration set in `.flake8`, and code should be formatted with [black](https://github.com/ambv/black).\n\nInstalling with `aiida-gulp[code_style]` makes the [pre-commit](https://pre-commit.com/)\npackage available, which will ensure these tests are passed by reformatting the code\nand testing for lint errors before submitting a commit.\nIt can be setup by:\n\n```shell\n>> cd aiida-gulp\n>> pre-commit install\n```\n\nOptionally you can run `black` and `flake8` separately:\n\n```shell\n>> black . # recursively find and format files in-place\n>> flake8\n```\n\nEditors like VS Code also have automatic code reformat utilities, which can adhere to this standard.\n\n## License\n\nSee ``LICENSE`` file\n\n## Contact\n\nchrisj_sewell@hotmail.com\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/chrisjsewell/aiida-gulp", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "aiida-gulp", "package_url": "https://pypi.org/project/aiida-gulp/", "platform": "", "project_url": "https://pypi.org/project/aiida-gulp/", "project_urls": { "Homepage": "https://github.com/chrisjsewell/aiida-gulp" }, "release_url": "https://pypi.org/project/aiida-gulp/0.10.0b5/", "requires_dist": [ "aiida-core (==1.0.0b5)", "six (>=1.12.0)", "ruamel.yaml", "jsonextended (>=0.7.10)", "jsonschema", "spglib (<2.0.0,>=1.10.0)", "importlib-resources", "ase (<3.18.0,>=3.12.0) ; python_version < \"3\"", "PyCifRW (==4.2.1) ; python_version < \"3\"", "pathlib2 ; python_version < \"3.4\"", "ase (<4.0.0,>=3.12.0) ; python_version >= \"3\"", "PyCifRW (==4.4) ; python_version >= \"3\"", "black (==19.3b0) ; extra == 'code_style'", "flake8 (<3.8.0,>=3.7.0) ; extra == 'code_style'", "pre-commit (==1.17.0) ; extra == 'code_style'", "doc8 (<0.9.0,>=0.8.0) ; extra == 'code_style'", "sphinx (>=1.6) ; extra == 'docs'", "ipypublish (>=0.10.7) ; extra == 'docs'", "mock (==2.0.0) ; extra == 'testing'", "pgtest (==1.2.0) ; extra == 'testing'", "sqlalchemy-diff (==0.1.3) ; extra == 'testing'", "pytest (==3.6.3) ; extra == 'testing'", "wheel (>=0.31) ; extra == 'testing'", "coverage ; extra == 'testing'", "pytest-cov ; extra == 'testing'", "pytest-timeout ; extra == 'testing'", "pytest-regressions ; extra == 'testing'", "pytest-notebook ; (python_version >= \"3.5\") and extra == 'testing'" ], "requires_python": "", "summary": "AiiDA plugin for running the GULP MD code", "version": "0.10.0b5", "yanked": false, "yanked_reason": null }, "last_serial": 6054104, "releases": { "0.10.0b5": [ { "comment_text": "", "digests": { "md5": "ded6964612cf8c9603f5ea2f89f3c37c", "sha256": "3ac6a69be2121bc1d1119f76e6994de13a8b9816c4a005c16e543631f75bc69f" }, "downloads": -1, "filename": "aiida_gulp-0.10.0b5-py3-none-any.whl", "has_sig": false, "md5_digest": "ded6964612cf8c9603f5ea2f89f3c37c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 287632, "upload_time": "2019-10-30T18:14:38", "upload_time_iso_8601": "2019-10-30T18:14:38.650277Z", "url": "https://files.pythonhosted.org/packages/86/d6/966adcf749fc6e72f645691edcb6be4a98c9a602a88efd39b028ae05f3ee/aiida_gulp-0.10.0b5-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "35f7964110ade051c67478a2779a9f0c", "sha256": "b650542e4765fe3a0ce38eb1d3f16046cc8dc7fb6e48b787bfa34e32c088abd6" }, "downloads": -1, "filename": "aiida-gulp-0.10.0b5.tar.gz", "has_sig": false, "md5_digest": "35f7964110ade051c67478a2779a9f0c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 217641, "upload_time": "2019-10-30T18:14:41", "upload_time_iso_8601": "2019-10-30T18:14:41.278372Z", "url": "https://files.pythonhosted.org/packages/b3/4d/de00db715d43ead7ebc6097b4d2a81bcc6e5b03d14ee90a51a75487480c1/aiida-gulp-0.10.0b5.tar.gz", "yanked": false, "yanked_reason": null } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ded6964612cf8c9603f5ea2f89f3c37c", "sha256": "3ac6a69be2121bc1d1119f76e6994de13a8b9816c4a005c16e543631f75bc69f" }, "downloads": -1, "filename": "aiida_gulp-0.10.0b5-py3-none-any.whl", "has_sig": false, "md5_digest": "ded6964612cf8c9603f5ea2f89f3c37c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 287632, "upload_time": "2019-10-30T18:14:38", "upload_time_iso_8601": "2019-10-30T18:14:38.650277Z", "url": "https://files.pythonhosted.org/packages/86/d6/966adcf749fc6e72f645691edcb6be4a98c9a602a88efd39b028ae05f3ee/aiida_gulp-0.10.0b5-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "35f7964110ade051c67478a2779a9f0c", "sha256": "b650542e4765fe3a0ce38eb1d3f16046cc8dc7fb6e48b787bfa34e32c088abd6" }, "downloads": -1, "filename": "aiida-gulp-0.10.0b5.tar.gz", "has_sig": false, "md5_digest": "35f7964110ade051c67478a2779a9f0c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 217641, "upload_time": "2019-10-30T18:14:41", "upload_time_iso_8601": "2019-10-30T18:14:41.278372Z", "url": "https://files.pythonhosted.org/packages/b3/4d/de00db715d43ead7ebc6097b4d2a81bcc6e5b03d14ee90a51a75487480c1/aiida-gulp-0.10.0b5.tar.gz", "yanked": false, "yanked_reason": null } ], "vulnerabilities": [] }