# EDEN Python bindings + wheels
EDEN is a high-performance [NeuroML]( http://neuroml.org )-based neural simulator written in C++.
This wheel package contains Python bindings to use the simulator, as well as `win32`, `win_amd64`, `macosx_x86_64` and `manylinux1` standalone builds of the simulator.
## Installing
EDEN can be installed with one `pip` command:
```
pip install eden-simulator
```
The only non-`pip` requirement is for the GNU C compiler, Intel C compiler or Clang to be installed and available on `PATH` at run time.
## Usage
EDEN directly runs NeuroML v2 models of neural networks.
The `eden_simulator` package exposes the `runEden` method, which takes the LEMS simulation file of the NeuroML model to be run as parameter:
```python
import eden_simulator
results = eden_simulator.runEden('<LEMS simulation file>.xml')
```
This interface returns the recorded trajectories specified in the simulation files in a Python dictionary, same as [`pyNeuroML`](https://pypi.org/project/pyNeuroML/) does with other simulation backends.
Thread-level parallelism can also be controlled with the `threads` keyword argument.
If other command-line arguments should be added, they can be specified as a list of strings in the optional parameter `extra_cmdline_args`.
In case a specific instance of the EDEN executable is preferred, it can be selected with the optional parameter `executable_path`.
Both options can be combined into a fully custom command to be run from Python: it can be passed as a list of strings in the optional parameter `full_cmdline`.
The recorded trajectories are also available relative to the working directory, as specified in the LEMS file.
Some `.gen.c` and `.gen.so` temporary files may also be generated in the working directory, these can be removed after the simulation is run.
For more information about the NeuroML model format, refer to http://neuroml.org .
The program's source code is available on GitLab: https://gitlab.com/neurocomputing-lab/Inferior_OliveEMC/eden .
This software is released as open-source, under the GNU General Public License version 3.
If you have any questions, suggestions or issues with running EDEN, please [submit a ticket]( https://gitlab.com/neurocomputing-lab/Inferior_OliveEMC/eden/-/issues ) on GitLab, or contact the developer at s.panagiotou@erasmusmc.nl .
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/neurocomputing-lab/Inferior_OliveEMC/eden",
"name": "eden-simulator",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.2",
"maintainer_email": "",
"keywords": "simulator,simulation,HPC,neuroscience,NeuroML",
"author": "Sotirios Panagotou",
"author_email": "s.panagiotou@erasmusmc.nl",
"download_url": "https://gitlab.com/neurocomputing-lab/Inferior_OliveEMC/eden/-/archive/main/eden-main.zip",
"platform": "windows",
"description": "# EDEN Python bindings + wheels\n\nEDEN is a high-performance [NeuroML]( http://neuroml.org )-based neural simulator written in C++.\nThis wheel package contains Python bindings to use the simulator, as well as `win32`, `win_amd64`, `macosx_x86_64` and `manylinux1` standalone builds of the simulator.\n\n## Installing\n\nEDEN can be installed with one `pip` command:\n```\npip install eden-simulator\n```\n\nThe only non-`pip` requirement is for the GNU C compiler, Intel C compiler or Clang to be installed and available on `PATH` at run time.\n\n## Usage\n\nEDEN directly runs NeuroML v2 models of neural networks. \n\nThe `eden_simulator` package exposes the `runEden` method, which takes the LEMS simulation file of the NeuroML model to be run as parameter:\n```python\nimport eden_simulator\nresults = eden_simulator.runEden('<LEMS simulation file>.xml')\n```\nThis interface returns the recorded trajectories specified in the simulation files in a Python dictionary, same as [`pyNeuroML`](https://pypi.org/project/pyNeuroML/) does with other simulation backends.\n\nThread-level parallelism can also be controlled with the `threads` keyword argument.\n\nIf other command-line arguments should be added, they can be specified as a list of strings in the optional parameter `extra_cmdline_args`. \nIn case a specific instance of the EDEN executable is preferred, it can be selected with the optional parameter `executable_path`. \nBoth options can be combined into a fully custom command to be run from Python: it can be passed as a list of strings in the optional parameter `full_cmdline`.\n\nThe recorded trajectories are also available relative to the working directory, as specified in the LEMS file.\nSome `.gen.c` and `.gen.so` temporary files may also be generated in the working directory, these can be removed after the simulation is run.\n\nFor more information about the NeuroML model format, refer to http://neuroml.org .\n\nThe program's source code is available on GitLab: https://gitlab.com/neurocomputing-lab/Inferior_OliveEMC/eden .\n\nThis software is released as open-source, under the GNU General Public License version 3.\n\nIf you have any questions, suggestions or issues with running EDEN, please [submit a ticket]( https://gitlab.com/neurocomputing-lab/Inferior_OliveEMC/eden/-/issues ) on GitLab, or contact the developer at s.panagiotou@erasmusmc.nl .\n",
"bugtrack_url": null,
"license": "",
"summary": "Standalone Python wheels for the EDEN neural simulator",
"version": "0.2.3",
"project_urls": {
"Download": "https://gitlab.com/neurocomputing-lab/Inferior_OliveEMC/eden/-/archive/main/eden-main.zip",
"Homepage": "https://gitlab.com/neurocomputing-lab/Inferior_OliveEMC/eden"
},
"split_keywords": [
"simulator",
"simulation",
"hpc",
"neuroscience",
"neuroml"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9e08948aa88d051f8daa65d548b350f729f393d58ae39778d52ae0a49595f57c",
"md5": "6570c59bf37cdd0e4eb34dde9f151bc2",
"sha256": "310fe55ed2e90c23ce45ea4424ef7718750ca4a3ef1c4c0766ee35b883f2d857"
},
"downloads": -1,
"filename": "eden_simulator-0.2.3-py3-none-macosx_10_6_x86_64.whl",
"has_sig": false,
"md5_digest": "6570c59bf37cdd0e4eb34dde9f151bc2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.2",
"size": 1831426,
"upload_time": "2023-11-28T13:11:33",
"upload_time_iso_8601": "2023-11-28T13:11:33.390076Z",
"url": "https://files.pythonhosted.org/packages/9e/08/948aa88d051f8daa65d548b350f729f393d58ae39778d52ae0a49595f57c/eden_simulator-0.2.3-py3-none-macosx_10_6_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "86de44f0d96cb0b066acd9a1c9ce636a37d42acf74e42609a6014ccd1709b50b",
"md5": "6b707de15889d038e77f0944400fb0ef",
"sha256": "eaae54a4c5097d1af97351d4582b609d62bcfff5e36cc9a123e7b22a8f32c195"
},
"downloads": -1,
"filename": "eden_simulator-0.2.3-py3-none-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "6b707de15889d038e77f0944400fb0ef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.2",
"size": 1745166,
"upload_time": "2023-11-28T13:11:37",
"upload_time_iso_8601": "2023-11-28T13:11:37.256964Z",
"url": "https://files.pythonhosted.org/packages/86/de/44f0d96cb0b066acd9a1c9ce636a37d42acf74e42609a6014ccd1709b50b/eden_simulator-0.2.3-py3-none-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b4dc0513ac53124a9bb0f183427d6218fb847c886df9d9bb496e340bf4219f1e",
"md5": "8497b2177fb461f99b574fd2c8c153c5",
"sha256": "7ddf5b3baa9a6c04df566900f503e2dc93685ad5cad03b15ee47a4031ec20488"
},
"downloads": -1,
"filename": "eden_simulator-0.2.3-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
"has_sig": false,
"md5_digest": "8497b2177fb461f99b574fd2c8c153c5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.2",
"size": 885369,
"upload_time": "2023-11-28T13:11:40",
"upload_time_iso_8601": "2023-11-28T13:11:40.325926Z",
"url": "https://files.pythonhosted.org/packages/b4/dc/0513ac53124a9bb0f183427d6218fb847c886df9d9bb496e340bf4219f1e/eden_simulator-0.2.3-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "95c769d995953e6390cc2fc297e168278c9bf404c5acad07f66df6ec3b68072e",
"md5": "d07bb2653ac9a88c5b1ea2c372d48fa2",
"sha256": "c59c6552521d4ae99410363a03127e37abea601a22c726a975eb81af8c5365da"
},
"downloads": -1,
"filename": "eden_simulator-0.2.3-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl",
"has_sig": false,
"md5_digest": "d07bb2653ac9a88c5b1ea2c372d48fa2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.2",
"size": 1538371,
"upload_time": "2023-11-28T13:11:43",
"upload_time_iso_8601": "2023-11-28T13:11:43.667986Z",
"url": "https://files.pythonhosted.org/packages/95/c7/69d995953e6390cc2fc297e168278c9bf404c5acad07f66df6ec3b68072e/eden_simulator-0.2.3-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7ffe3c89b7a878cba76e5e193334bf76b8cadbaa94586d3f0cc92fa493fd22eb",
"md5": "b32e585a5e167f382c06c11c144e931e",
"sha256": "919bab98aecf55d8fdeeef42aef09b5b0939940eb0b0e5163dfc1a78453403de"
},
"downloads": -1,
"filename": "eden_simulator-0.2.3-py3-none-manylinux_2_5_x86_64.manylinux1_x86_64.whl",
"has_sig": false,
"md5_digest": "b32e585a5e167f382c06c11c144e931e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.2",
"size": 1939299,
"upload_time": "2023-11-28T13:11:46",
"upload_time_iso_8601": "2023-11-28T13:11:46.607120Z",
"url": "https://files.pythonhosted.org/packages/7f/fe/3c89b7a878cba76e5e193334bf76b8cadbaa94586d3f0cc92fa493fd22eb/eden_simulator-0.2.3-py3-none-manylinux_2_5_x86_64.manylinux1_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0ec7cfe1ce94fc12d10ea7f3a7e306ed7059ab129c4a9c2e6028f511dd460315",
"md5": "e889bef72765f85bd7c85184e0b2433f",
"sha256": "597ad1a1fdcf0cc05f93ef014c540145c6e0bcb3b5688403454437583418d5c2"
},
"downloads": -1,
"filename": "eden_simulator-0.2.3-py3-none-win32.whl",
"has_sig": false,
"md5_digest": "e889bef72765f85bd7c85184e0b2433f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.2",
"size": 1429362,
"upload_time": "2023-11-28T13:11:49",
"upload_time_iso_8601": "2023-11-28T13:11:49.586521Z",
"url": "https://files.pythonhosted.org/packages/0e/c7/cfe1ce94fc12d10ea7f3a7e306ed7059ab129c4a9c2e6028f511dd460315/eden_simulator-0.2.3-py3-none-win32.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a924b49f0792a20b121d7c5eb31300cff192a4443320c458bbce4304a588cca1",
"md5": "d01416b16127a728d879c17c2a06bfab",
"sha256": "62ec9c40598aeca8fde44c9f10e38334fb7ff2b969650f0e7aa891b2c56fd3c8"
},
"downloads": -1,
"filename": "eden_simulator-0.2.3-py3-none-win_amd64.whl",
"has_sig": false,
"md5_digest": "d01416b16127a728d879c17c2a06bfab",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.2",
"size": 1402311,
"upload_time": "2023-11-28T13:11:53",
"upload_time_iso_8601": "2023-11-28T13:11:53.182131Z",
"url": "https://files.pythonhosted.org/packages/a9/24/b49f0792a20b121d7c5eb31300cff192a4443320c458bbce4304a588cca1/eden_simulator-0.2.3-py3-none-win_amd64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-28 13:11:33",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "neurocomputing-lab",
"gitlab_project": "Inferior_OliveEMC",
"lcname": "eden-simulator"
}
JSON