| Name | vcdparser JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2025-01-19 14:11:00 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | MIT License Copyright (c) 2025 Kilian Krampf Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
vcd
parser
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# vcdparser
A simple VCD parser to access the contents of a VCD file in python.
The goal is to provide an easy to use, lightweight parser for VCD files.
The parser also aims to be quite fast (for a python library 😉).
## What does it do?
This library contains a simple parser, which reads in VCD files and provides you with the raw data from this file.
## How to use
To install the latest version from PyPI use `pip install vcdparser`.
After that you can import the parser using `import vcdparser.parser`.
This is a simple script showing you how to parse a file and get the first 10 changes of a signal named `"CLK"`:
````python
import vcdparser.parser
vcd = parser.parse_vcd_file("your_file_path.vcd")
clk_id = vcd.get_id("CLK")
count = 0
for t in vcd.timesteps:
if clk_id in t.variables:
count += 1
print(f"CLK changed to {t.variables[clk_id]}")
if count >= 10:
break
````
## Contributing
We are always happy to receive contributions!
Please take a look at [the contribution guidelines](CONTRIBUTING.md) and the [Code of Conduct](CODE_OF_CONDUCT.md) before making changes.
Raw data
{
"_id": null,
"home_page": null,
"name": "vcdparser",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "vcd, parser",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/5a/5a/025c75392b5e2bdbccd016d0d3f91d6777252fde6593337fb706404bf7f2/vcdparser-0.1.0.tar.gz",
"platform": null,
"description": "# vcdparser\n\nA simple VCD parser to access the contents of a VCD file in python.\n\nThe goal is to provide an easy to use, lightweight parser for VCD files.\nThe parser also aims to be quite fast (for a python library \ud83d\ude09).\n\n## What does it do?\n\nThis library contains a simple parser, which reads in VCD files and provides you with the raw data from this file.\n\n## How to use\n\nTo install the latest version from PyPI use `pip install vcdparser`.\nAfter that you can import the parser using `import vcdparser.parser`.\n\nThis is a simple script showing you how to parse a file and get the first 10 changes of a signal named `\"CLK\"`:\n\n````python\nimport vcdparser.parser\n\nvcd = parser.parse_vcd_file(\"your_file_path.vcd\")\nclk_id = vcd.get_id(\"CLK\")\n\ncount = 0\nfor t in vcd.timesteps:\n if clk_id in t.variables:\n count += 1\n print(f\"CLK changed to {t.variables[clk_id]}\")\n if count >= 10:\n break\n````\n\n## Contributing\n\nWe are always happy to receive contributions!\nPlease take a look at [the contribution guidelines](CONTRIBUTING.md) and the [Code of Conduct](CODE_OF_CONDUCT.md) before making changes.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2025 Kilian Krampf Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": null,
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/menkalian/vcdparser",
"Repository": "https://github.com/menkalian/vcdparser"
},
"split_keywords": [
"vcd",
" parser"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2d53e62c2f964a9fdf56ac2f7fe417582ce61224127500de739eb479748bd111",
"md5": "c145b1d5760fe1909fdf72d4edead760",
"sha256": "39d718a40703d28848131e07490c9b8ec669eaeee8ae674323d0390feac926df"
},
"downloads": -1,
"filename": "vcdparser-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c145b1d5760fe1909fdf72d4edead760",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6528,
"upload_time": "2025-01-19T14:10:59",
"upload_time_iso_8601": "2025-01-19T14:10:59.096767Z",
"url": "https://files.pythonhosted.org/packages/2d/53/e62c2f964a9fdf56ac2f7fe417582ce61224127500de739eb479748bd111/vcdparser-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5a5a025c75392b5e2bdbccd016d0d3f91d6777252fde6593337fb706404bf7f2",
"md5": "7f34d0d60e06e0880517ff33e0413424",
"sha256": "de539bcc6917903317d906b62dacf9469a1ed738522e74e727fec05730334fb0"
},
"downloads": -1,
"filename": "vcdparser-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "7f34d0d60e06e0880517ff33e0413424",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6210,
"upload_time": "2025-01-19T14:11:00",
"upload_time_iso_8601": "2025-01-19T14:11:00.530720Z",
"url": "https://files.pythonhosted.org/packages/5a/5a/025c75392b5e2bdbccd016d0d3f91d6777252fde6593337fb706404bf7f2/vcdparser-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-19 14:11:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "menkalian",
"github_project": "vcdparser",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "vcdparser"
}
