<h1 align="center">CACE</h1>
<h2 align="center">Circuit Automatic Characterization Engine</h2>
<p align="center">
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License: Apache 2.0"/></a>
<img src="https://github.com/efabless/cace/actions/workflows/ci.yaml/badge.svg?branch=main" alt="GitHub Actions Status Badge" />
<a href="https://cace.readthedocs.io/"><img src="https://readthedocs.org/projects/cace/badge/?version=latest" alt="Documentation Build Status Badge"/></a>
<a href="https://www.python.org"><img src="https://img.shields.io/badge/Python-3.8-3776AB.svg?style=flat&logo=python&logoColor=white" alt="Python 3.8 or higher" /></a>
<a href="https://github.com/grantjenks/blue"><img src="https://img.shields.io/badge/code%20style-blue-blue.svg" alt="Code Style: blue"/></a>
</p>
<p align="center">
<a href="https://invite.skywater.tools"><img src="https://img.shields.io/badge/Community-Open%20Source%20Silicon%20Slack-ff69b4?logo=slack" alt="Invite to the Open Source Silicon Slack"/></a>
</p>
CACE is a framework for analog and mixed-signal circuits that enables automatic characterization under various conditions and with Monte Carlo and mismatch analysis. After all parameters have been run under the given conditions, CACE will generate a summary showing the circuit performance.
> [!NOTE]
> The latest documentation can be viewed online at [cace.readthedocs.io](https://cace.readthedocs.io/).
## Installation
CACE currently supports two primary methods of installation for it and its dependencies.
Please read the installation instruction in the documentation under ["Installation Overview"](https://cace.readthedocs.io/en/latest/getting_started/index.html).
### Nix (Recommended)
Works for macOS and Linux (x86-64 and aarch64) as well for Windows via WSL2. Recommended, as it is more integrated with your filesystem and overall has less upload and download deltas.
See [Nix-based installation](https://cace.readthedocs.io/en/latest/getting_started/common/nix_installation/index.html) in the docs for more info.
### Python-only Installation
You'll need to bring your own compiled utilities, but otherwise, simply install CACE as follows:
```console
python3 -m pip install --upgrade cace
```
## Usage
To invoke the CLI:
```console
cace [datasheet] [output] [options]
```
To invoke the GUI:
```console
cace-gui [datasheet] [options]
```
For more information about the usage of CACE with either the CLI or the GUI please have a look at ["Usage Guides"](https://cace.readthedocs.io/en/latest/usage_guides/index.html) in the documentation.
## Examples
There exist already numerous designs that use CACE. We have assembled a list of different designs that you can use as reference: [Example Designs](https://cace.readthedocs.io/en/latest/examples/index.html).
## License
[The Apache License, version 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt).
Raw data
{
"_id": null,
"home_page": null,
"name": "cace",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Tim Edwards <tim@efabless.com>, Leo Moser <leo.moser@efabless.com>",
"download_url": "https://files.pythonhosted.org/packages/b8/f5/38255588e21694c88790832083a5d9a560ff25d6c57d4d97d0931fe22194/cace-2.3.11.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">CACE</h1>\n<h2 align=\"center\">Circuit Automatic Characterization Engine</h2>\n<p align=\"center\">\n <a href=\"https://opensource.org/licenses/Apache-2.0\"><img src=\"https://img.shields.io/badge/License-Apache%202.0-blue.svg\" alt=\"License: Apache 2.0\"/></a>\n <img src=\"https://github.com/efabless/cace/actions/workflows/ci.yaml/badge.svg?branch=main\" alt=\"GitHub Actions Status Badge\" />\n <a href=\"https://cace.readthedocs.io/\"><img src=\"https://readthedocs.org/projects/cace/badge/?version=latest\" alt=\"Documentation Build Status Badge\"/></a>\n <a href=\"https://www.python.org\"><img src=\"https://img.shields.io/badge/Python-3.8-3776AB.svg?style=flat&logo=python&logoColor=white\" alt=\"Python 3.8 or higher\" /></a>\n <a href=\"https://github.com/grantjenks/blue\"><img src=\"https://img.shields.io/badge/code%20style-blue-blue.svg\" alt=\"Code Style: blue\"/></a>\n</p>\n<p align=\"center\">\n <a href=\"https://invite.skywater.tools\"><img src=\"https://img.shields.io/badge/Community-Open%20Source%20Silicon%20Slack-ff69b4?logo=slack\" alt=\"Invite to the Open Source Silicon Slack\"/></a>\n</p>\n\nCACE is a framework for analog and mixed-signal circuits that enables automatic characterization under various conditions and with Monte Carlo and mismatch analysis. After all parameters have been run under the given conditions, CACE will generate a summary showing the circuit performance.\n\n> [!NOTE]\n> The latest documentation can be viewed online at [cace.readthedocs.io](https://cace.readthedocs.io/). \n\n## Installation\n\nCACE currently supports two primary methods of installation for it and its dependencies.\n\nPlease read the installation instruction in the documentation under [\"Installation Overview\"](https://cace.readthedocs.io/en/latest/getting_started/index.html).\n\n### Nix (Recommended)\n\nWorks for macOS and Linux (x86-64 and aarch64) as well for Windows via WSL2. Recommended, as it is more integrated with your filesystem and overall has less upload and download deltas.\n\nSee [Nix-based installation](https://cace.readthedocs.io/en/latest/getting_started/common/nix_installation/index.html) in the docs for more info.\n\n### Python-only Installation\n\nYou'll need to bring your own compiled utilities, but otherwise, simply install CACE as follows:\n\n```console\n\tpython3 -m pip install --upgrade cace\n```\n\n## Usage\n\nTo invoke the CLI:\n\n```console\ncace [datasheet] [output] [options]\n```\n\nTo invoke the GUI:\n\n```console\ncace-gui [datasheet] [options]\n```\n\nFor more information about the usage of CACE with either the CLI or the GUI please have a look at [\"Usage Guides\"](https://cace.readthedocs.io/en/latest/usage_guides/index.html) in the documentation.\n\n## Examples\n\nThere exist already numerous designs that use CACE. We have assembled a list of different designs that you can use as reference: [Example Designs](https://cace.readthedocs.io/en/latest/examples/index.html). \n\n## License\n\n[The Apache License, version 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt).\n",
"bugtrack_url": null,
"license": null,
"summary": "Circuit Automatic Characterization Engine",
"version": "2.3.11",
"project_urls": {
"Homepage": "https://github.com/efabless/cace",
"Issues": "https://github.com/efabless/cace/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ac5dbf0a6bd8ed811e2a63d76027d57945f4b567c0f1dab2cafda999d7fd5245",
"md5": "110384bdb661e94344297603a18c0358",
"sha256": "a941e1b47570782df6077e5320b9ed085805dabe381a713ebd72f596916fc080"
},
"downloads": -1,
"filename": "cace-2.3.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "110384bdb661e94344297603a18c0358",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 163264,
"upload_time": "2024-07-10T12:22:31",
"upload_time_iso_8601": "2024-07-10T12:22:31.378479Z",
"url": "https://files.pythonhosted.org/packages/ac/5d/bf0a6bd8ed811e2a63d76027d57945f4b567c0f1dab2cafda999d7fd5245/cace-2.3.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b8f538255588e21694c88790832083a5d9a560ff25d6c57d4d97d0931fe22194",
"md5": "685ce81ea9f8c06521d9029c8c5f6a08",
"sha256": "0019334df03f3a2504566126c11a19c2b8935621ad2c686ee5f8eed1d9964b4d"
},
"downloads": -1,
"filename": "cace-2.3.11.tar.gz",
"has_sig": false,
"md5_digest": "685ce81ea9f8c06521d9029c8c5f6a08",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 2513521,
"upload_time": "2024-07-10T12:22:34",
"upload_time_iso_8601": "2024-07-10T12:22:34.395168Z",
"url": "https://files.pythonhosted.org/packages/b8/f5/38255588e21694c88790832083a5d9a560ff25d6c57d4d97d0931fe22194/cace-2.3.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-10 12:22:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "efabless",
"github_project": "cace",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "matplotlib",
"specs": [
[
">=",
"3.6.0"
]
]
},
{
"name": "numpy",
"specs": [
[
">=",
"1.20.0"
]
]
},
{
"name": "pillow",
"specs": [
[
">=",
"10.1.0"
]
]
},
{
"name": "volare",
"specs": [
[
">=",
"0.16.0"
]
]
},
{
"name": "rich",
"specs": [
[
"<",
"14"
],
[
">=",
"13"
]
]
}
],
"lcname": "cace"
}
JSON
