librelane 2.4.1__tar.gz → 2.4.2__tar.gz

{librelane-2.4.1 → librelane-2.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: librelane
-Version: 2.4.1
+Version: 2.4.2
 Summary: An infrastructure for implementing chip design flows
 Home-page: https://github.com/librelane/librelane
 License: Apache-2.0

{librelane-2.4.1 → librelane-2.4.2}/librelane/config/flow.py

@@ -153,13 +153,13 @@ pdk_variables = [
     Variable(
         "FP_IO_HLAYER",
         str,
-        "The metal layer on which to place horizontal IO pins, i.e., the top and bottom of the die.",
+        "The metal layer on which to place horizontally-aligned (long side parallel with the horizon) pins alongside the east and west edges of the die.",
         pdk=True,
     ),
     Variable(
         "FP_IO_VLAYER",
         str,
-        "The metal layer on which to place vertical IO pins, i.e., the top and bottom of the die.",
+        "The metal layer on which to place vertically-aligned (long side perpendicular to the horizon) pins alongside the north and south edges of the die.",
         pdk=True,
     ),
     Variable("RT_MIN_LAYER", str, "The lowest metal layer to route on.", pdk=True),

{librelane-2.4.1 → librelane-2.4.2}/librelane/flows/cli.py

@@ -146,27 +146,30 @@ def cloup_flow_opts(
     function decorated with @cloup.command (https://cloup.readthedocs.io/en/stable/autoapi/cloup/index.html#cloup.command).
 
     The following keyword arguments will be passed to the decorated function.
+
     * Those postfixed ‡ are compatible with the constructor for :class:`Flow`.
     * Those postfixed § are compatible with the :meth:`Flow.start`.
 
+    ---
+
     * Flow configuration options (if parameter ``config_options`` is ``True``):
         * ``flow_name``: ``Optional[str]``: A valid flow ID to be used with :meth:`Flow.factory.get`
-        * ``config_override_strings``‡: ``Optional[Iterable[str]]``
+        * ``config_override_strings`` ‡: ``Optional[Iterable[str]]``
     * Sequential flow controls (if parameter ``sequential_flow_controls`` is ``True``)
-        * ``frm``§: ``Optional[str]``: Start from a step with this ID. Supported by sequential flows.
-        * ``to``§: ``Optional[str]``: Stop at a step with this id. Supported by sequential flows.
-        * ``skip``§: ``Iterable[str]``: Skip these steps. Supported by sequential flows.
+        * ``frm`` §: ``Optional[str]``: Start from a step with this ID. Supported by sequential flows.
+        * ``to`` §: ``Optional[str]``: Stop at a step with this id. Supported by sequential flows.
+        * ``skip`` §: ``Iterable[str]``: Skip these steps. Supported by sequential flows.
     * Sequential flow reproducible (if parameter ``sequential_flow_reproducible`` is ``True``)
-        * ``reproducible``§: ``str``: Create a reproducible for a step with is ID, aborting the flow afterwards. Supported by sequential flows.
+        * ``reproducible`` §: ``str``: Create a reproducible for a step with is ID, aborting the flow afterwards. Supported by sequential flows.
     * Flow run options (if parameter ``run_options`` is ``True``):
-        * ``tag``§: ``Optional[str]``
-        * ``last_run``§: ``bool``: If ``True``, ``tag`` is guaranteed to be None.
-        * ``with_initial_state``§: ``Optional[State]``
+        * ``tag`` §: ``Optional[str]``
+        * ``last_run`` §: ``bool``: If ``True``, ``tag`` is guaranteed to be None.
+        * ``with_initial_state`` §: ``Optional[State]``
     * PDK options
-        * ``use_volare``: ``bool``
-        * ``pdk_root``‡: ``Optional[str]``
-        * ``pdk``‡: ``str``
-        * ``scl``‡: ``Optional[str]``
+        * ``use_volare`` : ``bool``
+        * ``pdk_root`` ‡: ``Optional[str]``
+        * ``pdk`` ‡: ``str``
+        * ``scl`` ‡: ``Optional[str]``
     * ``config_files``: ``Iterable[str]``: Paths to configuration files (if
       parameter  ``accept_config_files`` is ``True``)
 

{librelane-2.4.1 → librelane-2.4.2}/librelane/flows/flow.py

@@ -534,8 +534,11 @@ class Flow(ABC):
 
         :param with_initial_state: An optional initial state object to use.
             If not provided:
+
             * If resuming a previous run, the latest ``state_out.json`` (by filesystem modification date)
+
             * If not, an empty state object is created.
+
         :param tag: A name for this invocation of the flow. If not provided,
             one based on a date string will be created.
 
@@ -1002,8 +1005,9 @@ class Flow(ABC):
         A factory singleton for Flows, allowing Flow types to be registered and then
         retrieved by name.
 
-        See https://en.wikipedia.org/wiki/Factory_(object-oriented_programming) for
-        a primer.
+        See
+        `Factory (object-oriented programming) on Wikipedia <https://en.wikipedia.org/wiki/Factory_(object-oriented_programming)>`_
+        for a primer.
         """
 
         __registry: ClassVar[Dict[str, Type[Flow]]] = {}

{librelane-2.4.1 → librelane-2.4.2}/librelane/steps/step.py

@@ -1440,7 +1440,8 @@ class Step(ABC):
         A factory singleton for Steps, allowing steps types to be registered and then
         retrieved by name.
 
-        See https://en.wikipedia.org/wiki/Factory_(object-oriented_programming) for
+        See
+        `Factory (object-oriented programming) on Wikipedia <https://en.wikipedia.org/wiki/Factory_(object-oriented_programming)>`_
         a primer.
         """
 

{librelane-2.4.1 → librelane-2.4.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "librelane"
-version = "2.4.1"
+version = "2.4.2"
 description = "An infrastructure for implementing chip design flows"
 # Technically, maintainer. We cannot use the maintainers field until
 # poetry-core>=2.0.0 which requires Python version 3.9+. This field does