{"id":19984497,"url":"https://github.com/intellabs/pycaliper","last_synced_at":"2025-07-22T12:34:40.546Z","repository":{"id":257207629,"uuid":"843108234","full_name":"IntelLabs/pycaliper","owner":"IntelLabs","description":"PyCaliper is Python-based tooling infrastructure that allows the verification and synthesis of specifications (properties) for RTL (e.g., Verilog, SystemVerilog)","archived":false,"fork":false,"pushed_at":"2025-06-13T15:24:29.000Z","size":98,"stargazers_count":22,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-03T00:06:10.961Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IntelLabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-08-15T19:53:25.000Z","updated_at":"2025-06-13T15:24:32.000Z","dependencies_parsed_at":"2024-09-15T10:05:52.672Z","dependency_job_id":"403f413d-5bdb-43c4-9161-7c60034ff2d9","html_url":"https://github.com/IntelLabs/pycaliper","commit_stats":null,"previous_names":["intellabs/pycaliper"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/IntelLabs/pycaliper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntelLabs%2Fpycaliper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntelLabs%2Fpycaliper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntelLabs%2Fpycaliper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntelLabs%2Fpycaliper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IntelLabs","download_url":"https://codeload.github.com/IntelLabs/pycaliper/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IntelLabs%2Fpycaliper/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266496467,"owners_count":23938713,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T04:19:12.306Z","updated_at":"2025-07-22T12:34:40.512Z","avatar_url":"https://github.com/IntelLabs.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\n# pycaliper: Specification, Verification, Synthesis for RTL\n\n## Overview\n\nPyCaliper provides infrastructure for verifying and synthesizing specifications for RTL designs based on the Caliper specification language.\n\n\n\n## Requirements and Basic Setup\n\nPyCaliper has been developed and tested with Python 3.11. We recommend using a [virtual-environment](https://github.com/pyenv/pyenv). PyCaliper currently requires access to the Jasper FV tool for utilizing its full featureset. However, we are working towards extending full support with open-source tools.\n\nPyCaliper requires a minimal setup.\n\n0. Clone this repository:\n\n```\ngit clone https://github.com/IntelLabs/pycaliper\n```\n\n1. Install all `pip` packages using the `requirements.txt`\n\n```\npip install -r requirements.txt\n```\nin your venv or\n```\npython3 -m pip install -r requirements.txt\n```\nin a non-virtual-environment setup.\n\n2. Update submodules:\n\n```\ngit submodule update --init --recursive\n```\n\n3. (optional) Make sure all tests pass\n\n```\npython3 -m unittest tests/test.py\n```\n\n\n## Basic Use\n\n\n#### Set up the Jasper FV Backend\n\nLaunch Jasper with the `jasperserver.tcl` server script\n```\ninclude jasperserver.tcl\n```\nand start the Jasper server (on port 8080)\n```\njg_start_server 8080\n```\n\n#### PyCaliper Script and Options\n\nRun the `pycmain.py` script:\n\n```\n $ python3 pycmain.py -h\nusage: pycmain.py [-h] [-m] [--params PARAMS [PARAMS ...]]\n                  [-s SDIR]\n                  {verif,persynth,svagen,alignsynth,fullsynth}\n                  ... path\n\nInvariant verification and synthesis using Jasper.\n\npositional arguments:\n  {verif,persynth,svagen,alignsynth,fullsynth}\n    verif               Verify invariants.\n    persynth            Synthesize invariants.\n    svagen              Generate SVA spec file.\n    alignsynth          Synthesize counter alignment.\n    fullsynth           Synthesize 1t invariants followed\n                        by (cond)equality ones.\n  path                  Path to the JSON config file\n\noptions:\n  -h, --help            show this help message and exit\n  -m, --mock            Run in mock mode (without Jasper access)\n  --params PARAMS [PARAMS ...]\n                        Parameters for the spec module:\n                        (\u003ckey\u003e=\u003cintvalue\u003e)+\n  -s SDIR, --sdir SDIR  Directory to save results to.\n```\n\nFor example,\n\n```\npython3 pycmain.py -m svagen designs/regblock/config.json\n```\n\n#### The `config.json` file\n\nThe `config.json` file identifies configuration paths and options for backends (e.g., Jasper) and the design. It also identifies the specification file. More details on the specification file below.\n\n## PyCaliper Specifications\n\nPyCaliper specifications are Python classes inheriting from the abstract `Module` class. See examples in `specs/regblock.py`. The class declares signals in its `__init__` function. Further the `input`, `output` and `state` functions define input assumptions, output assertions and state invariants respectively.\n\n\n\n\n\n\n## Contributing\n\nThe PyCaliper project welcomes external contributions through pull requests to the main branch.\n\nWe use pre-commit, so before contributing, please ensure that you run pre-commit and make sure all checks pass with\n```\npre-commit install\npre-commit run --all-files\n```\n\nPlease also run the provided tests and add further tests targetting newly contributed features.\n\n## Feedback\n\nWe encourage feedback and suggestions via [GitHub Issues](https://github.com/adwait/pycaliper/issues).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintellabs%2Fpycaliper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fintellabs%2Fpycaliper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintellabs%2Fpycaliper/lists"}