| Name | pyfhiaims JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | None |
| Summary | An FHI-aims official Python package |
| upload_time | 2024-11-20 09:58:41 |
| 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.
|
# pyfhiaims – an FHI-aims Python suite
## Installation
You can install `pyfhiaims` from PyPI via `pip`:
```bash
pip install pyfhiaims
```
Or, alternatively, you can install it from the main branch of this Git repository:
```bash
git clone https://gitlab.com/FHI-aims-club/pyfhiaims.git
cd pyfhiaims
pip install .
```
## Usage
The FHI-aims output file can be parsed in the following way:
```python
from pyfhiaims 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": "pyfhiaims",
"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/f1/e5/f858dfe03bcb6818e12b2fbe6391fffaf91762de734eb1d2f554787d493f/pyfhiaims-0.0.4.tar.gz",
"platform": null,
"description": "# pyfhiaims \u2013 an FHI-aims Python suite \n\n## Installation\n\nYou can install `pyfhiaims` from PyPI via `pip`:\n```bash\npip install pyfhiaims\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/pyfhiaims.git\ncd pyfhiaims\npip install .\n```\n\n## Usage\nThe FHI-aims output file can be parsed in the following way:\n\n```python\nfrom pyfhiaims 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.4",
"project_urls": {
"repository": "https://gitlab.com/FHI-aims-club/pyfhiaims/"
},
"split_keywords": [
"electronic structure",
" fhi-aims"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c039f03c97f0f92d23d1e733b24890f67773befbe53f84323e402d27cf953ae0",
"md5": "af00fc18f8bff9d86bdaecf76592050a",
"sha256": "2daee9912bd9779b9410ef85ee54fad263971e253df8554ff9f99e49936ef9d5"
},
"downloads": -1,
"filename": "pyfhiaims-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "af00fc18f8bff9d86bdaecf76592050a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 67443,
"upload_time": "2024-11-20T09:58:39",
"upload_time_iso_8601": "2024-11-20T09:58:39.670648Z",
"url": "https://files.pythonhosted.org/packages/c0/39/f03c97f0f92d23d1e733b24890f67773befbe53f84323e402d27cf953ae0/pyfhiaims-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f1e5f858dfe03bcb6818e12b2fbe6391fffaf91762de734eb1d2f554787d493f",
"md5": "03218b2304ce29c3ec76c029fded00da",
"sha256": "88c3d7d514568320a05ffb9f29c298098909688928840ca6404514502db69eff"
},
"downloads": -1,
"filename": "pyfhiaims-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "03218b2304ce29c3ec76c029fded00da",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 55480,
"upload_time": "2024-11-20T09:58:41",
"upload_time_iso_8601": "2024-11-20T09:58:41.205862Z",
"url": "https://files.pythonhosted.org/packages/f1/e5/f858dfe03bcb6818e12b2fbe6391fffaf91762de734eb1d2f554787d493f/pyfhiaims-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 09:58:41",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "FHI-aims-club",
"gitlab_project": "pyfhiaims",
"lcname": "pyfhiaims"
}
