[![Build Status][ci-badge]][ci-link]
[![Coverage Status][cov-badge]][cov-link]
[![Docs status][docs-badge]][docs-link]
[![PyPI version][pypi-badge]][pypi-link]
# aiida-quantum-transport
A plugin for quantum transport calculations based on NEGF methods.
This plugin is the default output of the
[AiiDA plugin cutter](https://github.com/aiidateam/aiida-plugin-cutter),
intended to help developers get started with their AiiDA plugins.
## 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
- [`src/aiida_quantum_transport/`](src/aiida_quantum_transport/): The main source code of the plugin package
- [`data/`](src/aiida_quantum_transport/data/): Custom data classes
- [`calculations.py`](src/aiida_quantum_transport/calculations.py): Quantum Transport AiiDA calculation classes
- [`cli.py`](src/aiida_quantum_transport/cli.py): Custom `verdi` CLI commands
- [`helpers.py`](src/aiida_quantum_transport/helpers.py): Helpers for setting up an AiiDA code
- [`parsers.py`](src/aiida_quantum_transport/parsers.py): Custom parser classes
- [`docs/`](docs/): The documentation of the 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`.
- [`conftest.py`](tests/conftest.py): Configuration of fixtures for [pytest](https://docs.pytest.org/en/latest/)
- [`.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
- [`README.md`](README.md): This file
- [`pyproject.toml`](setup.json): Python package metadata for registration on [PyPI](https://pypi.org/) and the [AiiDA plugin registry](https://aiidateam.github.io/aiida-registry/) (including entry points)
## Features
Under development
## Installation
```shell
pip install aiida-quantum-transport
verdi quicksetup
verdi plugin list aiida.calculations
```
## 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
```
## Development
```shell
git clone https://github.com/edan-bainglass/aiida-quantum-transport .
cd aiida-quantum-transport
pip install --upgrade pip
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-quantum-transport.readthedocs.io/en/latest/developer_guide/index.html) for more information.
## License
MIT
## Contact
edan.bainglass@gmail.com
[ci-badge]: https://github.com/edan-bainglass/aiida-quantum-transport/workflows/ci/badge.svg?branch=master
[ci-link]: https://github.com/edan-bainglass/aiida-quantum-transport/actions
[cov-badge]: https://coveralls.io/repos/github/edan-bainglass/aiida-quantum-transport/badge.svg?branch=master
[cov-link]: https://coveralls.io/github/edan-bainglass/aiida-quantum-transport?branch=master
[docs-badge]: https://readthedocs.org/projects/aiida-quantum-transport/badge
[docs-link]: http://aiida-quantum-transport.readthedocs.io/
[pypi-badge]: https://badge.fury.io/py/aiida-quantum-transport.svg
[pypi-link]: https://badge.fury.io/py/aiida-quantum-transport
Raw data
{
"_id": null,
"home_page": null,
"name": "aiida-quantum-transport",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "quantum, transport, NEGF, DMFT, aiida, plugin",
"author": null,
"author_email": "Edan Bainglass <edan.bainglass@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/29/7d/979924345eccf92543389e0c17903da0a39c0bcc8613731beb0485fe115d/aiida_quantum_transport-0.1.0.tar.gz",
"platform": null,
"description": "[![Build Status][ci-badge]][ci-link]\n[![Coverage Status][cov-badge]][cov-link]\n[![Docs status][docs-badge]][docs-link]\n[![PyPI version][pypi-badge]][pypi-link]\n\n# aiida-quantum-transport\n\nA plugin for quantum transport calculations based on NEGF methods.\n\nThis plugin is the default output of the\n[AiiDA plugin cutter](https://github.com/aiidateam/aiida-plugin-cutter),\nintended to help developers get started with their AiiDA plugins.\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- [`src/aiida_quantum_transport/`](src/aiida_quantum_transport/): The main source code of the plugin package\n - [`data/`](src/aiida_quantum_transport/data/): Custom data classes\n - [`calculations.py`](src/aiida_quantum_transport/calculations.py): Quantum Transport AiiDA calculation classes\n - [`cli.py`](src/aiida_quantum_transport/cli.py): Custom `verdi` CLI commands\n - [`helpers.py`](src/aiida_quantum_transport/helpers.py): Helpers for setting up an AiiDA code\n - [`parsers.py`](src/aiida_quantum_transport/parsers.py): Custom parser classes\n- [`docs/`](docs/): The documentation of the 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 - [`conftest.py`](tests/conftest.py): Configuration of fixtures for [pytest](https://docs.pytest.org/en/latest/)\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- [`README.md`](README.md): This file\n- [`pyproject.toml`](setup.json): Python package metadata for registration on [PyPI](https://pypi.org/) and the [AiiDA plugin registry](https://aiidateam.github.io/aiida-registry/) (including entry points)\n\n## Features\n\nUnder development\n\n## Installation\n\n```shell\npip install aiida-quantum-transport\nverdi quicksetup\nverdi plugin list aiida.calculations\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\n## Development\n\n```shell\ngit clone https://github.com/edan-bainglass/aiida-quantum-transport .\ncd aiida-quantum-transport\npip install --upgrade pip\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-quantum-transport.readthedocs.io/en/latest/developer_guide/index.html) for more information.\n\n## License\n\nMIT\n\n## Contact\n\nedan.bainglass@gmail.com\n\n[ci-badge]: https://github.com/edan-bainglass/aiida-quantum-transport/workflows/ci/badge.svg?branch=master\n[ci-link]: https://github.com/edan-bainglass/aiida-quantum-transport/actions\n[cov-badge]: https://coveralls.io/repos/github/edan-bainglass/aiida-quantum-transport/badge.svg?branch=master\n[cov-link]: https://coveralls.io/github/edan-bainglass/aiida-quantum-transport?branch=master\n[docs-badge]: https://readthedocs.org/projects/aiida-quantum-transport/badge\n[docs-link]: http://aiida-quantum-transport.readthedocs.io/\n[pypi-badge]: https://badge.fury.io/py/aiida-quantum-transport.svg\n[pypi-link]: https://badge.fury.io/py/aiida-quantum-transport\n",
"bugtrack_url": null,
"license": null,
"summary": "A plugin for quantum transport calculations based on NEGF methods.",
"version": "0.1.0",
"project_urls": {
"Source": "https://github.com/edan-bainglass/aiida-quantum-transport"
},
"split_keywords": [
"quantum",
" transport",
" negf",
" dmft",
" aiida",
" plugin"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ba7523690f0343edd342b7f7f65e457fae61fe9691afe8ab6ef54bc5ffc376fd",
"md5": "fb8c99172e180961e447af27d1a16a7d",
"sha256": "a8642fd172f0682ada8c28a064eb8a64c58c4959b9cc9a74fe22ce031819586c"
},
"downloads": -1,
"filename": "aiida_quantum_transport-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fb8c99172e180961e447af27d1a16a7d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 26957,
"upload_time": "2024-05-04T06:52:12",
"upload_time_iso_8601": "2024-05-04T06:52:12.021375Z",
"url": "https://files.pythonhosted.org/packages/ba/75/23690f0343edd342b7f7f65e457fae61fe9691afe8ab6ef54bc5ffc376fd/aiida_quantum_transport-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "297d979924345eccf92543389e0c17903da0a39c0bcc8613731beb0485fe115d",
"md5": "0d3a7eb0481bef25dbcbd12d4e268036",
"sha256": "365a93f3e487bd223dd99ab4116c8cc0e141832489d5decc097f5bda82b5d47f"
},
"downloads": -1,
"filename": "aiida_quantum_transport-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "0d3a7eb0481bef25dbcbd12d4e268036",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 117621,
"upload_time": "2024-05-04T06:52:13",
"upload_time_iso_8601": "2024-05-04T06:52:13.888337Z",
"url": "https://files.pythonhosted.org/packages/29/7d/979924345eccf92543389e0c17903da0a39c0bcc8613731beb0485fe115d/aiida_quantum_transport-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-04 06:52:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edan-bainglass",
"github_project": "aiida-quantum-transport",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aiida-quantum-transport"
}
JSON
