# 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))"
```
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/cb/93/ede2a8e5934debb759cdbbfe5a6c90606f19f6bdea7e5b5172ade2ccd787/helics-3.5.2.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",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python HELICS bindings",
"version": "3.5.2",
"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": "506f5feb352b40cc8c0a2c3858f474000b5779c1a403ed9ad2b40c43b393b727",
"md5": "c65f7925fb470d7ee1e8d3179f00fb1f",
"sha256": "e5ad2a27d656bc96d37ef4f3e070390225b2fa8b178b12db638ca77cf4240692"
},
"downloads": -1,
"filename": "helics-3.5.2-py3-none-macosx_10_14_universal2.macosx_10_14_x86_64.macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "c65f7925fb470d7ee1e8d3179f00fb1f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 43662342,
"upload_time": "2024-04-10T23:46:34",
"upload_time_iso_8601": "2024-04-10T23:46:34.353605Z",
"url": "https://files.pythonhosted.org/packages/50/6f/5feb352b40cc8c0a2c3858f474000b5779c1a403ed9ad2b40c43b393b727/helics-3.5.2-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": "907b349b7a5447f8e9d573c892f49839b12d359a79fb62d545dfd7c4b443ff9f",
"md5": "48a26a1e7331776c1eb0d23ff9549618",
"sha256": "77aa776024ea3eb0b2fb6e0265295650cf512572a4142c69e56eb5c972ee3a33"
},
"downloads": -1,
"filename": "helics-3.5.2-py3-none-manylinux2010_x86_64.whl",
"has_sig": false,
"md5_digest": "48a26a1e7331776c1eb0d23ff9549618",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 27180853,
"upload_time": "2024-04-10T23:46:39",
"upload_time_iso_8601": "2024-04-10T23:46:39.333374Z",
"url": "https://files.pythonhosted.org/packages/90/7b/349b7a5447f8e9d573c892f49839b12d359a79fb62d545dfd7c4b443ff9f/helics-3.5.2-py3-none-manylinux2010_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c03b06ab36bd71d2f45abb254322cf63c5d7985db0e61a4804940b665eee257d",
"md5": "dc0185ac3bd0560be1b9248ad9f82447",
"sha256": "4ed0d78de2da5ae508c6593c31123a406991d62073e17bfcdda89c47dcdd406a"
},
"downloads": -1,
"filename": "helics-3.5.2-py3-none-win32.whl",
"has_sig": false,
"md5_digest": "dc0185ac3bd0560be1b9248ad9f82447",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 12454189,
"upload_time": "2024-04-10T23:46:43",
"upload_time_iso_8601": "2024-04-10T23:46:43.085037Z",
"url": "https://files.pythonhosted.org/packages/c0/3b/06ab36bd71d2f45abb254322cf63c5d7985db0e61a4804940b665eee257d/helics-3.5.2-py3-none-win32.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4c995d8ddf93a775725b8c36d3dd12fb98d34e97b8ddc96f73c11cb2c4216fb1",
"md5": "a5e47dba216d7467a0cb6d1478790bce",
"sha256": "4d49bf3be33ef9bdd939c44e8cf821d455aa2e3b0f09aedaedf32ea100ce45cd"
},
"downloads": -1,
"filename": "helics-3.5.2-py3-none-win_amd64.whl",
"has_sig": false,
"md5_digest": "a5e47dba216d7467a0cb6d1478790bce",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 14235979,
"upload_time": "2024-04-10T23:46:45",
"upload_time_iso_8601": "2024-04-10T23:46:45.844905Z",
"url": "https://files.pythonhosted.org/packages/4c/99/5d8ddf93a775725b8c36d3dd12fb98d34e97b8ddc96f73c11cb2c4216fb1/helics-3.5.2-py3-none-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cb93ede2a8e5934debb759cdbbfe5a6c90606f19f6bdea7e5b5172ade2ccd787",
"md5": "5f1eb6d83ebd18ba0e5bddc2cb10245f",
"sha256": "911b3419c2a3de019b904a183805488ea4d4ea81c4efd24c1d5680aa069924e4"
},
"downloads": -1,
"filename": "helics-3.5.2.tar.gz",
"has_sig": false,
"md5_digest": "5f1eb6d83ebd18ba0e5bddc2cb10245f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 292992,
"upload_time": "2024-04-10T23:46:48",
"upload_time_iso_8601": "2024-04-10T23:46:48.366189Z",
"url": "https://files.pythonhosted.org/packages/cb/93/ede2a8e5934debb759cdbbfe5a6c90606f19f6bdea7e5b5172ade2ccd787/helics-3.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-10 23:46:48",
"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
