ciel 0.21.0.dev0__tar.gz

ciel-0.21.0.dev0/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.3
+Name: ciel
+Version: 0.21.0.dev0
+Summary: An PDK builder/version manager for PDKs in the open_pdks format
+License: Apache-2.0
+Author: Efabless Corporation and Contributors
+Author-email: donn@efabless.com
+Requires-Python: >=3.8
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: click (>=8,<9)
+Requires-Dist: httpx (>=0.22.0,<0.29)
+Requires-Dist: pcpp (>=1.2,<2)
+Requires-Dist: pyyaml (>=5,<7)
+Requires-Dist: rich (>=12,<14)
+Requires-Dist: zstandard (>=0.19.0,<1)
+Project-URL: Repository, https://github.com/donn/cielo
+Description-Content-Type: text/markdown
+
+<h1 align="center">☁️ Cielo</h1>
+<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/cielo/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI Status" />
+    <a href="https://invite.skywater.tools"><img src="https://img.shields.io/badge/Community-Skywater%20PDK%20Slack-ff69b4?logo=slack" alt="Invite to the Skywater PDK Slack"/></a>
+    <a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code Style: Black"/></a>
+</p>
+
+<p align="center">Cielo is a version manager (and builder) for builds of <a href="https://github.com/google/open-source-pdks">Google open-source PDKs</a> using <a href="https://github.com/rtimothyedwards/open_pdks">open_pdks</a>.</p>
+
+# Requirements
+* Python 3.8+ with PIP
+* macOS or GNU/Linux
+
+## macOS
+Get [Homebrew](https://brew.sh) then:
+
+```sh
+brew install python3
+```
+
+## Debian and Ubuntu
+Debian 11+ or Ubuntu 20.04+ is required.
+
+```sh
+sudo apt-get update
+sudo apt-get install python3 python3-pip xz-utils
+```
+
+## RHEL and Derivatives
+RHEL 8+ or compatible operating system required.
+```sh
+sudo yum install -y python3 python3-pip
+```
+
+
+# Installation and Upgrades
+```sh
+# To install (or upgrade)
+python3 -m pip install --user --upgrade --no-cache-dir cielo
+
+# To verify it works
+cielo --version
+```
+
+# About the builds
+In its current inception, cielo supports builds of **sky130** and **gf180mcu** PDKs using [Open_PDKs](https://github.com/efabless/open_pdks), including the following libraries:
+
+|sky130|gf180mcu|
+|-|-|
+|sky130_fd_io|gf180mcu_fd_io|
+|sky130_fd_pr|gf180mcu_fd_pr|
+|sky130_fd_sc_hd|gf180mcu_fd_sc_mcu7t5v0|
+|sky130_fd_sc_hvl|gf180mcu_fd_sc_mcu9t5v0|
+|sky130 sram modules|gf180mcu_fd_ip_sram|
+
+All builds are identified by their **open_pdks** commit hash.
+
+# Usage
+Cielo requires a so-called **PDK Root**. This PDK root can be anywhere on your computer, but by default it's the folder `~/.cielo` in your home directory. If you have the variable `PDK_ROOT` set, cielo will use that instead. You can also manually override both values by supplying the `--pdk-root` commandline argument.
+
+## Listing All Available PDKs
+To list all available pre-built PDKs hosted in this repository, you can just invoke `cielo ls-remote --pdk <PDK>`. If you omit the `--pdk` argument, `sky130` will be used as a default.
+
+```sh
+$ cielo ls-remote --pdk sky130
+Pre-built sky130 PDK versions
+├── 44a43c23c81b45b8e774ae7a84899a5a778b6b0b (2022.08.16) (enabled)
+├── e8294524e5f67c533c5d0c3afa0bcc5b2a5fa066 (2022.07.29) (installed)
+├── 41c0908b47130d5675ff8484255b43f66463a7d6 (2022.04.14) (installed)
+├── 660c6bdc8715dc7b3db95a1ce85392bbf2a2b195 (2022.04.08)
+├── 5890e791e37699239abedfd2a67e55162e25cd94 (2022.04.06)
+├── 8fe7f760ece2bb49b1c310e60243f0558977dae5 (2022.04.06)
+└── 7519dfb04400f224f140749cda44ee7de6f5e095 (2022.02.10)
+
+$ cielo ls-remote --pdk gf180mcu
+Pre-built gf180mcu PDK versions
+└── 120b0bd69c745825a0b8b76f364043a1cd08bb6a (2022.09.22)
+```
+
+It includes a commit hash, which is the `open_pdks` version used to build this particular PDK, the date that this commit was created, and whether you already installed this PDK and/or if it is the currently enabled PDK.
+
+## Listing Installed PDKs
+Typing `cielo ls --pdk <pdk>` in the terminal shows you your PDK Root and the PDKs you currently have installed. Again, if you omit the `--pdk` argument, `sky130` will be used as a default.
+
+```sh
+$ cielo ls --pdk sky130
+/home/test/cielo/sky130/versions
+├── 44a43c23c81b45b8e774ae7a84899a5a778b6b0b (2022.08.16) (enabled)
+├── e8294524e5f67c533c5d0c3afa0bcc5b2a5fa066 (2022.07.29)
+└── 41c0908b47130d5675ff8484255b43f66463a7d6 (2022.04.14)
+```
+
+(If you're not connected to the Internet, the release date of the commit will not be included.)
+
+
+## Downloading and Enabling PDKs
+You can enable a particular sky130 PDK by invoking `cielo enable --pdk <pdk> <open_pdks commit hash>`. This will automatically download that particular version of the PDK, if found, and set it as your currently used PDK.
+
+For example, to activate a build of sky130 using open_pdks `7519dfb04400f224f140749cda44ee7de6f5e095`, you invoke `cielo enable --pdk sky130 7519dfb04400f224f140749cda44ee7de6f5e095`, as shown below:
+
+```sh
+$ cielo enable --pdk sky130 7519dfb04400f224f140749cda44ee7de6f5e095
+Downloading pre-built tarball for 7519dfb04400f224f140749cda44ee7de6f5e095… ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00
+Unpacking…                                                                  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00
+PDK version 7519dfb04400f224f140749cda44ee7de6f5e095 enabled.
+```
+
+What's more is: if you're using a repository with a `tool_metadata.yml` file, such as [OpenLane](https://github.com/The-OpenROAD-Project/OpenLane) or [DFFRAM](https://github.com/Cloud-V/DFFRAM), you can just invoke `cielo enable --pdk sky130` without the commit hash and Cielo will automatically extract the version required by the utility. Once again, if you omit the `--pdk` argument, `sky130` will be used as a default.
+
+## Building PDKs
+For special cases, you may have to build the PDK yourself, which Cielo does support.
+
+You'll need Magic installed and in PATH. You can either do that manually or, if you have [Nix](https://nixos.org), invoke `nix shell github:efabless/openlane2#magic` before building.
+
+You can invoke `cielo build --help` for more options. Be aware, the built PDK won't automatically be enabled and you'll have to `cielo enable` the appropriate version.
+
+# License
+The Apache License, version 2.0. See 'License'.
+
+
+Cielo is based on [Volare](https://github.com/efabless/volare) by Efabless
+Corporation:
+
+```
+Copyright 2022-2025 Efabless Corporation
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```
+

ciel-0.21.0.dev0/Readme.md

@@ -0,0 +1,139 @@
+<h1 align="center">☁️ Cielo</h1>
+<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/cielo/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI Status" />
+    <a href="https://invite.skywater.tools"><img src="https://img.shields.io/badge/Community-Skywater%20PDK%20Slack-ff69b4?logo=slack" alt="Invite to the Skywater PDK Slack"/></a>
+    <a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code Style: Black"/></a>
+</p>
+
+<p align="center">Cielo is a version manager (and builder) for builds of <a href="https://github.com/google/open-source-pdks">Google open-source PDKs</a> using <a href="https://github.com/rtimothyedwards/open_pdks">open_pdks</a>.</p>
+
+# Requirements
+* Python 3.8+ with PIP
+* macOS or GNU/Linux
+
+## macOS
+Get [Homebrew](https://brew.sh) then:
+
+```sh
+brew install python3
+```
+
+## Debian and Ubuntu
+Debian 11+ or Ubuntu 20.04+ is required.
+
+```sh
+sudo apt-get update
+sudo apt-get install python3 python3-pip xz-utils
+```
+
+## RHEL and Derivatives
+RHEL 8+ or compatible operating system required.
+```sh
+sudo yum install -y python3 python3-pip
+```
+
+
+# Installation and Upgrades
+```sh
+# To install (or upgrade)
+python3 -m pip install --user --upgrade --no-cache-dir cielo
+
+# To verify it works
+cielo --version
+```
+
+# About the builds
+In its current inception, cielo supports builds of **sky130** and **gf180mcu** PDKs using [Open_PDKs](https://github.com/efabless/open_pdks), including the following libraries:
+
+|sky130|gf180mcu|
+|-|-|
+|sky130_fd_io|gf180mcu_fd_io|
+|sky130_fd_pr|gf180mcu_fd_pr|
+|sky130_fd_sc_hd|gf180mcu_fd_sc_mcu7t5v0|
+|sky130_fd_sc_hvl|gf180mcu_fd_sc_mcu9t5v0|
+|sky130 sram modules|gf180mcu_fd_ip_sram|
+
+All builds are identified by their **open_pdks** commit hash.
+
+# Usage
+Cielo requires a so-called **PDK Root**. This PDK root can be anywhere on your computer, but by default it's the folder `~/.cielo` in your home directory. If you have the variable `PDK_ROOT` set, cielo will use that instead. You can also manually override both values by supplying the `--pdk-root` commandline argument.
+
+## Listing All Available PDKs
+To list all available pre-built PDKs hosted in this repository, you can just invoke `cielo ls-remote --pdk <PDK>`. If you omit the `--pdk` argument, `sky130` will be used as a default.
+
+```sh
+$ cielo ls-remote --pdk sky130
+Pre-built sky130 PDK versions
+├── 44a43c23c81b45b8e774ae7a84899a5a778b6b0b (2022.08.16) (enabled)
+├── e8294524e5f67c533c5d0c3afa0bcc5b2a5fa066 (2022.07.29) (installed)
+├── 41c0908b47130d5675ff8484255b43f66463a7d6 (2022.04.14) (installed)
+├── 660c6bdc8715dc7b3db95a1ce85392bbf2a2b195 (2022.04.08)
+├── 5890e791e37699239abedfd2a67e55162e25cd94 (2022.04.06)
+├── 8fe7f760ece2bb49b1c310e60243f0558977dae5 (2022.04.06)
+└── 7519dfb04400f224f140749cda44ee7de6f5e095 (2022.02.10)
+
+$ cielo ls-remote --pdk gf180mcu
+Pre-built gf180mcu PDK versions
+└── 120b0bd69c745825a0b8b76f364043a1cd08bb6a (2022.09.22)
+```
+
+It includes a commit hash, which is the `open_pdks` version used to build this particular PDK, the date that this commit was created, and whether you already installed this PDK and/or if it is the currently enabled PDK.
+
+## Listing Installed PDKs
+Typing `cielo ls --pdk <pdk>` in the terminal shows you your PDK Root and the PDKs you currently have installed. Again, if you omit the `--pdk` argument, `sky130` will be used as a default.
+
+```sh
+$ cielo ls --pdk sky130
+/home/test/cielo/sky130/versions
+├── 44a43c23c81b45b8e774ae7a84899a5a778b6b0b (2022.08.16) (enabled)
+├── e8294524e5f67c533c5d0c3afa0bcc5b2a5fa066 (2022.07.29)
+└── 41c0908b47130d5675ff8484255b43f66463a7d6 (2022.04.14)
+```
+
+(If you're not connected to the Internet, the release date of the commit will not be included.)
+
+
+## Downloading and Enabling PDKs
+You can enable a particular sky130 PDK by invoking `cielo enable --pdk <pdk> <open_pdks commit hash>`. This will automatically download that particular version of the PDK, if found, and set it as your currently used PDK.
+
+For example, to activate a build of sky130 using open_pdks `7519dfb04400f224f140749cda44ee7de6f5e095`, you invoke `cielo enable --pdk sky130 7519dfb04400f224f140749cda44ee7de6f5e095`, as shown below:
+
+```sh
+$ cielo enable --pdk sky130 7519dfb04400f224f140749cda44ee7de6f5e095
+Downloading pre-built tarball for 7519dfb04400f224f140749cda44ee7de6f5e095… ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00
+Unpacking…                                                                  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00
+PDK version 7519dfb04400f224f140749cda44ee7de6f5e095 enabled.
+```
+
+What's more is: if you're using a repository with a `tool_metadata.yml` file, such as [OpenLane](https://github.com/The-OpenROAD-Project/OpenLane) or [DFFRAM](https://github.com/Cloud-V/DFFRAM), you can just invoke `cielo enable --pdk sky130` without the commit hash and Cielo will automatically extract the version required by the utility. Once again, if you omit the `--pdk` argument, `sky130` will be used as a default.
+
+## Building PDKs
+For special cases, you may have to build the PDK yourself, which Cielo does support.
+
+You'll need Magic installed and in PATH. You can either do that manually or, if you have [Nix](https://nixos.org), invoke `nix shell github:efabless/openlane2#magic` before building.
+
+You can invoke `cielo build --help` for more options. Be aware, the built PDK won't automatically be enabled and you'll have to `cielo enable` the appropriate version.
+
+# License
+The Apache License, version 2.0. See 'License'.
+
+
+Cielo is based on [Volare](https://github.com/efabless/volare) by Efabless
+Corporation:
+
+```
+Copyright 2022-2025 Efabless Corporation
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```

ciel-0.21.0.dev0/ciel/__init__.py

@@ -0,0 +1,29 @@
+# Copyright 2022-2023 Efabless Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from .manage import (
+    VersionNotFound,
+    enable,
+    get,
+    fetch,
+)
+from .common import (
+    get_cielo_home,
+    Version,
+)
+from .families import Family
+from .github import (
+    GitHubSession,
+)
+from .build import build
+from .__version__ import __version__