{"id":15425098,"url":"https://github.com/msoeken/cirkit","last_synced_at":"2025-07-11T21:37:48.458Z","repository":{"id":16813793,"uuid":"19572846","full_name":"msoeken/cirkit","owner":"msoeken","description":"A circuit toolkit","archived":false,"fork":false,"pushed_at":"2020-02-23T18:47:46.000Z","size":16610,"stargazers_count":99,"open_issues_count":27,"forks_count":38,"subscribers_count":18,"default_branch":"cirkit3","last_synced_at":"2025-03-28T13:01:35.432Z","etag":null,"topics":["logic-gates","logic-synthesis","quantum-computing","reversible"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/msoeken.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-05-08T12:39:14.000Z","updated_at":"2025-03-26T04:15:35.000Z","dependencies_parsed_at":"2022-07-26T09:02:14.127Z","dependency_job_id":null,"html_url":"https://github.com/msoeken/cirkit","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msoeken%2Fcirkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msoeken%2Fcirkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msoeken%2Fcirkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/msoeken%2Fcirkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/msoeken","download_url":"https://codeload.github.com/msoeken/cirkit/tar.gz/refs/heads/cirkit3","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246307658,"owners_count":20756474,"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","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":["logic-gates","logic-synthesis","quantum-computing","reversible"],"created_at":"2024-10-01T17:49:52.396Z","updated_at":"2025-03-30T10:30:57.294Z","avatar_url":"https://github.com/msoeken.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/msoeken/cirkit.svg?branch=cirkit3)](https://travis-ci.org/msoeken/cirkit)\n[![Build status](https://ci.appveyor.com/api/projects/status/201o4wdh0gmb56et?svg=true)](https://ci.appveyor.com/project/msoeken/cirkit)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n# CirKit (version 3)\n\nCirKit is a logic synthesis and optimization framework.  It is\nimplemented based on various [EPFL logic sythesis libraries](https://github.com/lsils/lstools-showcase).\n\n## Clone\n\nCirKit depends on submodules, so make sure to clone recursively:\n\n```bash\ngit clone --recursive https://github.com/msoeken/cirkit.git\n```\n\nIf you update the repository, then also update the submodules:\n\n```bash\ngit pull origin cirkit3\ngit submodule update --recursive\n```\n\n## Installation (shell interface)\n\n```bash\nmkdir build\ncd build\ncmake ..\nmake cirkit\ncli/cirkit\n```\n\n## Installation (Python library)\n\n```bash\npython3 setup.py install\n```\n\nBut you can also use the `Makefile` to build the Python library in a virtual\nenvironment:\n\n```bash\nmake devbuild\n```\n\n## With custom compiler\n\nCirKit is implemented using C++-17 features and therefore a recent compiler is\nrequired (e.g., GCC ≥ 7.3.0 and Clang ≥ 7.0.0).  If your recent compiler is not\non the `PATH` prefix, extend the `cmake` command as follows:\n\n```bash\ncmake -DCMAKE_CXX_COMPILER=/path/to/c++-compiler ..\n```\n\nand prefix the `python3` command as follows:\n\n```bash\nCC=/path/to/c++-compiler python3 setup.py install\n```\n\n## Example (stand-alone application)\n\n```bash\n$ cirkit\nread_aiger --aig file.aig\nps\ncut_rewrite\nlut_mapping\ncollapse_mapping\nps\nwrite_bench file.bench\n```\n\n## Example (Python interface)\n\n```python\nimport cirkit\ncirkit.read_aiger(aig=True, filename=\"file.aig\")\ncirkit.ps(aig=True)\ncirkit.cut_rewrite(aig=True)\ncirkit.lut_mapping(aig=True)\ncirkit.collapse_mapping(aig=True)\ncirkit.ps(lut=True)\ncirkit.write_bench(lut=True, filename=\"file.bench\")\n```\n\n## RevKit 3.1\n\nRevKit 3.1 is a Python library without a stand-alone interface as in CirKit.\nIt can be found at [the RevKit repository](https://github.com/msoeken/revkit).\n\n## CirKit and RevKit 2.0\n\nThe 2.0 versions of CirKit and RevKit can be found\nin the [develop](https://github.com/msoeken/cirkit/tree/develop/) branch.\n\n\n## EPFL logic sythesis libraries\n\nCirKit and Revkit are based on the [EPFL logic synthesis](https://lsi.epfl.ch/page-138455-en.html) libraries.  The libraries and several examples on how to use and integrate the libraries can be found in the [logic synthesis tool showcase](https://github.com/lsils/lstools-showcase).\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmsoeken%2Fcirkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmsoeken%2Fcirkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmsoeken%2Fcirkit/lists"}