cace


Namecace JSON
Version 2.3.5 PyPI version JSON
download
home_pageNone
SummaryCircuit Automatic Characterization Engine
upload_time2024-06-16 07:46:38
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <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 set of python scripts that take an input file in the
CACE 4.0 format and uses the information found there in combination with CACE-compatible testbenches and analysis scripts to characterize a circuit and to produce a datasheet showing the circuit performance.

## Installation

You'll need the following:

- Python 3.8 or higher with PIP and Tkinter

CACE can be installed directly from PyPI:

	$ python3 -m pip install --upgrade cace
Prerequisite design tools:

- xschem:  [https://github.com/stefanschippers/xschem](https://github.com/stefanschippers/xschem)
- ngspice: git://git.code.sf.net/p/ngspice/ngspice
- magic:	 [https://github.com/RTimothyEdwards/magic](https://github.com/RTimothyEdwards/magic)

Some of the measurements require:

- octave: [https://octave.org/](https://octave.org/)

## Usage

If installed as Python package, CACE can be started from the command line using:

```
$ cace
```

Or to start the GUI:

```
$ cace-gui
```

Information on how to use CACE can be found in the documentation at [cace.readthedocs.io](https://cace.readthedocs.io/). 

## Development

### Dependencies

> [!IMPORTANT]
> You may need to set up a Python [virtual environment](https://docs.python.org/3/library/venv.html).

To install the dependencies for CACE, run:

	$ make dependencies

### Python Package

To build the Python package, run:

```
$ make build
```

To install the package, run:

```
$ make install
```

To install the package in editable mode, run:

```
$ make editable
```

### Documentation

To build the documentation, run:

```
$ make docs
```

To host the docs, run:

```
$ make host-docs
```

To automatically refresh the docs upon changes, run:

```
$ make auto-docs
```

> [!NOTE]
> The latest documentation can be viewed online at [cace.readthedocs.io](https://cace.readthedocs.io/). 

## Examples

The following repositories contain example circuit designs, each having a "cace/" subdirectory with a specification input file in the format described below, and a set of testbench schematics which are used by CACE to measure all specified electrical and physical parameters, generate results, and analyze them to determine circuit performance over corners.

> [!NOTE]
> Example repositories, like CACE itself, are currently a work in progress.

All repositories are rooted at: [https://github.com/RTimothyEdwards/](https://github.com/RTimothyEdwards/).

Example circuit repositories:

- [sky130_ef_ip__instramp](https://github.com/RTimothyEdwards/sky130_ef_ip__instramp)		Instrumentation amplifier
- [sky130_ef_ip__rdac3v_8bit](https://github.com/RTimothyEdwards/sky130_ef_ip__rdac3v_8bit)	8-bit resistor ladder DAC
- sky130_ef_ip__samplehold	sample-and-hold circuit
- sky130_ef_ip__driveramp		Rail-to-rail driver amplifier
- sky130_ef_ip__ccomp3v		Rail-to-rail continuous comparator
- sky130_ef_ip__rc_osc_500k	R-C oscillator, 500kHz nominal output
- sky130_ef_ip__xtal_osc_16M	Crystal oscillator, 4 to 15MHz
- sky130_ef_ip__xtal_osc_32k	Crystal oscillator, 32kHz

Each of these repositories contains a circuit designed with the SkyWater sky130 process open PDK, and contains schematics, layout, and CACE characterization.

> [!NOTE]
> These repositories are a work in progress, and may not exist yet or may not have a characterization setup for CACE.

            

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/a2/52/97e59d8c71f6ff364710c9d5972fff0c03fbbcb1c6b410502ac6b83255ce/cace-2.3.5.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 set of python scripts that take an input file in the\nCACE 4.0 format and uses the information found there in combination with CACE-compatible testbenches and analysis scripts to characterize a circuit and to produce a datasheet showing the circuit performance.\n\n## Installation\n\nYou'll need the following:\n\n- Python 3.8 or higher with PIP and Tkinter\n\nCACE can be installed directly from PyPI:\n\n\t$ python3 -m pip install --upgrade cace\nPrerequisite design tools:\n\n- xschem:  [https://github.com/stefanschippers/xschem](https://github.com/stefanschippers/xschem)\n- ngspice: git://git.code.sf.net/p/ngspice/ngspice\n- magic:\t [https://github.com/RTimothyEdwards/magic](https://github.com/RTimothyEdwards/magic)\n\nSome of the measurements require:\n\n- octave: [https://octave.org/](https://octave.org/)\n\n## Usage\n\nIf installed as Python package, CACE can be started from the command line using:\n\n```\n$ cace\n```\n\nOr to start the GUI:\n\n```\n$ cace-gui\n```\n\nInformation on how to use CACE can be found in the documentation at [cace.readthedocs.io](https://cace.readthedocs.io/). \n\n## Development\n\n### Dependencies\n\n> [!IMPORTANT]\n> You may need to set up a Python [virtual environment](https://docs.python.org/3/library/venv.html).\n\nTo install the dependencies for CACE, run:\n\n\t$ make dependencies\n\n### Python Package\n\nTo build the Python package, run:\n\n```\n$ make build\n```\n\nTo install the package, run:\n\n```\n$ make install\n```\n\nTo install the package in editable mode, run:\n\n```\n$ make editable\n```\n\n### Documentation\n\nTo build the documentation, run:\n\n```\n$ make docs\n```\n\nTo host the docs, run:\n\n```\n$ make host-docs\n```\n\nTo automatically refresh the docs upon changes, run:\n\n```\n$ make auto-docs\n```\n\n> [!NOTE]\n> The latest documentation can be viewed online at [cace.readthedocs.io](https://cace.readthedocs.io/). \n\n## Examples\n\nThe following repositories contain example circuit designs, each having a \"cace/\" subdirectory with a specification input file in the format described below, and a set of testbench schematics which are used by CACE to measure all specified electrical and physical parameters, generate results, and analyze them to determine circuit performance over corners.\n\n> [!NOTE]\n> Example repositories, like CACE itself, are currently a work in progress.\n\nAll repositories are rooted at: [https://github.com/RTimothyEdwards/](https://github.com/RTimothyEdwards/).\n\nExample circuit repositories:\n\n- [sky130_ef_ip__instramp](https://github.com/RTimothyEdwards/sky130_ef_ip__instramp)\t\tInstrumentation amplifier\n- [sky130_ef_ip__rdac3v_8bit](https://github.com/RTimothyEdwards/sky130_ef_ip__rdac3v_8bit)\t8-bit resistor ladder DAC\n- sky130_ef_ip__samplehold\tsample-and-hold circuit\n- sky130_ef_ip__driveramp\t\tRail-to-rail driver amplifier\n- sky130_ef_ip__ccomp3v\t\tRail-to-rail continuous comparator\n- sky130_ef_ip__rc_osc_500k\tR-C oscillator, 500kHz nominal output\n- sky130_ef_ip__xtal_osc_16M\tCrystal oscillator, 4 to 15MHz\n- sky130_ef_ip__xtal_osc_32k\tCrystal oscillator, 32kHz\n\nEach of these repositories contains a circuit designed with the SkyWater sky130 process open PDK, and contains schematics, layout, and CACE characterization.\n\n> [!NOTE]\n> These repositories are a work in progress, and may not exist yet or may not have a characterization setup for CACE.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Circuit Automatic Characterization Engine",
    "version": "2.3.5",
    "project_urls": {
        "Homepage": "https://github.com/efabless/cace",
        "Issues": "https://github.com/efabless/cace/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5f500b00248613781ecf4a87a65f083abb24f03606e1aa6db84192f3b84a954f",
                "md5": "c5f7b695d8b2b07bb5f490f3a0da18c8",
                "sha256": "e8043cae92755ea9a2c3372872e4024867a1bca09ac2e5108242b479f967cd84"
            },
            "downloads": -1,
            "filename": "cace-2.3.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c5f7b695d8b2b07bb5f490f3a0da18c8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 162212,
            "upload_time": "2024-06-16T07:46:36",
            "upload_time_iso_8601": "2024-06-16T07:46:36.581602Z",
            "url": "https://files.pythonhosted.org/packages/5f/50/0b00248613781ecf4a87a65f083abb24f03606e1aa6db84192f3b84a954f/cace-2.3.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a25297e59d8c71f6ff364710c9d5972fff0c03fbbcb1c6b410502ac6b83255ce",
                "md5": "07631d6e7658a7b4bc9d60fb1096d32d",
                "sha256": "dd62c58a6d25aed379bebac83c0f7db28a2fe47d71e60c344ff2a8c8fc9646d8"
            },
            "downloads": -1,
            "filename": "cace-2.3.5.tar.gz",
            "has_sig": false,
            "md5_digest": "07631d6e7658a7b4bc9d60fb1096d32d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 333943,
            "upload_time": "2024-06-16T07:46:38",
            "upload_time_iso_8601": "2024-06-16T07:46:38.404565Z",
            "url": "https://files.pythonhosted.org/packages/a2/52/97e59d8c71f6ff364710c9d5972fff0c03fbbcb1c6b410502ac6b83255ce/cace-2.3.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-16 07:46:38",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "efabless",
    "github_project": "cace",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "cace"
}
        
Elapsed time: 0.27750s