| Name | pyaims JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | None |
| Summary | An FHI-aims official Python package |
| upload_time | 2024-11-18 16:59:31 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
electronic structure
fhi-aims
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pyaims – an FHI-aims Python suite
## Installation
You can install `pyaims` from PyPI via `pip`:
```bash
pip install pyaims
```
Or, alternatively, you can install it from the main branch of this Git repository:
```bash
git clone https://gitlab.com/FHI-aims-club/pyaims.git
cd pyaims
pip install .
```
## Usage
The FHI-aims output file can be parsed in the following way:
```python
from pyaims import AimsStdout
stdout = AimsStdout("aims.out")
```
Then you can access all the parsed results (`stdout.results`),
run metadata (runtime choices and some geometry statistics —
`stdout.metadata`), warnings (`stdout.warnings`), and errors.
Also, `stdout.is_finished_ok` tells if FHI-aims run has been finished
without any errors.
There are several properties defined that make access to different
widely used values easier, like `energy` and `forces`.
Also, the top level keys of `stdout.results` dictionary can be accessed
using dot notation (so run times can be accessed with
`stdout.final["time"]`).
There are many values that are parsed from the `aims.out` file; you are
welcome to explore `stdout.results` dictionary.
## Support
Just write us an issue in the issue tracker!
## Roadmap
To be written...
## Contributing
Contributions are extremely welcome!
## Authors and acknowledgment
The package was written by:
* Tom Purcell
* Andrei Sobolev
## License
The project is licensed under MIT license.
Raw data
{
"_id": null,
"home_page": null,
"name": "pyaims",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Thomas Purcell <purcell@fhi-berlin.mpg.de>, Andrei Sobolev <sobolev@ms1p.org>",
"keywords": "electronic structure, FHI-aims",
"author": null,
"author_email": "Thomas Purcell <purcell@fhi-berlin.mpg.de>, Andrei Sobolev <sobolev@ms1p.org>",
"download_url": "https://files.pythonhosted.org/packages/11/9f/91cc79584115dba04f8a26649519a930956b952cd6433553bedc75cddca4/pyaims-0.0.2.tar.gz",
"platform": null,
"description": "# pyaims \u2013 an FHI-aims Python suite \n\n## Installation\n\nYou can install `pyaims` from PyPI via `pip`:\n```bash\npip install pyaims\n```\n\nOr, alternatively, you can install it from the main branch of this Git repository:\n```bash\ngit clone https://gitlab.com/FHI-aims-club/pyaims.git\ncd pyaims\npip install .\n```\n\n## Usage\nThe FHI-aims output file can be parsed in the following way:\n```python\nfrom pyaims import AimsStdout\n\nstdout = AimsStdout(\"aims.out\")\n```\n\nThen you can access all the parsed results (`stdout.results`),\nrun metadata (runtime choices and some geometry statistics \u2014 \n`stdout.metadata`), warnings (`stdout.warnings`), and errors.\nAlso, `stdout.is_finished_ok` tells if FHI-aims run has been finished \nwithout any errors.\n\nThere are several properties defined that make access to different \nwidely used values easier, like `energy` and `forces`. \nAlso, the top level keys of `stdout.results` dictionary can be accessed \nusing dot notation (so run times can be accessed with \n`stdout.final[\"time\"]`). \n\nThere are many values that are parsed from the `aims.out` file; you are \nwelcome to explore `stdout.results` dictionary. \n\n## Support\nJust write us an issue in the issue tracker!\n\n## Roadmap\nTo be written...\n\n## Contributing\nContributions are extremely welcome!\n\n## Authors and acknowledgment\nThe package was written by:\n * Tom Purcell\n * Andrei Sobolev\n\n## License\nThe project is licensed under MIT license.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An FHI-aims official Python package",
"version": "0.0.2",
"project_urls": {
"repository": "https://gitlab.com/FHI-aims-club/pyaims/"
},
"split_keywords": [
"electronic structure",
" fhi-aims"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "15609a4c60647942777c3b11b6e649faab1db59c5a66a25cf74620db8090d9f9",
"md5": "bdf63a0cffc8a8574d95bb1cccd75bd6",
"sha256": "07ddfb49c59f47a249de548d4e2e59bd459c45a9ad0d0d687fe741e6dfc57a0f"
},
"downloads": -1,
"filename": "pyaims-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bdf63a0cffc8a8574d95bb1cccd75bd6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 66663,
"upload_time": "2024-11-18T16:59:29",
"upload_time_iso_8601": "2024-11-18T16:59:29.617291Z",
"url": "https://files.pythonhosted.org/packages/15/60/9a4c60647942777c3b11b6e649faab1db59c5a66a25cf74620db8090d9f9/pyaims-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "119f91cc79584115dba04f8a26649519a930956b952cd6433553bedc75cddca4",
"md5": "544f833ed0b5de285b3828b5ca4c9cc4",
"sha256": "9ea98fdb8efb3bfc32f0226160b14f7b699a693c81c60a3402179e91bf54e9a7"
},
"downloads": -1,
"filename": "pyaims-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "544f833ed0b5de285b3828b5ca4c9cc4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 55136,
"upload_time": "2024-11-18T16:59:31",
"upload_time_iso_8601": "2024-11-18T16:59:31.185376Z",
"url": "https://files.pythonhosted.org/packages/11/9f/91cc79584115dba04f8a26649519a930956b952cd6433553bedc75cddca4/pyaims-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-18 16:59:31",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "FHI-aims-club",
"gitlab_project": "pyaims",
"lcname": "pyaims"
}
