# runnerase
[![pipeline status](https://gitlab.com/runner-suite/runnerase/badges/main/pipeline.svg)](https://gitlab.com/runner-suite/runnerase/-/commits/main)
[![Documentation](https://img.shields.io/badge/Documentation-latest-blue.svg)](https://theochemgoettingen.gitlab.io/RuNNer)
> An Interface between the Runner Neural Network Energy Representation (RuNNer) and the Atomic Simulation Environment (ASE).
## Key Features
- **readers and writers** for all RuNNer file formats.
- `Runner`, an **ASE calculator** class for managing the RuNNer workflow.
- `SymmetryFunction`/`SymmetryFunctionSet`, classes for generating and manipulating **atom-centered symmetry functions**.
- A `plot`ting library for generating **nice figures** from RuNNer data.
- **storage classes** for atom-centered symmetry function values, weights and scaling data of the atomic neural networks, the split between training and testing set, and the results of a RuNNer fit.
- `RunnerSinglePointCalculator`, an extension of the ASE `SinglePointCalculator` for storing the total charge of a structure.
## Installation
The package can be easily installed via pip. If they are not available, `ASE`
and `numpy` will be automatically installed as dependencies.
```sh
$ pip install runnerase
```
## Credits
This software is an extension of the [Atomic Simulation Environment](ase).
The original code was written by Alexander Knoll - @aknoll - [alexknoll@mailbox.org](alexknoll@mailbox.org).
## License
This software is distributed under the GPL v3. For details, see [LICENSE](LICENSE).
Raw data
{
"_id": null,
"home_page": "",
"name": "runnerase",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "Alexander Knoll <alexknoll@mailbox.org>",
"keywords": "computational chemistry,machine learning,atomic simulation environment",
"author": "",
"author_email": "Alexander Knoll <alexknoll@mailbox.org>",
"download_url": "https://files.pythonhosted.org/packages/0b/ce/713b2f5783a356d213adb2051aa0f465f3b0c459d0c4a3d086a4a62d082f/runnerase-0.3.3.tar.gz",
"platform": null,
"description": "# runnerase\n\n[![pipeline status](https://gitlab.com/runner-suite/runnerase/badges/main/pipeline.svg)](https://gitlab.com/runner-suite/runnerase/-/commits/main)\n[![Documentation](https://img.shields.io/badge/Documentation-latest-blue.svg)](https://theochemgoettingen.gitlab.io/RuNNer)\n\n> An Interface between the Runner Neural Network Energy Representation (RuNNer) and the Atomic Simulation Environment (ASE).\n\n## Key Features\n\n- **readers and writers** for all RuNNer file formats.\n- `Runner`, an **ASE calculator** class for managing the RuNNer workflow.\n- `SymmetryFunction`/`SymmetryFunctionSet`, classes for generating and manipulating **atom-centered symmetry functions**.\n- A `plot`ting library for generating **nice figures** from RuNNer data.\n- **storage classes** for atom-centered symmetry function values, weights and scaling data of the atomic neural networks, the split between training and testing set, and the results of a RuNNer fit.\n- `RunnerSinglePointCalculator`, an extension of the ASE `SinglePointCalculator` for storing the total charge of a structure.\n\n## Installation\n\nThe package can be easily installed via pip. If they are not available, `ASE`\nand `numpy` will be automatically installed as dependencies.\n\n```sh\n$ pip install runnerase\n```\n\n## Credits\n\nThis software is an extension of the [Atomic Simulation Environment](ase).\n\nThe original code was written by Alexander Knoll - @aknoll - [alexknoll@mailbox.org](alexknoll@mailbox.org).\n\n## License\n\nThis software is distributed under the GPL v3. For details, see [LICENSE](LICENSE).\n\n",
"bugtrack_url": null,
"license": "GPLv3+",
"summary": "An Interface between the Runner Neural Network Energy Representation (RuNNer) and the Atomic Simulation Environment (ASE).",
"version": "0.3.3",
"split_keywords": [
"computational chemistry",
"machine learning",
"atomic simulation environment"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e2faae0eb3ab0f5c865d30cdfc475aef433301eda232c0b65b01832d2d482c89",
"md5": "b0a58ea0b13a6a7e1f7735faa6cb6a2c",
"sha256": "4783ae7954659e205f113c65409448f2a243fb0d2fcfa27721aad23a05484e0d"
},
"downloads": -1,
"filename": "runnerase-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b0a58ea0b13a6a7e1f7735faa6cb6a2c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 66869,
"upload_time": "2023-04-28T13:15:49",
"upload_time_iso_8601": "2023-04-28T13:15:49.335929Z",
"url": "https://files.pythonhosted.org/packages/e2/fa/ae0eb3ab0f5c865d30cdfc475aef433301eda232c0b65b01832d2d482c89/runnerase-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0bce713b2f5783a356d213adb2051aa0f465f3b0c459d0c4a3d086a4a62d082f",
"md5": "ebef599263297021f364097638e98357",
"sha256": "533a91bc25af203d01afbaae8d13db9e388b24572686422f02b3d7e2d82ff439"
},
"downloads": -1,
"filename": "runnerase-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "ebef599263297021f364097638e98357",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 57144,
"upload_time": "2023-04-28T13:15:52",
"upload_time_iso_8601": "2023-04-28T13:15:52.054133Z",
"url": "https://files.pythonhosted.org/packages/0b/ce/713b2f5783a356d213adb2051aa0f465f3b0c459d0c4a3d086a4a62d082f/runnerase-0.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-28 13:15:52",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "runnerase"
}