ciel 0.21.0.dev1__tar.gz → 2.0.0__tar.gz

{ciel-0.21.0.dev1 → ciel-2.0.0}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: ciel
-Version: 0.21.0.dev1
+Version: 2.0.0
 Summary: An PDK builder/version manager for PDKs in the open_pdks format
 Home-page: https://github.com/fossi-foundation/ciel
 License: Apache-2.0
-Author: Efabless Corporation and Contributors
-Author-email: donn@efabless.com
+Author: Mohamed Gaber
+Author-email: me@donn.website
 Requires-Python: >=3.8
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
@@ -75,11 +75,11 @@ ciel --version
 # About the builds
 In its current inception, ciel supports builds of **sky130** and **gf180mcu** PDKs using [Open_PDKs](https://github.com/efabless/open_pdks), including the following libraries:
 
-|sky130|gf180mcu|ihp_sg13g2|
+|sky130|gf180mcu|ihp-sg13g2|
 |-|-|-|
 |sky130_fd_io|gf180mcu_fd_io|sg13g2_io|
 |sky130_fd_pr|gf180mcu_fd_pr|sg13g2_pr|
-|sky130_fd_pr_reram$|gf180mcu_fd_pr|sg13g2_pr|
+|sky130_fd_pr_reram|gf180mcu_fd_pr|sg13g2_pr|
 |sky130_fd_sc_hd|gf180mcu_fd_sc_mcu7t5v0|sg13g2_stdcell|
 |sky130_ml_xx_hd|gf180mcu_fd_sc_mcu9t5v0|-|
 |sky130_fd_sc_hvl|gf180mcu_osu_sc_gp9t3v3|-|
@@ -89,16 +89,16 @@ In its current inception, ciel supports builds of **sky130** and **gf180mcu** PD
 |sky130_fd_sc_hs|-|-|
 |sky130_sram_macros|gf180mcu_fd_ip_sram|sg13g2_sram|
 
-Builds for sky130 and gf180mcu are identified by their [**open_pdks**](https://github.com/rtimothyedwards/open_pdks) commit hashes. Builds for ihp_sg13g2 are identified by their [**IHP-Open-PDK**](https://github.com/ihp-gmbh/ihp-open-pdk) commit hashes.
+Builds for sky130 and gf180mcu are identified by their [**open_pdks**](https://github.com/rtimothyedwards/open_pdks) commit hashes. Builds for ihp-sg13g2 are identified by their [**IHP-Open-PDK**](https://github.com/ihp-gmbh/ihp-open-pdk) commit hashes.
 
 # Usage
 Ciel requires a so-called **PDK Root**. This PDK root can be anywhere on your computer, but by default it's the folder `~/.ciel` in your home directory. If you have the variable `PDK_ROOT` set, ciel 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 `ciel ls-remote --pdk <PDK>`. If you omit the `--pdk` argument, `sky130` will be used as a default.
+To list all available pre-built PDK families hosted in this repository, you can just invoke `ciel ls-remote --pdk-family <pdk-family>`.
 
 ```sh
-$ ciel ls-remote --pdk sky130
+$ ciel ls-remote --pdk-family sky130
 Pre-built sky130 PDK versions
 ├── 44a43c23c81b45b8e774ae7a84899a5a778b6b0b (2022.08.16) (enabled)
 ├── e8294524e5f67c533c5d0c3afa0bcc5b2a5fa066 (2022.07.29) (installed)
@@ -108,7 +108,7 @@ Pre-built sky130 PDK versions
 ├── 8fe7f760ece2bb49b1c310e60243f0558977dae5 (2022.04.06)
 └── 7519dfb04400f224f140749cda44ee7de6f5e095 (2022.02.10)
 
-$ ciel ls-remote --pdk gf180mcu
+$ ciel ls-remote --pdk-family gf180mcu
 Pre-built gf180mcu PDK versions
 └── 120b0bd69c745825a0b8b76f364043a1cd08bb6a (2022.09.22)
 ```
@@ -116,10 +116,10 @@ Pre-built gf180mcu PDK versions
 It includes a hash of the commit of the relevant repo used for that particular build, 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 `ciel 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.
+Typing `ciel ls --pdk-family <pdk-family>` in the terminal shows you your PDK Root and the PDKs you currently have installed.
 
 ```sh
-$ ciel ls --pdk sky130
+$ ciel ls --pdk-family sky130
 /home/test/ciel/sky130/versions
 ├── 44a43c23c81b45b8e774ae7a84899a5a778b6b0b (2022.08.16) (enabled)
 ├── e8294524e5f67c533c5d0c3afa0bcc5b2a5fa066 (2022.07.29)
@@ -130,12 +130,12 @@ $ ciel ls --pdk sky130
 
 
 ## Downloading and Enabling PDKs
-You can enable a particular sky130 PDK by invoking `ciel 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.
+You can enable a particular sky130 PDK by invoking `ciel enable --pdk-family <pdk-family> <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 `ciel enable --pdk sky130 7519dfb04400f224f140749cda44ee7de6f5e095`, as shown below:
+For example, to activate a build of sky130 using open_pdks `7519dfb04400f224f140749cda44ee7de6f5e095`, you invoke `ciel enable --pdk-family sky130 7519dfb04400f224f140749cda44ee7de6f5e095`, as shown below:
 
 ```sh
-$ ciel enable --pdk sky130 7519dfb04400f224f140749cda44ee7de6f5e095
+$ ciel enable --pdk-family sky130 7519dfb04400f224f140749cda44ee7de6f5e095
 Downloading pre-built tarball for 7519dfb04400f224f140749cda44ee7de6f5e095… ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00
 Unpacking…                                                                  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00
 PDK version 7519dfb04400f224f140749cda44ee7de6f5e095 enabled.

{ciel-0.21.0.dev1 → ciel-2.0.0}/Readme.md

@@ -46,11 +46,11 @@ ciel --version
 # About the builds
 In its current inception, ciel supports builds of **sky130** and **gf180mcu** PDKs using [Open_PDKs](https://github.com/efabless/open_pdks), including the following libraries:
 
-|sky130|gf180mcu|ihp_sg13g2|
+|sky130|gf180mcu|ihp-sg13g2|
 |-|-|-|
 |sky130_fd_io|gf180mcu_fd_io|sg13g2_io|
 |sky130_fd_pr|gf180mcu_fd_pr|sg13g2_pr|
-|sky130_fd_pr_reram$|gf180mcu_fd_pr|sg13g2_pr|
+|sky130_fd_pr_reram|gf180mcu_fd_pr|sg13g2_pr|
 |sky130_fd_sc_hd|gf180mcu_fd_sc_mcu7t5v0|sg13g2_stdcell|
 |sky130_ml_xx_hd|gf180mcu_fd_sc_mcu9t5v0|-|
 |sky130_fd_sc_hvl|gf180mcu_osu_sc_gp9t3v3|-|
@@ -60,16 +60,16 @@ In its current inception, ciel supports builds of **sky130** and **gf180mcu** PD
 |sky130_fd_sc_hs|-|-|
 |sky130_sram_macros|gf180mcu_fd_ip_sram|sg13g2_sram|
 
-Builds for sky130 and gf180mcu are identified by their [**open_pdks**](https://github.com/rtimothyedwards/open_pdks) commit hashes. Builds for ihp_sg13g2 are identified by their [**IHP-Open-PDK**](https://github.com/ihp-gmbh/ihp-open-pdk) commit hashes.
+Builds for sky130 and gf180mcu are identified by their [**open_pdks**](https://github.com/rtimothyedwards/open_pdks) commit hashes. Builds for ihp-sg13g2 are identified by their [**IHP-Open-PDK**](https://github.com/ihp-gmbh/ihp-open-pdk) commit hashes.
 
 # Usage
 Ciel requires a so-called **PDK Root**. This PDK root can be anywhere on your computer, but by default it's the folder `~/.ciel` in your home directory. If you have the variable `PDK_ROOT` set, ciel 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 `ciel ls-remote --pdk <PDK>`. If you omit the `--pdk` argument, `sky130` will be used as a default.
+To list all available pre-built PDK families hosted in this repository, you can just invoke `ciel ls-remote --pdk-family <pdk-family>`.
 
 ```sh
-$ ciel ls-remote --pdk sky130
+$ ciel ls-remote --pdk-family sky130
 Pre-built sky130 PDK versions
 ├── 44a43c23c81b45b8e774ae7a84899a5a778b6b0b (2022.08.16) (enabled)
 ├── e8294524e5f67c533c5d0c3afa0bcc5b2a5fa066 (2022.07.29) (installed)
@@ -79,7 +79,7 @@ Pre-built sky130 PDK versions
 ├── 8fe7f760ece2bb49b1c310e60243f0558977dae5 (2022.04.06)
 └── 7519dfb04400f224f140749cda44ee7de6f5e095 (2022.02.10)
 
-$ ciel ls-remote --pdk gf180mcu
+$ ciel ls-remote --pdk-family gf180mcu
 Pre-built gf180mcu PDK versions
 └── 120b0bd69c745825a0b8b76f364043a1cd08bb6a (2022.09.22)
 ```
@@ -87,10 +87,10 @@ Pre-built gf180mcu PDK versions
 It includes a hash of the commit of the relevant repo used for that particular build, 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 `ciel 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.
+Typing `ciel ls --pdk-family <pdk-family>` in the terminal shows you your PDK Root and the PDKs you currently have installed.
 
 ```sh
-$ ciel ls --pdk sky130
+$ ciel ls --pdk-family sky130
 /home/test/ciel/sky130/versions
 ├── 44a43c23c81b45b8e774ae7a84899a5a778b6b0b (2022.08.16) (enabled)
 ├── e8294524e5f67c533c5d0c3afa0bcc5b2a5fa066 (2022.07.29)
@@ -101,12 +101,12 @@ $ ciel ls --pdk sky130
 
 
 ## Downloading and Enabling PDKs
-You can enable a particular sky130 PDK by invoking `ciel 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.
+You can enable a particular sky130 PDK by invoking `ciel enable --pdk-family <pdk-family> <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 `ciel enable --pdk sky130 7519dfb04400f224f140749cda44ee7de6f5e095`, as shown below:
+For example, to activate a build of sky130 using open_pdks `7519dfb04400f224f140749cda44ee7de6f5e095`, you invoke `ciel enable --pdk-family sky130 7519dfb04400f224f140749cda44ee7de6f5e095`, as shown below:
 
 ```sh
-$ ciel enable --pdk sky130 7519dfb04400f224f140749cda44ee7de6f5e095
+$ ciel enable --pdk-family sky130 7519dfb04400f224f140749cda44ee7de6f5e095
 Downloading pre-built tarball for 7519dfb04400f224f140749cda44ee7de6f5e095… ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00
 Unpacking…                                                                  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00
 PDK version 7519dfb04400f224f140749cda44ee7de6f5e095 enabled.

{ciel-0.21.0.dev1 → ciel-2.0.0}/ciel/__main__.py

@@ -1,3 +1,7 @@
+# Copyright 2025 The American University in Cairo
+#
+# Adapted from the Volare project
+#
 # Copyright 2022-2023 Efabless Corporation
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -25,11 +29,7 @@ from .common import (
     resolve_version,
 )
 from .click_common import (
-    opt,
-    opt_build,
-    opt_push,
     opt_pdk_root,
-    opt_token,
 )
 from .manage import (
     print_installed_list,
@@ -41,11 +41,13 @@ from .build import (
     build_cmd,
     push_cmd,
 )
+from .github import opt_github_token
+from .source import opt_data_source
 
 
 @click.command("output")
 @opt_pdk_root
-def output_cmd(pdk_root, pdk):
+def output_cmd(pdk_root, pdk_family):
     """Outputs the currently enabled PDK version.
 
     If not outputting to a tty, the output is either the version string
@@ -53,14 +55,16 @@ def output_cmd(pdk_root, pdk):
     exit code of 1.
     """
 
-    version = Version.get_current(pdk_root, pdk)
+    version = Version.get_current(pdk_root, pdk_family)
     if sys.stdout.isatty():
         if version is None:
-            print(f"No version of the PDK {pdk} is currently enabled at {pdk_root}.")
+            print(
+                f"No version of the PDK {pdk_family} is currently enabled at {pdk_root}."
+            )
             print("Invoke ciel --help for assistance installing and enabling versions.")
             exit(1)
         else:
-            print(f"Installed: {pdk} v{version.name}")
+            print(f"Installed: {pdk_family} v{version.name}")
             print("Invoke ciel --help for assistance installing and enabling versions.")
     else:
         if version is None:
@@ -78,9 +82,10 @@ def output_cmd(pdk_root, pdk):
     expose_value=False,
     prompt="Are you sure? This will delete all non-enabled versions of the PDK from your computer.",
 )
-def prune_cmd(pdk_root, pdk):
+def prune_cmd(pdk_root, pdk_family):
     """Removes all PDKs other than, if it exists, the one currently in use."""
-    pdk_versions = Version.get_all_installed(pdk_root, pdk)
+
+    pdk_versions = Version.get_all_installed(pdk_root, pdk_family)
     for version in pdk_versions:
         if version.is_current(pdk_root):
             continue
@@ -101,9 +106,10 @@ def prune_cmd(pdk_root, pdk):
     prompt="Are you sure? This will delete this version of the PDK from your computer.",
 )
 @click.argument("version", required=False)
-def rm_cmd(pdk_root, pdk, version):
+def rm_cmd(pdk_root, pdk_family, version):
     """Removes the PDK version specified."""
-    version_object = Version(version, pdk)
+
+    version_object = Version(version, pdk_family)
     try:
         version_object.uninstall(pdk_root)
         print(f"Deleted {version}.")
@@ -113,18 +119,20 @@ def rm_cmd(pdk_root, pdk, version):
 
 
 @click.command("ls")
-@opt_token
+@opt_data_source
+@opt_github_token
 @opt_pdk_root
-def list_cmd(pdk_root, pdk):
+def list_cmd(data_source, pdk_root, pdk_family):
     """Lists PDK versions that are locally installed. JSON if not outputting to a tty."""
 
-    pdk_versions = Version.get_all_installed(pdk_root, pdk)
+    pdk_versions = Version.get_all_installed(pdk_root, pdk_family)
 
     if sys.stdout.isatty():
         console = Console()
         print_installed_list(
             pdk_root,
-            pdk,
+            pdk_family,
+            data_source=data_source,
             console=console,
             installed_list=pdk_versions,
         )
@@ -133,21 +141,28 @@ def list_cmd(pdk_root, pdk):
 
 
 @click.command("ls-remote")
-@opt_token
+@opt_github_token
+@opt_data_source
 @opt_pdk_root
-def list_remote_cmd(pdk_root, pdk):
+def list_remote_cmd(data_source, pdk_root, pdk_family):
     """Lists PDK versions that are remotely available. JSON if not outputting to a tty."""
 
     try:
-        all_versions = Version._from_github()
-        pdk_versions = all_versions.get(pdk) or []
+        pdk_versions = data_source.get_available_versions(pdk_family)
 
         if sys.stdout.isatty():
             console = Console()
-            print_remote_list(pdk_root, pdk, console, pdk_versions)
+            print_remote_list(pdk_root, pdk_family, console, pdk_versions)
         else:
             for version in pdk_versions:
                 print(version.name)
+    except ValueError as e:
+        if sys.stdout.isatty():
+            console = Console()
+            console.print(f"[red]{e}")
+        else:
+            print(f"{e}", file=sys.stderr)
+        sys.exit(-1)
     except httpx.HTTPStatusError as e:
         if sys.stdout.isatty():
             console = Console()
@@ -169,7 +184,7 @@ def list_remote_cmd(pdk_root, pdk):
 @click.command("path")
 @opt_pdk_root
 @click.argument("version", required=False)
-def path_cmd(pdk_root, pdk, version):
+def path_cmd(pdk_root, pdk_family, version):
     """
     Prints the path of the ciel PDK root.
 
@@ -177,14 +192,15 @@ def path_cmd(pdk_root, pdk, version):
     version instead.
     """
     if version is not None:
-        version = Version(version, pdk)
+        version = Version(version, pdk_family)
         print(version.get_dir(pdk_root), end="")
     else:
         print(get_ciel_home(pdk_root))
 
 
 @click.command("enable")
-@opt_token
+@opt_data_source
+@opt_github_token
 @opt_pdk_root
 @click.option(
     "-f",
@@ -202,8 +218,9 @@ def path_cmd(pdk_root, pdk, version):
 )
 @click.argument("version", required=False)
 def enable_cmd(
+    data_source,
     pdk_root,
-    pdk,
+    pdk_family,
     tool_metadata_file_path,
     version,
     include_libraries,
@@ -217,6 +234,7 @@ def enable_cmd(
     tools with a tool_metadata.yml file, for example OpenLane or DFFRAM,
     the appropriate version will be enabled automatically.
     """
+
     if include_libraries == ():
         include_libraries = None
 
@@ -230,10 +248,11 @@ def enable_cmd(
     try:
         enable(
             pdk_root,
-            pdk,
+            pdk_family,
             version,
             include_libraries=include_libraries,
             output=console,
+            data_source=data_source,
         )
     except Exception as e:
         console.print(f"[red]{e}")
@@ -241,7 +260,8 @@ def enable_cmd(
 
 
 @click.command("fetch")
-@opt_token
+@opt_data_source
+@opt_github_token
 @opt_pdk_root
 @click.option(
     "-f",
@@ -259,8 +279,9 @@ def enable_cmd(
 )
 @click.argument("version", required=False)
 def fetch_cmd(
+    data_source,
     pdk_root,
-    pdk,
+    pdk_family,
     tool_metadata_file_path,
     version,
     include_libraries,
@@ -275,6 +296,7 @@ def fetch_cmd(
     tools with a tool_metadata.yml file, for example OpenLane or DFFRAM,
     the appropriate version will be enabled automatically.
     """
+
     if include_libraries == ():
         include_libraries = None
 
@@ -287,8 +309,9 @@ def fetch_cmd(
 
     try:
         version = fetch(
+            data_source=data_source,
             pdk_root=pdk_root,
-            pdk=pdk,
+            pdk=pdk_family,
             version=version,
             include_libraries=include_libraries,
             output=console,
@@ -300,79 +323,6 @@ def fetch_cmd(
         exit(-1)
 
 
-@click.command("enable_or_build", hidden=True)
-@opt_token
-@opt_pdk_root
-@opt_push
-@opt_build
-@opt("--also-push/--dont-push", default=False, help="Also push.")
-@click.option(
-    "-f",
-    "--metadata-file",
-    "tool_metadata_file_path",
-    default=None,
-    help="Explicitly define a tool metadata file instead of searching for a metadata file",
-)
-@click.argument("version")
-def enable_or_build_cmd(
-    include_libraries,
-    jobs,
-    pdk_root,
-    pdk,
-    owner,
-    repository,
-    pre,
-    clear_build_artifacts,
-    tool_metadata_file_path,
-    also_push,
-    version,
-    use_repo_at,
-    push_libraries,
-):
-    """
-    Attempts to activate a given PDK version. If the version is not found locally or remotely,
-    it will instead attempt to build said version.
-
-    Parameters: <version>
-    """
-    if include_libraries == ():
-        include_libraries = None
-    if push_libraries == ():
-        push_libraries = include_libraries
-
-    console = Console()
-    try:
-        version = resolve_version(version, tool_metadata_file_path)
-    except Exception as e:
-        console.print(f"Could not determine open_pdks version: {e}")
-        exit(-1)
-    try:
-        enable(
-            pdk_root=pdk_root,
-            pdk=pdk,
-            version=version,
-            build_if_not_found=True,
-            also_push=also_push,
-            build_kwargs={
-                "include_libraries": include_libraries,
-                "jobs": jobs,
-                "clear_build_artifacts": clear_build_artifacts,
-                "use_repo_at": use_repo_at,
-            },
-            push_kwargs={
-                "owner": owner,
-                "repository": repository,
-                "pre": pre,
-                "push_libraries": push_libraries,
-            },
-            include_libraries=include_libraries,
-            output=console,
-        )
-    except Exception as e:
-        console.print(f"[red]{e}")
-        exit(-1)
-
-
 @click.group()
 @click.version_option(
     __version__,
@@ -404,7 +354,6 @@ cli.add_command(list_cmd)
 cli.add_command(list_remote_cmd)
 cli.add_command(enable_cmd)
 cli.add_command(fetch_cmd)
-cli.add_command(enable_or_build_cmd)
 
 try:
     import ssl  # noqa: F401

{ciel-0.21.0.dev1 → ciel-2.0.0}/ciel/build/__init__.py

@@ -1,3 +1,7 @@
+# Copyright 2025 The American University in Cairo
+#
+# Adapted from the Volare project
+#
 # Copyright 2022-2023 Efabless Corporation
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -28,7 +32,7 @@ from rich.progress import Progress
 from ..github import (
     GitHubSession,
     get_commit_date,
-    volare_repo,
+    opt_github_token,
 )
 from ..common import (
     Version,
@@ -40,7 +44,6 @@ from ..click_common import (
     opt_push,
     opt_build,
     opt_pdk_root,
-    opt_token,
 )
 from ..families import Family
 
@@ -79,7 +82,7 @@ def build(
 
 
 @click.command("build")
-@opt_token
+@opt_github_token
 @opt_pdk_root
 @opt_build
 @click.option(
@@ -135,16 +138,14 @@ def push(
     pdk,
     version,
     *,
-    owner=volare_repo.owner,
-    repository=volare_repo.name,
+    owner,
+    repository,
     pre=False,
     push_libraries=None,
-    session: Optional[GitHubSession] = None,
 ):
     family = Family.by_name[pdk]
 
-    if session is None:
-        session = GitHubSession()
+    session = GitHubSession()
     if session.github_token is None:
         raise TypeError("No GitHub token was provided.")
 
@@ -231,7 +232,7 @@ def push(
 
 
 @click.command("push", hidden=True)
-@opt_token
+@opt_github_token
 @opt_pdk_root
 @opt_push
 @click.argument("version")

{ciel-0.21.0.dev1 → ciel-2.0.0}/ciel/build/ihp_sg13g2.py

@@ -83,9 +83,9 @@ def build_ihp(build_directory, ihp_path):
 def install_ihp(build_directory, pdk_root, version):
     console = Console()
     with console.status("Adding build to list of installed versions…"):
-        ihp_sg13g2_family = Family.by_name["ihp_sg13g2"]
+        ihp_sg13g2_family = Family.by_name["ihp-sg13g2"]
 
-        version_directory = Version(version, "ihp_sg13g2").get_dir(pdk_root)
+        version_directory = Version(version, "ihp-sg13g2").get_dir(pdk_root)
         if (
             os.path.exists(version_directory)
             and len(os.listdir(version_directory)) != 0
@@ -94,7 +94,7 @@ def install_ihp(build_directory, pdk_root, version):
             it = 0
             while os.path.exists(backup_path) and len(os.listdir(backup_path)) != 0:
                 it += 1
-                backup_path = Version(f"{version}.bk{it}", "ihp_sg13g2").get_dir(
+                backup_path = Version(f"{version}.bk{it}", "ihp-sg13g2").get_dir(
                     pdk_root
                 )
             console.log(
@@ -132,7 +132,7 @@ def build(
         using_repos = {}
 
     build_directory = os.path.join(
-        get_ciel_dir(pdk_root, "ihp_sg13g2"), "build", version
+        get_ciel_dir(pdk_root, "ihp-sg13g2"), "build", version
     )
     timestamp = datetime.now().strftime("build_ihp-sg13g2-%Y-%m-%d-%H-%M-%S")
     log_dir = os.path.join(build_directory, "logs", timestamp)

{ciel-0.21.0.dev1 → ciel-2.0.0}/ciel/click_common.py

@@ -1,3 +1,7 @@
+# Copyright 2025 The American University in Cairo
+#
+# Adapted from the Volare project
+#
 # Copyright 2022-2023 Efabless Corporation
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -11,29 +15,47 @@
 # 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.
-import os
 from functools import partial
 from typing import Callable, Optional
 
 import click
 
-from .common import VOLARE_RESOLVED_HOME
-from .github import volare_repo, GitHubSession
+from .common import (
+    CIEL_RESOLVED_HOME,
+    resolve_pdk_family,
+)
+from .families import Family
 
 opt = partial(click.option, show_default=True)
 
 
+def pdk_cb(
+    ctx: click.Context,
+    param: click.Parameter,
+    value: Optional[str],
+):
+    try:
+        resolved = resolve_pdk_family(value)
+    except ValueError as e:
+        raise click.BadParameter(str(e), ctx, param)
+    if resolved is None:
+        raise click.BadParameter(
+            f"A PDK family or variant must be specified. The following families are supported: {', '.join(Family.by_name)}"
+        )
+
+
 def opt_pdk_root(function: Callable):
     function = opt(
+        "--pdk-family",
         "--pdk",
-        required=False,
-        default=os.getenv("PDK_FAMILY") or "sky130",
-        help="The PDK family to install",
+        required=False,  # Requirement handled by callback
+        callback=pdk_cb,
+        help="A valid PDK family or variant (the latter of which is resolved to a family).",
     )(function)
     function = opt(
         "--pdk-root",
         required=False,
-        default=VOLARE_RESOLVED_HOME,
+        default=CIEL_RESOLVED_HOME,
         help="Path to the PDK root",
     )(function)
     return function
@@ -77,12 +99,10 @@ def opt_build(function: Callable):
 
 
 def opt_push(function: Callable):
-    function = opt("-o", "--owner", default=volare_repo.owner, help="Repository Owner")(
-        function
-    )
-    function = opt("-r", "--repository", default=volare_repo.name, help="Repository")(
+    function = opt("-o", "--owner", default="efabless", help="Repository Owner")(
         function
     )
+    function = opt("-r", "--repository", default="volare", help="Repository")(function)
     function = opt(
         "--pre/--prod", default=False, help="Push as pre-release or production"
     )(function)
@@ -95,25 +115,3 @@ def opt_push(function: Callable):
         help="Push only libraries in this list. You can use -L multiple times to include multiple libraries. Pass 'None' to push all libraries built.",
     )(function)
     return function
-
-
-def set_token_cb(
-    ctx: click.Context,
-    param: click.Parameter,
-    value: Optional[str],
-):
-    GitHubSession.Token.override = value
-
-
-def opt_token(function: Callable) -> Callable:
-    function = opt(
-        "-t",
-        "--token",
-        "session",
-        default=None,
-        required=False,
-        expose_value=False,
-        help="Replace the GitHub token used for GitHub requests, which is by default the value of the environment variable GITHUB_TOKEN or None.",
-        callback=set_token_cb,
-    )(function)
-    return function