| Name | aiida-aurora JSON |
| Version |
0.5.0
JSON |
| download |
| home_page | None |
| Summary | AiiDA plugin for the Aurora platform. |
| upload_time | 2024-01-30 17:52:53 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
aiida
plugin
aurora
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
[](https://github.com/epfl-theos/aiida-aurora/actions)
[](https://coveralls.io/github/epfl-theos/aiida-aurora?branch=main)
[](http://aiida-aurora.readthedocs.io/)
[](https://badge.fury.io/py/aiida-aurora)
# aiida-aurora
AiiDA plugin for the Aurora project (autonomous robotic battery innovation platform).
A collaboration between EPFL & Empa, within the BIG-MAP Stakeholder Initiative Call 2021-2023.
## Repository contents
- [`.github/`](.github/): [Github Actions](https://github.com/features/actions) configuration
- [`ci.yml`](.github/workflows/ci.yml): runs tests, checks test coverage and builds documentation at every new commit
- [`publish-on-pypi.yml`](.github/workflows/publish-on-pypi.yml): automatically deploy git tags to PyPI - just generate a [PyPI API token](https://pypi.org/help/#apitoken) for your PyPI account and add it to the `pypi_token` secret of your github repository
- [`aiida_aurora/`](aiida_aurora/): The main source code of the plugin package
- [`data/`](aiida_aurora/data/): A new `DiffParameters` data class, used as input to the `DiffCalculation` `CalcJob` class
- [`calculations.py`](aiida_aurora/calculations.py): A new `DiffCalculation` `CalcJob` class
- [`cli.py`](aiida_aurora/cli.py): Extensions of the `verdi data` command line interface for the `DiffParameters` class
- [`helpers.py`](aiida_aurora/helpers.py): Helpers for setting up an AiiDA code for `diff` automatically
- [`parsers.py`](aiida_aurora/parsers.py): A new `Parser` for the `DiffCalculation`
- [`docs/`](docs/): A documentation template ready for publication on [Read the Docs](http://aiida-diff.readthedocs.io/en/latest/)
- [`examples/`](examples/): An example of how to submit a calculation using this plugin
- [`tests/`](tests/): Basic regression tests using the [pytest](https://docs.pytest.org/en/latest/) framework (submitting a calculation, ...). Install `pip install -e .[testing]` and run `pytest`.
- [`.coveragerc`](.coveragerc): Configuration of [coverage.py](https://coverage.readthedocs.io/en/latest) tool reporting which lines of your plugin are covered by tests
- [`.gitignore`](.gitignore): Telling git which files to ignore
- [`.pre-commit-config.yaml`](.pre-commit-config.yaml): Configuration of [pre-commit hooks](https://pre-commit.com/) that sanitize coding style and check for syntax errors. Enable via `pip install -e .[pre-commit] && pre-commit install`
- [`.readthedocs.yml`](.readthedocs.yml): Configuration of documentation build for [Read the Docs](https://readthedocs.org/)
- [`LICENSE`](LICENSE): License for your plugin
- [`MANIFEST.in`](MANIFEST.in): Configure non-Python files to be included for publication on [PyPI](https://pypi.org/)
- [`README.md`](README.md): This file
## Installation
```shell
pip install aiida-aurora
verdi quicksetup # better to set up a new profile
verdi plugin list aiida.calculations # should now show your calclulation plugins
```
## Usage
Here goes a complete example of how to submit a test calculation using this plugin.
A quick demo of how to submit a calculation:
```shell
verdi daemon start # make sure the daemon is running
cd examples
./example_01.py # run test calculation
verdi process list -a # check record of calculation
```
The plugin also includes verdi commands to inspect its data types:
```shell
verdi data aurora list
verdi data aurora export <PK>
```
## Development
```shell
git clone https://github.com/epfl-theos/aiida-aurora .
cd aiida-aurora
pip install -e .[pre-commit,testing] # install extra dependencies
pre-commit install # install pre-commit hooks
pytest -v # discover and run all tests
```
See the [developer guide](http://aiida-aurora.readthedocs.io/en/latest/developer_guide/index.html) for more information.
## License
MIT
## Acknowledgements
This project was supported by the Open Research Data Program of the ETH Board.
## Contact
- Edan Bainglass (edan.bainglass@psi.ch)
- Francisco F. Ramirez (ramirezfranciscof@gmail.com)
- Loris Ercole (loris.ercole@gmail.com)
- Giovanni Pizzi (giovanni.pizzi@psi.ch)
Raw data
{
"_id": null,
"home_page": null,
"name": "aiida-aurora",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "aiida,plugin,aurora",
"author": null,
"author_email": "Loris Ercole <loris.ercole@gmail.com>, \"Francisco F. Ramirez\" <ramirezfranciscof@gmail.com>, Edan Bainglass <edan.bainglass@psi.ch>, Giovanni Pizzi <giovanni.pizzi@psi.ch>",
"download_url": "https://files.pythonhosted.org/packages/93/98/bd4a28a005863719ac0a7a6a7b6ff986bf88f12b1ce50744d44494ee4580/aiida_aurora-0.5.0.tar.gz",
"platform": null,
"description": "[](https://github.com/epfl-theos/aiida-aurora/actions)\n[](https://coveralls.io/github/epfl-theos/aiida-aurora?branch=main)\n[](http://aiida-aurora.readthedocs.io/)\n[](https://badge.fury.io/py/aiida-aurora)\n\n# aiida-aurora\n\nAiiDA plugin for the Aurora project (autonomous robotic battery innovation platform).\nA collaboration between EPFL & Empa, within the BIG-MAP Stakeholder Initiative Call 2021-2023.\n\n## Repository contents\n\n- [`.github/`](.github/): [Github Actions](https://github.com/features/actions) configuration\n - [`ci.yml`](.github/workflows/ci.yml): runs tests, checks test coverage and builds documentation at every new commit\n - [`publish-on-pypi.yml`](.github/workflows/publish-on-pypi.yml): automatically deploy git tags to PyPI - just generate a [PyPI API token](https://pypi.org/help/#apitoken) for your PyPI account and add it to the `pypi_token` secret of your github repository\n- [`aiida_aurora/`](aiida_aurora/): The main source code of the plugin package\n - [`data/`](aiida_aurora/data/): A new `DiffParameters` data class, used as input to the `DiffCalculation` `CalcJob` class\n - [`calculations.py`](aiida_aurora/calculations.py): A new `DiffCalculation` `CalcJob` class\n - [`cli.py`](aiida_aurora/cli.py): Extensions of the `verdi data` command line interface for the `DiffParameters` class\n - [`helpers.py`](aiida_aurora/helpers.py): Helpers for setting up an AiiDA code for `diff` automatically\n - [`parsers.py`](aiida_aurora/parsers.py): A new `Parser` for the `DiffCalculation`\n- [`docs/`](docs/): A documentation template ready for publication on [Read the Docs](http://aiida-diff.readthedocs.io/en/latest/)\n- [`examples/`](examples/): An example of how to submit a calculation using this plugin\n- [`tests/`](tests/): Basic regression tests using the [pytest](https://docs.pytest.org/en/latest/) framework (submitting a calculation, ...). Install `pip install -e .[testing]` and run `pytest`.\n- [`.coveragerc`](.coveragerc): Configuration of [coverage.py](https://coverage.readthedocs.io/en/latest) tool reporting which lines of your plugin are covered by tests\n- [`.gitignore`](.gitignore): Telling git which files to ignore\n- [`.pre-commit-config.yaml`](.pre-commit-config.yaml): Configuration of [pre-commit hooks](https://pre-commit.com/) that sanitize coding style and check for syntax errors. Enable via `pip install -e .[pre-commit] && pre-commit install`\n- [`.readthedocs.yml`](.readthedocs.yml): Configuration of documentation build for [Read the Docs](https://readthedocs.org/)\n- [`LICENSE`](LICENSE): License for your plugin\n- [`MANIFEST.in`](MANIFEST.in): Configure non-Python files to be included for publication on [PyPI](https://pypi.org/)\n- [`README.md`](README.md): This file\n\n## Installation\n\n```shell\npip install aiida-aurora\nverdi quicksetup # better to set up a new profile\nverdi plugin list aiida.calculations # should now show your calclulation plugins\n```\n\n## Usage\n\nHere goes a complete example of how to submit a test calculation using this plugin.\n\nA quick demo of how to submit a calculation:\n\n```shell\nverdi daemon start # make sure the daemon is running\ncd examples\n./example_01.py # run test calculation\nverdi process list -a # check record of calculation\n```\n\nThe plugin also includes verdi commands to inspect its data types:\n\n```shell\nverdi data aurora list\nverdi data aurora export <PK>\n```\n\n## Development\n\n```shell\ngit clone https://github.com/epfl-theos/aiida-aurora .\ncd aiida-aurora\npip install -e .[pre-commit,testing] # install extra dependencies\npre-commit install # install pre-commit hooks\npytest -v # discover and run all tests\n```\n\nSee the [developer guide](http://aiida-aurora.readthedocs.io/en/latest/developer_guide/index.html) for more information.\n\n## License\n\nMIT\n\n## Acknowledgements\n\nThis project was supported by the Open Research Data Program of the ETH Board.\n\n## Contact\n\n- Edan Bainglass (edan.bainglass@psi.ch)\n- Francisco F. Ramirez (ramirezfranciscof@gmail.com)\n- Loris Ercole (loris.ercole@gmail.com)\n- Giovanni Pizzi (giovanni.pizzi@psi.ch)\n",
"bugtrack_url": null,
"license": null,
"summary": "AiiDA plugin for the Aurora platform.",
"version": "0.5.0",
"project_urls": {
"Source": "https://github.com/epfl-theos/aiida-aurora"
},
"split_keywords": [
"aiida",
"plugin",
"aurora"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "59e02843c98b57ac1a619865d06884d24ca4ec4c43dc2f181b9df13a118ea2e1",
"md5": "22ecf32e4f329b584d69833b664f64c5",
"sha256": "487faed30fc17d6b27cdace84568655570f296d8649561d96e5b0cd392528a6c"
},
"downloads": -1,
"filename": "aiida_aurora-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "22ecf32e4f329b584d69833b664f64c5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 40303,
"upload_time": "2024-01-30T17:52:51",
"upload_time_iso_8601": "2024-01-30T17:52:51.694062Z",
"url": "https://files.pythonhosted.org/packages/59/e0/2843c98b57ac1a619865d06884d24ca4ec4c43dc2f181b9df13a118ea2e1/aiida_aurora-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9398bd4a28a005863719ac0a7a6a7b6ff986bf88f12b1ce50744d44494ee4580",
"md5": "ac3d22e178cefd5d2de925eace17e567",
"sha256": "678bf644bd4af1243925194545e7a1252d5973c3a3032b8a1d70a48ca12d4f44"
},
"downloads": -1,
"filename": "aiida_aurora-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "ac3d22e178cefd5d2de925eace17e567",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 122671,
"upload_time": "2024-01-30T17:52:53",
"upload_time_iso_8601": "2024-01-30T17:52:53.699524Z",
"url": "https://files.pythonhosted.org/packages/93/98/bd4a28a005863719ac0a7a6a7b6ff986bf88f12b1ce50744d44494ee4580/aiida_aurora-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-30 17:52:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "epfl-theos",
"github_project": "aiida-aurora",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "aiida-aurora"
}
