📦 Fix package for release and handover

Author: daquintero

.gitignore

@@ -200,5 +200,9 @@ RUN_*
 
 *.sif
 .idea/
+
 docs/autoapi/
 result
+docs/examples/02a_large_scale_digital_layout/sequential/*
+docs/examples/02a_large_scale_digital_layout/parallel/*
+*/runs/*

README.md

@@ -1,5 +1,10 @@
 # # Digital Design & Simulation Flow
 
+# <div style="padding: 10px; border-radius: 5px;">
+# <strong>⚠️ Warning:</strong> This example requires the <code>piel-nix</code> tools environment.
+# <a href="https://piel.readthedocs.io/en/latest/sections/environment/index.html" target="_blank">See environment configuration documentation</a>.
+# </div>
+
 # There are many tools to perform a digital design flow. I have summarised some of the most relevant ones in the TODO LINK INTEGRATION PAGE. In `piel`, there are a few digital design flow functionalities integrated. However, because the output or interconnections have a set of accepted common measurement, it is possible to use different design flows to integrate with other tools in the flow.
 #
 # We will explore two popular ones:
@@ -349,7 +354,6 @@
 
 # ## Sequential Implementation
 
-# +
 try:
     from openlane.flows import SequentialFlow
     from openlane.steps import Yosys, OpenROAD, Magic, Netgen
@@ -387,4 +391,3 @@ class MyFlow(SequentialFlow):
     print(
         f"Make sure you are running this from an environment with Openlane nix installed {e}"
     )
-# -

docs/_static/img/examples/03a_sax_active_cosimulation/mzi2x2_phase_shifter.svg

@@ -83,6 +83,22 @@
 # | 15 |    1111 |     1010 |
 
 
+# ### Verify Our Environment Configuration
+
+# This should run successfully for the remaining example
+
+layout_truth_table_through_openlane
+
+layout_truth_table_through_openlane(
+    truth_table=truth_table,
+    parent_directory="sequential",
+    target_directory_name="sequential_test",
+)
+
+
+# ### Configure Optimised Runs
+
+
 def sequential_implementations(amount_of_implementations: int):
     implementations = list()
 
@@ -120,6 +136,19 @@ def parallel_implementations(amount_of_implementations: int):
 
 # Let's time this:
 
+# +
+start_sequential = time.time()
+sequential_implementations(amount_of_implementations=4)
+end_sequential = time.time()
+
+print("Sequential")
+print(end_sequential - start_sequential)
+# -
+# ```
+# Sequential
+# 106.13592076301575
+# ```
+
 # +
 start_parallel = time.time()
 parallel_implementations(amount_of_implementations=4)
@@ -133,16 +162,3 @@ def parallel_implementations(amount_of_implementations: int):
 # Parallel
 # 42.47045159339905
 # ```
-
-# +
-start_sequential = time.time()
-sequential_implementations(amount_of_implementations=4)
-end_sequential = time.time()
-
-print("Sequential")
-print(end_sequential - start_sequential)
-# -
-# ```
-# Sequential
-# 106.13592076301575
-# ```