[](https://github.com/nanotech-empa/aiida-gaussian/actions)
[](https://coveralls.io/github/nanotech-empa/aiida-gaussian?branch=master)
[](https://badge.fury.io/py/aiida-gaussian)
[](https://zenodo.org/badge/latestdoi/241384761)
# aiida-gaussian
AiiDA plugin for the Gaussian quantum chemistry software
## Features
Gaussian input can be provided as a python dictionary following the convention defined by [pymatgen](https://pymatgen.org/)
```python
parameters = {
'functional':'PBE1PBE',
'basis_set':'6-31g',
'charge': 0,
'multiplicity': 1,
'link0_parameters': {
'%chk':'aiida.chk',
'%mem':"1024MB",
'%nprocshared': 4,
},
'route_parameters': {
'scf': {
'maxcycle': 128,
'cdiis': None,
},
'nosymm': None,
'output':'wfx',
'opt': 'tight',
},
'input_parameters': { # appended at the end of the input
'output.wfx':None
},
}
```
In `route_parameters`, specifying `key: None` adds only `key` without the equals sign to the input script.
Parsing of the results is performed with the [cclib](https://github.com/cclib/cclib) library and by default all of its output is stored in the `output_parameters` node.
Additionally, simple plugins to submit the Gaussian utilities `formchk` and `cubegen` are provided.
## Installation
```shell
pip install aiida-gaussian
```
This installs the plugins to the AiiDA instance (to double-check, one can list all installed plugins by `verdi plugin list aiida.calculations`). After this, the Gaussian codes should be set up using the plugins (https://aiida.readthedocs.io/projects/aiida-core/en/latest/).
## Usage
A quick demo of how to submit a calculation:
```shell
verdi daemon start # make sure the daemon is running
cd examples
# Submit test calculation (argument is the label of gaussian code)
verdi run example_01_opt.py gaussian09
```
## For maintainers
To create a new release, clone the repository, install development dependencies with `pip install '.[dev]'`, and then execute `bumpver update --major/--minor/--patch`.
This will:
1. Create a tagged release with bumped version and push it to the repository.
2. Trigger a GitHub actions workflow that creates a GitHub release.
Additional notes:
- Use the `--dry` option to preview the release change.
- The release tag (e.g. a/b/rc) is determined from the last release.
Use the `--tag` option to switch the release tag.
Raw data
{
"_id": null,
"home_page": "",
"name": "aiida-gaussian",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Kristjan Eimre, Pezhman Zarabadi-Poor, Aliaksandr Yakutovich",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/da/f6/75664ec99ea6689cf82cf9361cca10aa0358223eb5db0e526c4ce8c8dde3/aiida-gaussian-2.1.0.tar.gz",
"platform": null,
"description": "[](https://github.com/nanotech-empa/aiida-gaussian/actions)\n[](https://coveralls.io/github/nanotech-empa/aiida-gaussian?branch=master)\n[](https://badge.fury.io/py/aiida-gaussian)\n[](https://zenodo.org/badge/latestdoi/241384761)\n\n# aiida-gaussian\n\nAiiDA plugin for the Gaussian quantum chemistry software\n\n## Features\n\nGaussian input can be provided as a python dictionary following the convention defined by [pymatgen](https://pymatgen.org/)\n```python\nparameters = {\n 'functional':'PBE1PBE',\n 'basis_set':'6-31g',\n 'charge': 0,\n 'multiplicity': 1,\n 'link0_parameters': {\n '%chk':'aiida.chk',\n '%mem':\"1024MB\",\n '%nprocshared': 4,\n },\n 'route_parameters': {\n 'scf': {\n 'maxcycle': 128,\n 'cdiis': None,\n },\n 'nosymm': None,\n 'output':'wfx',\n 'opt': 'tight',\n },\n 'input_parameters': { # appended at the end of the input\n 'output.wfx':None\n },\n}\n```\nIn `route_parameters`, specifying `key: None` adds only `key` without the equals sign to the input script.\n\nParsing of the results is performed with the [cclib](https://github.com/cclib/cclib) library and by default all of its output is stored in the `output_parameters` node.\n\nAdditionally, simple plugins to submit the Gaussian utilities `formchk` and `cubegen` are provided.\n\n## Installation\n\n```shell\npip install aiida-gaussian\n```\n\nThis installs the plugins to the AiiDA instance (to double-check, one can list all installed plugins by `verdi plugin list aiida.calculations`). After this, the Gaussian codes should be set up using the plugins (https://aiida.readthedocs.io/projects/aiida-core/en/latest/).\n\n## Usage\n\nA quick demo of how to submit a calculation:\n```shell\nverdi daemon start # make sure the daemon is running\ncd examples\n# Submit test calculation (argument is the label of gaussian code)\nverdi run example_01_opt.py gaussian09\n```\n\n## For maintainers\n\nTo create a new release, clone the repository, install development dependencies with `pip install '.[dev]'`, and then execute `bumpver update --major/--minor/--patch`.\nThis will:\n\n 1. Create a tagged release with bumped version and push it to the repository.\n 2. Trigger a GitHub actions workflow that creates a GitHub release.\n\nAdditional notes:\n\n - Use the `--dry` option to preview the release change.\n - The release tag (e.g. a/b/rc) is determined from the last release.\n Use the `--tag` option to switch the release tag.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "AiiDA plugin for the Gaussian quantum chemistry software.",
"version": "2.1.0",
"project_urls": {
"Homepage": "https://github.com/nanotech-empa/aiida-gaussian"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "368520b628a5c25d50a529cd8e93de4d5d2770d836cfae568e3ac4f27423a103",
"md5": "aa9e70ed453c1b490fe74bdc3e73edbd",
"sha256": "1003189e12cdc693d09268aad38e521563fa05d6d2053fb96b66d10568db57dc"
},
"downloads": -1,
"filename": "aiida_gaussian-2.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aa9e70ed453c1b490fe74bdc3e73edbd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 23700,
"upload_time": "2023-08-31T11:15:38",
"upload_time_iso_8601": "2023-08-31T11:15:38.870249Z",
"url": "https://files.pythonhosted.org/packages/36/85/20b628a5c25d50a529cd8e93de4d5d2770d836cfae568e3ac4f27423a103/aiida_gaussian-2.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "daf675664ec99ea6689cf82cf9361cca10aa0358223eb5db0e526c4ce8c8dde3",
"md5": "c333f83d7582429e1cad5ccd80f392b6",
"sha256": "c2487e76b16100ab269d33c5e3934ccf4b6430aab6435efd9e06b27be0ed7d60"
},
"downloads": -1,
"filename": "aiida-gaussian-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "c333f83d7582429e1cad5ccd80f392b6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 20002,
"upload_time": "2023-08-31T11:15:40",
"upload_time_iso_8601": "2023-08-31T11:15:40.421979Z",
"url": "https://files.pythonhosted.org/packages/da/f6/75664ec99ea6689cf82cf9361cca10aa0358223eb5db0e526c4ce8c8dde3/aiida-gaussian-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-31 11:15:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nanotech-empa",
"github_project": "aiida-gaussian",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aiida-gaussian"
}
JSON
