# Softworks
[](https://github.com/cascode-labs/softworks/releases/latest)
[](https://anaconda.org/conda-forge/softworks)
[](https://pypi.org/project/softworks/)
[](https://github.com/cascode-labs/softworks/issues)
[](https://choosealicense.com/licenses/mit/)
Software and documentation view types in the Cadence Virtuoso IC design environment.
## Overview
Softworks defines cell view types for documentation and software views in
the Cadence Virtuoso integrated circuit design environment. It supports
automated design of circuit IP and makes it accessible to the average designer.
It is an open-source library written in SKILL++ and built on the
[Virtue SKILL and Python design automation framework](http://www.cascode-labs.org/virtue/).
The software views make automated design more accessible to both the average
IC design engineer and those with software experience. It allows the
tool interface to be simplified to a simple template run script where the
inputs are defined in a dictionary and passed to an API function.
The documentation views support the development of IP libraries by attaching
the documentation directly to the cells. This makes it easier to communicate
the performance of the cell and keep track of it.
## Custom Cell Views
| View Type | Extensions | Editors | Description |
| ----------- | -------------- | ---------------- | --------------------------- |
| pdf | *.pdf | xpdf | A pdf Document |
| ppt | *.pptx | open office | A power point presentation |
| Excel | *.xlsx \*.xlsm | open office | A spreadsheet |
| html | *.html | firefox | A web page |
| module | *.py \*.pyc | VS Code, gedit | A Python module |
| notebook | *.ipynb | VS Code, gedit | A Python Jupyter notebook |
| markdown | *.md | VS Code, gedit | A markdown document. VS code enables editing and rendering |
| yaml | *.yml | VS Code, gedit | A yaml data file |
| skill | *.il | Skill IDE, gedit | A SKILL code file |
| skillpp | *.ils | Skill IDE, gedit | A SKILL++ code file |
## Creating a New View
A new blank document view can be created by using the standard "File -> New -> Cell View..." selection.
Then some view types will create a new cellview directly based on a template file while the
documentation views will open a GUI. This GUI has the option to either create the new cell view from a template or
import an existing file to the cell view.
## License
Softworks is MIT licensed, see the [LICENSE file](LICENSE) for more details.
## Installation
1. Make sure Virtuoso IC6.1.8 (though it may work with other IC6 versions)
is installed
2. Make sure the following programs are installed to support editing the
associated views:
- Visual Studio Code / vscode
```which code```
- Libre office (pptx, xlsx)
```which libre```
- xpdf (PDF)
```which xpdf```
- firefox (HTML)
```which firefox```
3. Install by following
[Virtue framework installation instructions](https://www.cascode-labs.org/virtue/overview/install.html#).
4. Install Softworks using the same method as Virtue. If skyworks wasn't a
part of your initial environment definition file when creating the environment,
then you can install them after the fact:
Conda:
```bash
conda activate virtuoso # or your environment's name
conda install softworks
```
Pip:
```bash
pip install softworks
```
Raw data
{
"_id": null,
"home_page": "",
"name": "softworks",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "Curtis Mayberry <Curtisma3@gmail.com>",
"keywords": "circuit design,design automation,Cadence,virtuoso,SKILL,Python",
"author": "",
"author_email": "Curtis Mayberry <Curtisma3@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/49/51/ecf4e47ce46a4a91c0fbc1a50760e7d2cf52c71090a85ccdaef36737e4dd/softworks-0.4.0.tar.gz",
"platform": null,
"description": "# Softworks\n\n[](https://github.com/cascode-labs/softworks/releases/latest)\n[](https://anaconda.org/conda-forge/softworks)\n[](https://pypi.org/project/softworks/)\n[](https://github.com/cascode-labs/softworks/issues)\n[](https://choosealicense.com/licenses/mit/)\n\nSoftware and documentation view types in the Cadence Virtuoso IC design environment.\n\n## Overview\n\nSoftworks defines cell view types for documentation and software views in\nthe Cadence Virtuoso integrated circuit design environment. It supports\nautomated design of circuit IP and makes it accessible to the average designer. \n\nIt is an open-source library written in SKILL++ and built on the\n[Virtue SKILL and Python design automation framework](http://www.cascode-labs.org/virtue/).\n\n\n\nThe software views make automated design more accessible to both the average\nIC design engineer and those with software experience. It allows the\ntool interface to be simplified to a simple template run script where the\ninputs are defined in a dictionary and passed to an API function.\n\nThe documentation views support the development of IP libraries by attaching\nthe documentation directly to the cells. This makes it easier to communicate\nthe performance of the cell and keep track of it.\n\n## Custom Cell Views\n\n| View Type | Extensions | Editors | Description |\n| ----------- | -------------- | ---------------- | --------------------------- |\n| pdf | *.pdf | xpdf | A pdf Document |\n| ppt | *.pptx | open office | A power point presentation |\n| Excel | *.xlsx \\*.xlsm | open office | A spreadsheet |\n| html | *.html | firefox | A web page |\n| module | *.py \\*.pyc | VS Code, gedit | A Python module |\n| notebook | *.ipynb | VS Code, gedit | A Python Jupyter notebook |\n| markdown | *.md | VS Code, gedit | A markdown document. VS code enables editing and rendering |\n| yaml | *.yml | VS Code, gedit | A yaml data file |\n| skill | *.il | Skill IDE, gedit | A SKILL code file |\n| skillpp | *.ils | Skill IDE, gedit | A SKILL++ code file |\n\n## Creating a New View\n\nA new blank document view can be created by using the standard \"File -> New -> Cell View...\" selection.\nThen some view types will create a new cellview directly based on a template file while the\ndocumentation views will open a GUI. This GUI has the option to either create the new cell view from a template or\nimport an existing file to the cell view.\n\n\n\n## License\n\nSoftworks is MIT licensed, see the [LICENSE file](LICENSE) for more details.\n\n## Installation\n\n1. Make sure Virtuoso IC6.1.8 (though it may work with other IC6 versions)\n is installed\n2. Make sure the following programs are installed to support editing the\n associated views:\n - Visual Studio Code / vscode\n ```which code```\n - Libre office (pptx, xlsx)\n ```which libre```\n - xpdf (PDF)\n ```which xpdf```\n - firefox (HTML)\n ```which firefox```\n\n3. Install by following\n [Virtue framework installation instructions](https://www.cascode-labs.org/virtue/overview/install.html#). \n\n4. Install Softworks using the same method as Virtue. If skyworks wasn't a\npart of your initial environment definition file when creating the environment,\nthen you can install them after the fact:\n\nConda:\n\n```bash\nconda activate virtuoso # or your environment's name\nconda install softworks\n```\n\nPip:\n\n```bash\npip install softworks\n```\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Software and documentation view types in Cadence Virtuoso",
"version": "0.4.0",
"project_urls": {
"Documentation": "http://www.cascode-labs.org/softworks/",
"Home": "http://www.cascode-labs.org/softworks/",
"Source": "https://github.com/cascode-labs/softworks"
},
"split_keywords": [
"circuit design",
"design automation",
"cadence",
"virtuoso",
"skill",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ab9f8e7408da3f8bd0822af75f91ff4544c513fbe8265e143dfd6777e181b3b2",
"md5": "3cb1f444af7d3205946966c512e29d26",
"sha256": "c9f6d6cb3559a891ad83e166659911546e0cd5fbbcd0e27c90cf150479ae7838"
},
"downloads": -1,
"filename": "softworks-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3cb1f444af7d3205946966c512e29d26",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 117886,
"upload_time": "2023-12-02T00:33:16",
"upload_time_iso_8601": "2023-12-02T00:33:16.173718Z",
"url": "https://files.pythonhosted.org/packages/ab/9f/8e7408da3f8bd0822af75f91ff4544c513fbe8265e143dfd6777e181b3b2/softworks-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4951ecf4e47ce46a4a91c0fbc1a50760e7d2cf52c71090a85ccdaef36737e4dd",
"md5": "4b1caac8b9804c9a8dee28aa1cfd723f",
"sha256": "fceb70ca81e23ddef24e8b621c5b1795ce945087aa52b3542e35ec075cae0fe0"
},
"downloads": -1,
"filename": "softworks-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "4b1caac8b9804c9a8dee28aa1cfd723f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 2397474,
"upload_time": "2023-12-02T00:33:18",
"upload_time_iso_8601": "2023-12-02T00:33:18.216533Z",
"url": "https://files.pythonhosted.org/packages/49/51/ecf4e47ce46a4a91c0fbc1a50760e7d2cf52c71090a85ccdaef36737e4dd/softworks-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-02 00:33:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cascode-labs",
"github_project": "softworks",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "softworks"
}
JSON
