| Name | mkwind JSON |
| Version |
24.9.5
JSON |
| download |
| home_page | None |
| Summary | mkwind is a job building/submission automator companion to mkite |
| upload_time | 2024-09-05 17:51:02 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
workflow
materials-science
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
<img src="https://raw.githubusercontent.com/mkite-group/mkwind/main/docs/_static/mkwind.png" width="500"><br>
</div>
# What is mkwind?
mkwind is an accompanying package to mkite for running tasks on client workers.
This package allows running simulations without installing all the database requirements, thus protecting the server from modifications on the client side.
mkwind offers a set of tools for building, running, and postprocessing the tasks, and sending them back to mkite through `mkite_engines`.
## Documentation
General tutorial for `mkite` and its plugins are available in the [main documentation](https://mkite.org).
Complete API documentation is pending.
## Installation
To install `mkwind`, install the main dependencies `mkite_core` and `mkite_engines`:
```bash
pip install mkite_core mkite_engines
pip install mkwind
```
Alternatively, for a development version, use:
```bash
pip install -U git+https://github.com/mkite-group/mkwind
```
## Contributions
Contributions to the entire mkite suite are welcomed.
You can send a pull request or open an issue for this plugin or either of the packages in mkite.
When doing so, please adhere to the [Code of Conduct](CODE_OF_CONDUCT.md) in the mkite suite.
The mkite package was created by Daniel Schwalbe-Koda <dskoda@ucla.edu>.
## License
The mkite suite is distributed under the following license: Apache 2.0 WITH LLVM exception.
All new contributions must be made under this license.
SPDX: Apache-2.0, LLVM-exception
LLNL-CODE-848161
Raw data
{
"_id": null,
"home_page": null,
"name": "mkwind",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "workflow, materials-science",
"author": null,
"author_email": "Daniel Schwalbe-Koda <dskoda@ucla.edu>",
"download_url": "https://files.pythonhosted.org/packages/a8/6f/b8cd0f296f743045e3fc244e4ae9af6177028f0464e7f881bc9cc3486118/mkwind-24.9.5.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <img src=\"https://raw.githubusercontent.com/mkite-group/mkwind/main/docs/_static/mkwind.png\" width=\"500\"><br>\n</div>\n\n# What is mkwind?\n\nmkwind is an accompanying package to mkite for running tasks on client workers.\nThis package allows running simulations without installing all the database requirements, thus protecting the server from modifications on the client side.\nmkwind offers a set of tools for building, running, and postprocessing the tasks, and sending them back to mkite through `mkite_engines`.\n\n## Documentation\n\nGeneral tutorial for `mkite` and its plugins are available in the [main documentation](https://mkite.org).\nComplete API documentation is pending.\n\n## Installation\n\nTo install `mkwind`, install the main dependencies `mkite_core` and `mkite_engines`:\n\n```bash\npip install mkite_core mkite_engines\npip install mkwind\n```\n\nAlternatively, for a development version, use:\n\n```bash\npip install -U git+https://github.com/mkite-group/mkwind\n```\n\n## Contributions\n\nContributions to the entire mkite suite are welcomed.\nYou can send a pull request or open an issue for this plugin or either of the packages in mkite.\nWhen doing so, please adhere to the [Code of Conduct](CODE_OF_CONDUCT.md) in the mkite suite.\n\nThe mkite package was created by Daniel Schwalbe-Koda <dskoda@ucla.edu>.\n\n## License\n\nThe mkite suite is distributed under the following license: Apache 2.0 WITH LLVM exception.\n\nAll new contributions must be made under this license.\n\nSPDX: Apache-2.0, LLVM-exception\n\nLLNL-CODE-848161\n",
"bugtrack_url": null,
"license": null,
"summary": "mkwind is a job building/submission automator companion to mkite",
"version": "24.9.5",
"project_urls": null,
"split_keywords": [
"workflow",
" materials-science"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a7e55987b258e67853fb5c680fe742f6b088b0e71bede6c78a76a1497c7da993",
"md5": "f68e591157724a6592f62cff7179a0ec",
"sha256": "c4c0052c0d2477d642099f535ff110b79a8f34b407a9c0d6839c1100e6513de0"
},
"downloads": -1,
"filename": "mkwind-24.9.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f68e591157724a6592f62cff7179a0ec",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 49446,
"upload_time": "2024-09-05T17:51:01",
"upload_time_iso_8601": "2024-09-05T17:51:01.539249Z",
"url": "https://files.pythonhosted.org/packages/a7/e5/5987b258e67853fb5c680fe742f6b088b0e71bede6c78a76a1497c7da993/mkwind-24.9.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a86fb8cd0f296f743045e3fc244e4ae9af6177028f0464e7f881bc9cc3486118",
"md5": "c18451522e01e2d1589cece355280ee3",
"sha256": "af25c301c4e2f75c2ca4a79e30329b4e9285f4ff692902016ef33f29ab92b449"
},
"downloads": -1,
"filename": "mkwind-24.9.5.tar.gz",
"has_sig": false,
"md5_digest": "c18451522e01e2d1589cece355280ee3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 41694,
"upload_time": "2024-09-05T17:51:02",
"upload_time_iso_8601": "2024-09-05T17:51:02.902469Z",
"url": "https://files.pythonhosted.org/packages/a8/6f/b8cd0f296f743045e3fc244e4ae9af6177028f0464e7f881bc9cc3486118/mkwind-24.9.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-05 17:51:02",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mkwind"
}
