# PyHELICS
[](https://github.com/GMLC-TDC/pyhelics/actions)
[](https://gitter.im/GMLC-TDC/HELICS)
[](https://python.helics.org)
[](https://codecov.io/gh/GMLC-TDC/pyhelics)
[](https://pypi.org/project/helics/)
[](https://pypi.org/project/helics/)
[](https://pypi.org/project/helics/)
[](https://pypi.org/project/helics/)
Python HELICS bindings
```bash
pip install helics
```
If you wish to get additional functionality in the CLI (_experimental_), you can install it using the following:
```bash
pip install 'helics[cli]'
```
# Documentation
To use the project:
```python
import helics as h
h.helicsGetVersion()
```
See <https://docs.helics.org> for more information about how to use HELICS.
This package uses `cffi` to provide a Python interface to the [HELICS C API](https://docs.helics.org/en/latest/references/api-reference/C_API.html).
By default, when you install from PyPI, the version number of the package will match the version of HELICS that is installed.
For example, if you run the following:
```
pip install helics
```
You will also get precompiled binaries of [HELICS](https://github.com/GMLC-TDC/HELICS/releases/latest) for your platform if they exist.
If they don't exist, a source distribution will attempt to be built and installed. The user can also provide the location of the binaries if they wish to do so.
For more information, see <https://python.helics.org/installation>.
# Debugging
Please share the output of the following command when creating an issue:
```
$ python -c "import helics as h; import json; print(json.dumps(h.helicsGetSystemInfo(), indent=4, sort_keys=True))"
```
# Citation
General citation for HELICS:
T. Hardy, B. Palmintier, P. Top, D. Krishnamurthy and J. Fuller, "HELICS: A Co-Simulation Framework for Scalable Multi-Domain Modeling and Analysis," in IEEE Access, doi: 10.1109/ACCESS.2024.3363615, available at [https://ieeexplore.ieee.org/document/10424422](https://ieeexplore.ieee.org/document/10424422/)
Raw data
{
"_id": null,
"home_page": "https://github.com/GMLC-TDC/pyhelics",
"name": "helics",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "helics, co-simulation",
"author": "Dheepak Krishnamurthy",
"author_email": "me@kdheepak.com",
"download_url": "https://files.pythonhosted.org/packages/53/02/75978052e39ca2b0cae5d91906086bebd2b516f6fa28344b12c9cb1aed24/helics-3.5.3.tar.gz",
"platform": null,
"description": "# PyHELICS\n\n[](https://github.com/GMLC-TDC/pyhelics/actions)\n[](https://gitter.im/GMLC-TDC/HELICS)\n[](https://python.helics.org)\n[](https://codecov.io/gh/GMLC-TDC/pyhelics)\n[](https://pypi.org/project/helics/)\n[](https://pypi.org/project/helics/)\n[](https://pypi.org/project/helics/)\n[](https://pypi.org/project/helics/)\n\nPython HELICS bindings\n\n```bash\npip install helics\n```\n\nIf you wish to get additional functionality in the CLI (_experimental_), you can install it using the following:\n\n```bash\npip install 'helics[cli]'\n```\n\n# Documentation\n\nTo use the project:\n\n```python\nimport helics as h\nh.helicsGetVersion()\n```\n\nSee <https://docs.helics.org> for more information about how to use HELICS.\n\nThis package uses `cffi` to provide a Python interface to the [HELICS C API](https://docs.helics.org/en/latest/references/api-reference/C_API.html).\n\nBy default, when you install from PyPI, the version number of the package will match the version of HELICS that is installed.\nFor example, if you run the following:\n\n```\npip install helics\n```\n\nYou will also get precompiled binaries of [HELICS](https://github.com/GMLC-TDC/HELICS/releases/latest) for your platform if they exist.\nIf they don't exist, a source distribution will attempt to be built and installed. The user can also provide the location of the binaries if they wish to do so.\nFor more information, see <https://python.helics.org/installation>.\n\n# Debugging\n\nPlease share the output of the following command when creating an issue:\n\n```\n$ python -c \"import helics as h; import json; print(json.dumps(h.helicsGetSystemInfo(), indent=4, sort_keys=True))\"\n```\n# Citation\nGeneral citation for HELICS:\nT. Hardy, B. Palmintier, P. Top, D. Krishnamurthy and J. Fuller, \"HELICS: A Co-Simulation Framework for Scalable Multi-Domain Modeling and Analysis,\" in IEEE Access, doi: 10.1109/ACCESS.2024.3363615, available at [https://ieeexplore.ieee.org/document/10424422](https://ieeexplore.ieee.org/document/10424422/)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python HELICS bindings",
"version": "3.5.3",
"project_urls": {
"Homepage": "https://github.com/GMLC-TDC/pyhelics",
"Issue Tracker": "https://github.com/GMLC-TDC/pyhelics/issues"
},
"split_keywords": [
"helics",
" co-simulation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "590e4719397ac28967789864141bffc8dbfadcf78cc24184db8009466e419ebe",
"md5": "fd2012f8912687b516ec67bd00f89573",
"sha256": "da8c5dd71f1663fbfa001efca985633ff2199cae5f2ef6980e71fb54beab6740"
},
"downloads": -1,
"filename": "helics-3.5.3-py3-none-macosx_10_14_universal2.macosx_10_14_x86_64.macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "fd2012f8912687b516ec67bd00f89573",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 42737834,
"upload_time": "2024-07-09T20:38:38",
"upload_time_iso_8601": "2024-07-09T20:38:38.675596Z",
"url": "https://files.pythonhosted.org/packages/59/0e/4719397ac28967789864141bffc8dbfadcf78cc24184db8009466e419ebe/helics-3.5.3-py3-none-macosx_10_14_universal2.macosx_10_14_x86_64.macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "76134fbf277af2e6065ac70e68848f12d2bff33ab79a2c51b454b4bec7e7cd2e",
"md5": "86b735e89f8afec8c53d24c8326f1822",
"sha256": "760dc20738d3a8ea5c47357a9dace4f2cc52d954b0ef8b31532ef682af8fc723"
},
"downloads": -1,
"filename": "helics-3.5.3-py3-none-manylinux2010_x86_64.whl",
"has_sig": false,
"md5_digest": "86b735e89f8afec8c53d24c8326f1822",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 27193471,
"upload_time": "2024-07-09T20:38:43",
"upload_time_iso_8601": "2024-07-09T20:38:43.382593Z",
"url": "https://files.pythonhosted.org/packages/76/13/4fbf277af2e6065ac70e68848f12d2bff33ab79a2c51b454b4bec7e7cd2e/helics-3.5.3-py3-none-manylinux2010_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cfb34eaff1c72bffd3d2f734539c54fb79d26ea1047707ecc38935230dcc622f",
"md5": "4523a9893e67da5c9ecf3ee06dddd238",
"sha256": "4c714bd2a44587e4cde9e13d60a5106feb12af71fb399c3037da3e23784c11b6"
},
"downloads": -1,
"filename": "helics-3.5.3-py3-none-win32.whl",
"has_sig": false,
"md5_digest": "4523a9893e67da5c9ecf3ee06dddd238",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 12459731,
"upload_time": "2024-07-09T20:38:49",
"upload_time_iso_8601": "2024-07-09T20:38:49.204254Z",
"url": "https://files.pythonhosted.org/packages/cf/b3/4eaff1c72bffd3d2f734539c54fb79d26ea1047707ecc38935230dcc622f/helics-3.5.3-py3-none-win32.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8c44be4f8f94271acc46f078519a89a0fd2fe4b0da181ec323dbc85a8d4cba52",
"md5": "ee7ea856e528b76c5154354d9121e00f",
"sha256": "646e78f254a34ec56ca90d4d2a62ddc045260835416d0332b2a2effabe6140bc"
},
"downloads": -1,
"filename": "helics-3.5.3-py3-none-win_amd64.whl",
"has_sig": false,
"md5_digest": "ee7ea856e528b76c5154354d9121e00f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 14241304,
"upload_time": "2024-07-09T20:38:52",
"upload_time_iso_8601": "2024-07-09T20:38:52.434330Z",
"url": "https://files.pythonhosted.org/packages/8c/44/be4f8f94271acc46f078519a89a0fd2fe4b0da181ec323dbc85a8d4cba52/helics-3.5.3-py3-none-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "530275978052e39ca2b0cae5d91906086bebd2b516f6fa28344b12c9cb1aed24",
"md5": "9b6e248ca55ad607cde81b65970a3d2c",
"sha256": "0ab9759b137b9b375c920d60b457ee0b41a80c0b2687b218c970b5340fc8a9b9"
},
"downloads": -1,
"filename": "helics-3.5.3.tar.gz",
"has_sig": false,
"md5_digest": "9b6e248ca55ad607cde81b65970a3d2c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 294017,
"upload_time": "2024-07-09T20:39:00",
"upload_time_iso_8601": "2024-07-09T20:39:00.075724Z",
"url": "https://files.pythonhosted.org/packages/53/02/75978052e39ca2b0cae5d91906086bebd2b516f6fa28344b12c9cb1aed24/helics-3.5.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-09 20:39:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GMLC-TDC",
"github_project": "pyhelics",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "helics"
}
JSON
