Name | aiida-bader JSON |
Version |
0.0.11
JSON |
| download |
home_page | None |
Summary | Collections of node-based workflow created using aiida-workgraph. |
upload_time | 2024-10-10 09:01:58 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.9 |
license | None |
keywords |
aiida
bader
quantum-espresso
cp2k
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# AiiDA-Bader
[![PyPI version](https://badge.fury.io/py/aiida-bader.svg)](https://badge.fury.io/py/aiida-bader)
[![Unit test](https://github.com/superstar54/aiida-bader/actions/workflows/ci.yaml/badge.svg)](https://github.com/superstar54/aiida-bader/actions/workflows/ci.yaml)
[![Docs status](https://readthedocs.org/projects/aiida-bader/badge)](http://aiida-bader.readthedocs.io/)
AiiDA plugin for [Bader](https://theory.cm.utexas.edu/henkelman/code/bader/) charge analysis.
## Installation
To install from PyPI, simply execute:
pip install aiida-bader
or when installing from source:
git clone https://github.com/superstar54/aiida-bader
pip install aiida-bader
## Development
### Running tests
To run the tests, simply clone and install the package locally with the [tests] optional dependencies:
```shell
git clone https://github.com/superstar54/aiida-bader .
cd aiida-bader
pip install -e .[tests] # install extra dependencies for test
pytest # run tests
```
### Pre-commit
To contribute to this repository, please enable pre-commit so the code in commits are conform to the standards.
Simply install the repository with the `pre-commit` extra dependencies:
```shell
cd aiida-bader
pip install -e .[pre-commit]
pre-commit install
```
## License
The `aiida-bader` plugin package is released under the MIT license.
See the `LICENSE` file for more details.
## Acknowledgements
We acknowledge support from:
* the [NCCR MARVEL](http://nccr-marvel.ch/) funded by the Swiss National Science Foundation;
<img src="docs/source/_static/images/MARVEL.png" width="250px" height="131px"/>
Raw data
{
"_id": null,
"home_page": null,
"name": "aiida-bader",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "aiida, bader, quantum-espresso, cp2k",
"author": null,
"author_email": "Xing Wang <xingwang1991@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/cd/e2/be228b4d0973d8c1b16745e93c1c8be43c4570fd0616671d28e3c61bea38/aiida_bader-0.0.11.tar.gz",
"platform": null,
"description": "# AiiDA-Bader\n\n[![PyPI version](https://badge.fury.io/py/aiida-bader.svg)](https://badge.fury.io/py/aiida-bader)\n[![Unit test](https://github.com/superstar54/aiida-bader/actions/workflows/ci.yaml/badge.svg)](https://github.com/superstar54/aiida-bader/actions/workflows/ci.yaml)\n[![Docs status](https://readthedocs.org/projects/aiida-bader/badge)](http://aiida-bader.readthedocs.io/)\n\nAiiDA plugin for [Bader](https://theory.cm.utexas.edu/henkelman/code/bader/) charge analysis.\n\n## Installation\nTo install from PyPI, simply execute:\n\n pip install aiida-bader\n\nor when installing from source:\n\n git clone https://github.com/superstar54/aiida-bader\n pip install aiida-bader\n\n## Development\n\n### Running tests\nTo run the tests, simply clone and install the package locally with the [tests] optional dependencies:\n\n```shell\ngit clone https://github.com/superstar54/aiida-bader .\ncd aiida-bader\npip install -e .[tests] # install extra dependencies for test\npytest # run tests\n```\n\n### Pre-commit\nTo contribute to this repository, please enable pre-commit so the code in commits are conform to the standards.\nSimply install the repository with the `pre-commit` extra dependencies:\n```shell\ncd aiida-bader\npip install -e .[pre-commit]\npre-commit install\n```\n\n## License\nThe `aiida-bader` plugin package is released under the MIT license.\nSee the `LICENSE` file for more details.\n\n## Acknowledgements\nWe acknowledge support from:\n* the [NCCR MARVEL](http://nccr-marvel.ch/) funded by the Swiss National Science Foundation;\n\n<img src=\"docs/source/_static/images/MARVEL.png\" width=\"250px\" height=\"131px\"/>\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Collections of node-based workflow created using aiida-workgraph.",
"version": "0.0.11",
"project_urls": {
"Documentation": "https://aiida-bader.readthedocs.io",
"Source": "https://github.com/superstar54/aiida-bader"
},
"split_keywords": [
"aiida",
" bader",
" quantum-espresso",
" cp2k"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "47a5944f7b4d1249a8965d45bacbc788b80a0c108ebbbd0d40d2099b9d635f46",
"md5": "d6df5b430389a4800a53a020b4518388",
"sha256": "5f99e9e32c450f48960590fdf0c6a0f89fc6a4e14e5e7d1ef606ca60a7a7cfbe"
},
"downloads": -1,
"filename": "aiida_bader-0.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d6df5b430389a4800a53a020b4518388",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 15441,
"upload_time": "2024-10-10T09:01:57",
"upload_time_iso_8601": "2024-10-10T09:01:57.888835Z",
"url": "https://files.pythonhosted.org/packages/47/a5/944f7b4d1249a8965d45bacbc788b80a0c108ebbbd0d40d2099b9d635f46/aiida_bader-0.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cde2be228b4d0973d8c1b16745e93c1c8be43c4570fd0616671d28e3c61bea38",
"md5": "640ca49f1871820ded9c4aeff0dc3915",
"sha256": "5f1cec0bdf42abfe58c97bd1fc4ec0d9fffd594d87b1dc5ed5e5da74a37e0252"
},
"downloads": -1,
"filename": "aiida_bader-0.0.11.tar.gz",
"has_sig": false,
"md5_digest": "640ca49f1871820ded9c4aeff0dc3915",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 11954,
"upload_time": "2024-10-10T09:01:58",
"upload_time_iso_8601": "2024-10-10T09:01:58.872223Z",
"url": "https://files.pythonhosted.org/packages/cd/e2/be228b4d0973d8c1b16745e93c1c8be43c4570fd0616671d28e3c61bea38/aiida_bader-0.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-10 09:01:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "superstar54",
"github_project": "aiida-bader",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aiida-bader"
}