| Name | mnt.bench JSON |
| Version |
0.2.10
JSON |
| download |
| home_page | |
| Summary | MNT Bench - An MNT tool for Benchmarking FCN circuits |
| upload_time | 2024-02-28 13:47:33 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 Simon Hofmann and Robert Wille 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 |
mnt
field-coupled nanocomputing
benchmarking
performance
testing
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://pypi.org/project/mnt.bench/)
[](https://opensource.org/licenses/MIT)
[](https://github.com/cda-tum/mnt-bench/actions/workflows/coverage.yml)
[](https://github.com/cda-tum/mnt-bench/actions/workflows/deploy.yml)
[](https://codecov.io/gh/cda-tum/mnt-bench)
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/cda-tum/mnt-bench/main/img/mnt_light.svg" width="60%">
<img src="https://raw.githubusercontent.com/cda-tum/mnt-bench/main/img/mnt_dark.svg" width="60%">
</picture>
</p>
# MNT Bench: Layout Library for Field-coupled Nanocomputing Circuits
MNT Bench is a field-coupled nanocomputing circuit benchmark suite for multiple gate libraries and clocking schemes.
MNT Bench is part of the Munich Nanotech Toolkit (MNT) developed by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/) and is hosted at [https://www.cda.cit.tum.de/mntbench/](https://www.cda.cit.tum.de/mntbench/).
This documentation explains how to use MNT Bench to filter and download benchmarks.
## Benchmark Selection
So far, the functions from the following benchmark sets are implemented and provided:
1. [Trindade16](https://ieeexplore.ieee.org/document/7724048)
2. [Fontes18](https://ieeexplore.ieee.org/document/8351001)
3. [ISCAS85](https://www.researchgate.net/publication/273775783_A_neutral_netlist_of_10_combinational_benchmark_circuits_and_a_targeted_translator_in_FORTRAN)
4. [EPFL](https://www.epfl.ch/labs/lsi/page-102566-en-html/benchmarks/)
## Gate Libraries
So far, MNT Bench supports the following native gate-sets:
1. [ONE](https://ieeexplore.ieee.org/document/7538997/) (for QCA) gate set: _\[AND, OR, NOT, BUF\]_
2. [Bestagon](https://www.cda.cit.tum.de/files/eda/2022_dac_hexagons_are_the_bestagons.pdf) (for SiDB) gate set: _\[AND, NAND, OR, NOR, XOR, XNOR, NOT, BUF\]_
## Clocking Schemes
Most of the layouts are available for any of the following clocking schemes:
| [2DDWave](https://ieeexplore.ieee.org/document/1717097) | [ESR](https://link.springer.com/content/pdf/10.1007/s10470-020-01760-4.pdf) |
| :-------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------: |
| <img src="https://raw.githubusercontent.com/cda-tum/mnt-bench/main/src/mnt/bench/static/2ddwave.png" alt="2DDWave" height="200"/> | <img src="https://raw.githubusercontent.com/cda-tum/mnt-bench/main/src/mnt/bench/static/esr.png" alt="ESR" height="200"/> |
| [USE](https://ieeexplore.ieee.org/document/7219390) | [RES](https://www.tandfonline.com/doi/abs/10.1080/21681724.2019.1570551) |
| :-----------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------: |
| <img src="https://raw.githubusercontent.com/cda-tum/mnt-bench/main/src/mnt/bench/static/use.png" alt="USE" height="200"/> | <img src="https://raw.githubusercontent.com/cda-tum/mnt-bench/main/src/mnt/bench/static/res.png" alt="RES" height="200"/> |
| [Row](https://ieeexplore.ieee.org/document/573740) |
| :-----------------------------------------------------------------------------------------------------------------------: |
| <img src="https://raw.githubusercontent.com/cda-tum/mnt-bench/main/src/mnt/bench/static/row.png" alt="Row" height="200"/> |
# Repository Structure
- src/mnt/: main source directory
- bench: Directory for the webpage (which can be started locally and is also hosted at
[https://www.cda.cit.tum.de/mntbench/](https://www.cda.cit.tum.de/mntbench/))
- tests: Directory for the tests for MNT Bench
# Repository Usage
There are three ways how to use this benchmark suite:
1. Via the webpage hosted at [https://www.cda.cit.tum.de/mntbench/](https://www.cda.cit.tum.de/mntbench/)
2. Via the pip package `mnt.bench`
3. Directly via this repository
Since the first way is rather self-explanatory, the other two ways are explained in more detail in the following.
## Usage via pip package
MNT Bench is available via [PyPI](https://pypi.org/project/mnt.bench/)
```console
(venv) $ pip install mnt.bench
```
### Locally hosting the MNT Bench Viewer
Additionally, this python package includes the same webserver used for the hosting of the
[MNT Bench webpage](https://www.cda.cit.tum.de/mntbench).
After the `mnt.bench` Python package is installed via
```console
(venv) $ pip install mnt.bench
```
the MNT Bench Viewer can be started from the terminal via
```console
(venv) $ mnt.bench
```
This first searches for the most recent version of the benchmark files on GitHub and offers to download them.
Afterwards, the webserver is started locally.
## Usage directly via this repository
For that, the repository must be cloned and installed:
```
git clone https://github.com/cda-tum/mnt-bench.git
cd mnt-bench
pip install .
```
Afterwards, the package can be used as described [above](#Usage-via-pip-package).
Raw data
{
"_id": null,
"home_page": "",
"name": "mnt.bench",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "MNT,field-coupled nanocomputing,benchmarking,performance,testing",
"author": "",
"author_email": "Simon Hofmann <simon.t.hofmann@tum.de>",
"download_url": "https://files.pythonhosted.org/packages/31/46/3806c211e052f8c92d3b12438b6641f5414377b8c33a6b63f5a87f308d97/mnt.bench-0.2.10.tar.gz",
"platform": null,
"description": "[](https://pypi.org/project/mnt.bench/)\n[](https://opensource.org/licenses/MIT)\n[](https://github.com/cda-tum/mnt-bench/actions/workflows/coverage.yml)\n[](https://github.com/cda-tum/mnt-bench/actions/workflows/deploy.yml)\n[](https://codecov.io/gh/cda-tum/mnt-bench)\n\n<p align=\"center\">\n<picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/cda-tum/mnt-bench/main/img/mnt_light.svg\" width=\"60%\">\n <img src=\"https://raw.githubusercontent.com/cda-tum/mnt-bench/main/img/mnt_dark.svg\" width=\"60%\">\n</picture>\n</p>\n\n# MNT Bench: Layout Library for Field-coupled Nanocomputing Circuits\n\nMNT Bench is a field-coupled nanocomputing circuit benchmark suite for multiple gate libraries and clocking schemes.\n\nMNT Bench is part of the Munich Nanotech Toolkit (MNT) developed by the [Chair for Design Automation](https://www.cda.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/) and is hosted at [https://www.cda.cit.tum.de/mntbench/](https://www.cda.cit.tum.de/mntbench/).\n\nThis documentation explains how to use MNT Bench to filter and download benchmarks.\n\n## Benchmark Selection\n\nSo far, the functions from the following benchmark sets are implemented and provided:\n\n1. [Trindade16](https://ieeexplore.ieee.org/document/7724048)\n2. [Fontes18](https://ieeexplore.ieee.org/document/8351001)\n3. [ISCAS85](https://www.researchgate.net/publication/273775783_A_neutral_netlist_of_10_combinational_benchmark_circuits_and_a_targeted_translator_in_FORTRAN)\n4. [EPFL](https://www.epfl.ch/labs/lsi/page-102566-en-html/benchmarks/)\n\n## Gate Libraries\n\nSo far, MNT Bench supports the following native gate-sets:\n\n1. [ONE](https://ieeexplore.ieee.org/document/7538997/) (for QCA) gate set: _\\[AND, OR, NOT, BUF\\]_\n2. [Bestagon](https://www.cda.cit.tum.de/files/eda/2022_dac_hexagons_are_the_bestagons.pdf) (for SiDB) gate set: _\\[AND, NAND, OR, NOR, XOR, XNOR, NOT, BUF\\]_\n\n## Clocking Schemes\n\nMost of the layouts are available for any of the following clocking schemes:\n\n| [2DDWave](https://ieeexplore.ieee.org/document/1717097) | [ESR](https://link.springer.com/content/pdf/10.1007/s10470-020-01760-4.pdf) |\n| :-------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------: |\n| <img src=\"https://raw.githubusercontent.com/cda-tum/mnt-bench/main/src/mnt/bench/static/2ddwave.png\" alt=\"2DDWave\" height=\"200\"/> | <img src=\"https://raw.githubusercontent.com/cda-tum/mnt-bench/main/src/mnt/bench/static/esr.png\" alt=\"ESR\" height=\"200\"/> |\n\n| [USE](https://ieeexplore.ieee.org/document/7219390) | [RES](https://www.tandfonline.com/doi/abs/10.1080/21681724.2019.1570551) |\n| :-----------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------: |\n| <img src=\"https://raw.githubusercontent.com/cda-tum/mnt-bench/main/src/mnt/bench/static/use.png\" alt=\"USE\" height=\"200\"/> | <img src=\"https://raw.githubusercontent.com/cda-tum/mnt-bench/main/src/mnt/bench/static/res.png\" alt=\"RES\" height=\"200\"/> |\n\n| [Row](https://ieeexplore.ieee.org/document/573740) |\n| :-----------------------------------------------------------------------------------------------------------------------: |\n| <img src=\"https://raw.githubusercontent.com/cda-tum/mnt-bench/main/src/mnt/bench/static/row.png\" alt=\"Row\" height=\"200\"/> |\n\n# Repository Structure\n\n- src/mnt/: main source directory\n - bench: Directory for the webpage (which can be started locally and is also hosted at\n [https://www.cda.cit.tum.de/mntbench/](https://www.cda.cit.tum.de/mntbench/))\n- tests: Directory for the tests for MNT Bench\n\n# Repository Usage\n\nThere are three ways how to use this benchmark suite:\n\n1. Via the webpage hosted at [https://www.cda.cit.tum.de/mntbench/](https://www.cda.cit.tum.de/mntbench/)\n2. Via the pip package `mnt.bench`\n3. Directly via this repository\n\nSince the first way is rather self-explanatory, the other two ways are explained in more detail in the following.\n\n## Usage via pip package\n\nMNT Bench is available via [PyPI](https://pypi.org/project/mnt.bench/)\n\n```console\n(venv) $ pip install mnt.bench\n```\n\n### Locally hosting the MNT Bench Viewer\n\nAdditionally, this python package includes the same webserver used for the hosting of the\n[MNT Bench webpage](https://www.cda.cit.tum.de/mntbench).\n\nAfter the `mnt.bench` Python package is installed via\n\n```console\n(venv) $ pip install mnt.bench\n```\n\nthe MNT Bench Viewer can be started from the terminal via\n\n```console\n(venv) $ mnt.bench\n```\n\nThis first searches for the most recent version of the benchmark files on GitHub and offers to download them.\nAfterwards, the webserver is started locally.\n\n## Usage directly via this repository\n\nFor that, the repository must be cloned and installed:\n\n```\ngit clone https://github.com/cda-tum/mnt-bench.git\ncd mnt-bench\npip install .\n```\n\nAfterwards, the package can be used as described [above](#Usage-via-pip-package).\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Simon Hofmann and Robert Wille 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": "MNT Bench - An MNT tool for Benchmarking FCN circuits",
"version": "0.2.10",
"project_urls": {
"Bug Tracker": "https://github.com/cda-tum/mntbench/issues",
"Discussions": "https://github.com/cda-tum/mntbench/discussions",
"Homepage": "https://github.com/cda-tum/mntbench",
"Research": "https://www.cda.cit.tum.de/research/fcn/"
},
"split_keywords": [
"mnt",
"field-coupled nanocomputing",
"benchmarking",
"performance",
"testing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "31463806c211e052f8c92d3b12438b6641f5414377b8c33a6b63f5a87f308d97",
"md5": "bb4338687320399f526ad16a59b91584",
"sha256": "90f6cb2867327937030da1ea05d43b8de54c44bb5c9cf46f1fb10ec53b12344d"
},
"downloads": -1,
"filename": "mnt.bench-0.2.10.tar.gz",
"has_sig": false,
"md5_digest": "bb4338687320399f526ad16a59b91584",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1039222,
"upload_time": "2024-02-28T13:47:33",
"upload_time_iso_8601": "2024-02-28T13:47:33.287526Z",
"url": "https://files.pythonhosted.org/packages/31/46/3806c211e052f8c92d3b12438b6641f5414377b8c33a6b63f5a87f308d97/mnt.bench-0.2.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-28 13:47:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cda-tum",
"github_project": "mntbench",
"github_not_found": true,
"lcname": "mnt.bench"
}
