Name | aiida-pythonjob JSON |
Version |
0.1.6
JSON |
| download |
home_page | None |
Summary | Run Python functions on a remote computer. |
upload_time | 2024-12-15 07:10:16 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.9 |
license | MIT License Copyright (c) 2024 AiiDA team Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
keywords |
aiida
plugin
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# AiiDA-PythonJob
[![PyPI version](https://badge.fury.io/py/aiida-pythonjob.svg)](https://badge.fury.io/py/aiida-pythonjob)
[![Unit test](https://github.com/aiidateam/aiida-pythonjob/actions/workflows/ci.yml/badge.svg)](https://github.com/aiidateam/aiida-pythonjob/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/aiidateam/aiida-pythonjob/branch/main/graph/badge.svg)](https://codecov.io/gh/aiidateam/aiida-pythonjob)
[![Docs status](https://readthedocs.org/projects/aiida-pythonjob/badge)](http://aiida-pythonjob.readthedocs.io/)
`PythonJob` allows users to run Python functions on a remote computer. It is designed to enable users from non-AiiDA communities to run their Python functions remotely and construct workflows with checkpoints, maintaining all data provenance. For instance, users can use ASE's calculator to run a DFT calculation on a remote computer directly.
## Key Features
1. **Remote Execution**: Seamlessly run Python functions on a remote computer.
2. **User-Friendly**: Designed for users who are not familiar with AiiDA, simplifying the process of remote execution.
3. **Workflow Management**: Construct workflows using WorkGraph with checkpoints, ensuring that intermediate states and results are preserved.
4. **Data Provenance**: Maintain comprehensive data provenance, tracking the full history and transformations of data.
## Installation
```console
pip install aiida-pythonjob
```
To install the latest version from source, first clone the repository and then install using `pip`:
```console
git clone https://github.com/aiidateam/aiida-pythonjob
cd aiida-pythonjob
pip install -e .
```
## Documentation
Explore the comprehensive [documentation](https://aiida-pythonjob.readthedocs.io/en/latest/) to discover all the features and capabilities of AiiDA PythonJob.
## License
[MIT](http://opensource.org/licenses/MIT)
Raw data
{
"_id": null,
"home_page": null,
"name": "aiida-pythonjob",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "aiida, plugin",
"author": null,
"author_email": "Xing Wang <xingwang1991@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/81/fc/6720f11a91144f240f93879091508b04d5602475dcd03b4acff0cd8ea13c/aiida_pythonjob-0.1.6.tar.gz",
"platform": null,
"description": "# AiiDA-PythonJob\n[![PyPI version](https://badge.fury.io/py/aiida-pythonjob.svg)](https://badge.fury.io/py/aiida-pythonjob)\n[![Unit test](https://github.com/aiidateam/aiida-pythonjob/actions/workflows/ci.yml/badge.svg)](https://github.com/aiidateam/aiida-pythonjob/actions/workflows/ci.yml)\n[![codecov](https://codecov.io/gh/aiidateam/aiida-pythonjob/branch/main/graph/badge.svg)](https://codecov.io/gh/aiidateam/aiida-pythonjob)\n[![Docs status](https://readthedocs.org/projects/aiida-pythonjob/badge)](http://aiida-pythonjob.readthedocs.io/)\n\n`PythonJob` allows users to run Python functions on a remote computer. It is designed to enable users from non-AiiDA communities to run their Python functions remotely and construct workflows with checkpoints, maintaining all data provenance. For instance, users can use ASE's calculator to run a DFT calculation on a remote computer directly.\n\n## Key Features\n\n1. **Remote Execution**: Seamlessly run Python functions on a remote computer.\n2. **User-Friendly**: Designed for users who are not familiar with AiiDA, simplifying the process of remote execution.\n3. **Workflow Management**: Construct workflows using WorkGraph with checkpoints, ensuring that intermediate states and results are preserved.\n4. **Data Provenance**: Maintain comprehensive data provenance, tracking the full history and transformations of data.\n\n\n\n## Installation\n\n```console\n pip install aiida-pythonjob\n```\n\nTo install the latest version from source, first clone the repository and then install using `pip`:\n\n```console\ngit clone https://github.com/aiidateam/aiida-pythonjob\ncd aiida-pythonjob\npip install -e .\n```\n\n\n## Documentation\nExplore the comprehensive [documentation](https://aiida-pythonjob.readthedocs.io/en/latest/) to discover all the features and capabilities of AiiDA PythonJob.\n\n\n## License\n[MIT](http://opensource.org/licenses/MIT)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 AiiDA team Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Run Python functions on a remote computer.",
"version": "0.1.6",
"project_urls": {
"Source": "https://github.com/aiidateam/aiida-pythonjob"
},
"split_keywords": [
"aiida",
" plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "871d37720901036141580f70e94acd0d672cdd287195a13bc5135307c1f0e47c",
"md5": "db01da93a726f614803a10e69b477c41",
"sha256": "c3db92252a0f9ce8c1646f9b3df99d49ad9a1cbc7e0426027c141f0018cc0657"
},
"downloads": -1,
"filename": "aiida_pythonjob-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "db01da93a726f614803a10e69b477c41",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 20648,
"upload_time": "2024-12-15T07:10:15",
"upload_time_iso_8601": "2024-12-15T07:10:15.379582Z",
"url": "https://files.pythonhosted.org/packages/87/1d/37720901036141580f70e94acd0d672cdd287195a13bc5135307c1f0e47c/aiida_pythonjob-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "81fc6720f11a91144f240f93879091508b04d5602475dcd03b4acff0cd8ea13c",
"md5": "bada8410bd33525e8c55fd1c7c6526e6",
"sha256": "50b6da660e0d6b7b4de340a543371c327b68d118a2595ecbc244deb583845c72"
},
"downloads": -1,
"filename": "aiida_pythonjob-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "bada8410bd33525e8c55fd1c7c6526e6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 48395,
"upload_time": "2024-12-15T07:10:16",
"upload_time_iso_8601": "2024-12-15T07:10:16.657234Z",
"url": "https://files.pythonhosted.org/packages/81/fc/6720f11a91144f240f93879091508b04d5602475dcd03b4acff0cd8ea13c/aiida_pythonjob-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-15 07:10:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aiidateam",
"github_project": "aiida-pythonjob",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aiida-pythonjob"
}