| Name | nmodl-preprocessor JSON |
| Version |
1.0.8
JSON |
| download |
| home_page | |
| Summary | Optimize NMODL files for the NEURON simulator |
| upload_time | 2023-07-06 16:34:22 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
nmodl
neuron
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# nmodl_preprocessor
This program optimizes NMODL files for the NEURON simulator.
It scans all of your project's files to perform aggressive whole program optimization.
It performs the following optimizations to ".mod" files:
* Hardcode the parameters
* Hardcode the temperature
* Hardcode any assigned variables with constant values
* Inline all functions and procedures
* Convert assigned variables into local variables
These optimizations can improve run-time performance and memory usage by between
5% and 15%.
## Installation
#### Prerequisites
* [Python](https://www.python.org/) and [pip](https://pip.pypa.io/en/stable/)
* [The NMODL Framework](https://bluebrain.github.io/nmodl/html/index.html)
```
pip install nmodl_preprocessor
```
## Usage
```
$ nmodl_preprocessor [-h] project_dir [model_dir ...]
positional arguments:
project_dir root directory of all simulation files
model_dir input directory of nmodl files
options:
-h, --help show this help message and exit
```
## Tips
* Always check your results for accuracy and correctness.
* Do not use this tool with neuron's graphical user interface "nrngui".
* Keep your projects in separate directories.
* Use unique and descriptive variable names.
* Remove unnecessary VERBATIM statements.
Raw data
{
"_id": null,
"home_page": "",
"name": "nmodl-preprocessor",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "nmodl,neuron",
"author": "",
"author_email": "David McDougall <dam1784@rit.edu>",
"download_url": "https://files.pythonhosted.org/packages/4b/90/08bc7c2b6364f1ac210d65df787a0c1999d7cae183ed16eec3bd0ccdfebc/nmodl_preprocessor-1.0.8.tar.gz",
"platform": null,
"description": "# nmodl_preprocessor\n\nThis program optimizes NMODL files for the NEURON simulator. \nIt scans all of your project's files to perform aggressive whole program optimization. \nIt performs the following optimizations to \".mod\" files: \n* Hardcode the parameters\n* Hardcode the temperature\n* Hardcode any assigned variables with constant values\n* Inline all functions and procedures\n* Convert assigned variables into local variables\n\nThese optimizations can improve run-time performance and memory usage by between\n5% and 15%.\n\n## Installation\n\n#### Prerequisites\n* [Python](https://www.python.org/) and [pip](https://pip.pypa.io/en/stable/)\n* [The NMODL Framework](https://bluebrain.github.io/nmodl/html/index.html)\n\n```\npip install nmodl_preprocessor\n```\n\n## Usage\n```\n$ nmodl_preprocessor [-h] project_dir [model_dir ...]\n\npositional arguments:\n project_dir root directory of all simulation files\n model_dir input directory of nmodl files\n\noptions:\n -h, --help show this help message and exit\n\n```\n\n## Tips\n\n* Always check your results for accuracy and correctness.\n\n* Do not use this tool with neuron's graphical user interface \"nrngui\".\n\n* Keep your projects in separate directories. \n\n* Use unique and descriptive variable names. \n\n* Remove unnecessary VERBATIM statements. \n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Optimize NMODL files for the NEURON simulator",
"version": "1.0.8",
"project_urls": {
"Homepage": "https://github.com/ctrl-z-9000-times/nmodl_preprocessor"
},
"split_keywords": [
"nmodl",
"neuron"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "50aa7b96f4535a736e1230f19f68380aa4433e54cf7ca36ad3ceec357637570d",
"md5": "199e38d279432ca1bc150695a9a7d2dd",
"sha256": "e60920179752a0aea91427402159e6cf8bd0c8b35f756950b6ce7116dfa00105"
},
"downloads": -1,
"filename": "nmodl_preprocessor-1.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "199e38d279432ca1bc150695a9a7d2dd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 17069,
"upload_time": "2023-07-06T16:34:21",
"upload_time_iso_8601": "2023-07-06T16:34:21.532823Z",
"url": "https://files.pythonhosted.org/packages/50/aa/7b96f4535a736e1230f19f68380aa4433e54cf7ca36ad3ceec357637570d/nmodl_preprocessor-1.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4b9008bc7c2b6364f1ac210d65df787a0c1999d7cae183ed16eec3bd0ccdfebc",
"md5": "a7266d502db9599653bfb52bfa3d905e",
"sha256": "b23d1f27c68ee0eab198e9128ec12044eb73f1062389f3ecbf989ce2c93311ac"
},
"downloads": -1,
"filename": "nmodl_preprocessor-1.0.8.tar.gz",
"has_sig": false,
"md5_digest": "a7266d502db9599653bfb52bfa3d905e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 58729,
"upload_time": "2023-07-06T16:34:22",
"upload_time_iso_8601": "2023-07-06T16:34:22.823642Z",
"url": "https://files.pythonhosted.org/packages/4b/90/08bc7c2b6364f1ac210d65df787a0c1999d7cae183ed16eec3bd0ccdfebc/nmodl_preprocessor-1.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-06 16:34:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ctrl-z-9000-times",
"github_project": "nmodl_preprocessor",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "nmodl-preprocessor"
}
