2024.2 Release -

- Add US+ GTY IBERT example design and notebook
- Enhanced logging to handle additional logging domains
- Move example designs and jupyter notebooks out of pypi wheel to reduce file size
- Switch device program log to use hw_server service
- Add slr_index option to get_plm_log
- Add --force-reset option to device program
- Fix problems found in device program done and progress callbacks
- Add optional delay prior to create_session device scan to help initialization on slower systems
- Fix comparison case mismatch when jtag arch_name is missing from jtag node properties
- Upgrade required antlr dependency to 4.13.1 from 4.10
- Add missing YK Scan documentation
- Miscellaneous FAQ and documentation updates

Author: MikeDarnall-amd

RELEASE_NOTES.md

@@ -1,6 +1,8 @@
 # ChipScoPy Release Notes
 
 ## 2024.2 - Release November 22, 2024
+- 2024.2.173228394
+- Fix chipscopy-examples directory not found with jupyter notebooks
 
 - 2024.2.1732227392   
 - Add US+ GTY IBERT example design and notebook

chipscopy/__init__.py

@@ -38,32 +38,42 @@
 
 
 def get_examples_dir_or_die():
-    # Examples are provided for Jupyter and Commandline flows. This returns the
-    # examples directory in both flows.
-
-    # First priority - locally installed examples with the default directory name
-    # Case for most users that installed examples.
-    examples_dir = os.path.join(os.getcwd(), "chipscopy-examples")
-    if os.path.isdir(examples_dir):
-        return examples_dir
-
-    # If we get here, try to find examples in the site-libraries area or wherever
-    # we are running chipscopy from. This makes life easier for developers working
-    # who want to use examples directly from the chipscopy/examples directory.
-    if os.path.isfile(inspect.getfile(inspect.currentframe())):
-        # __file__ does not work in jupyter flows
-        examples_dir = os.path.realpath(
-            os.path.dirname(inspect.getfile(inspect.currentframe())) + "/examples"
-        )
+    # Check if the environment variable is set
+    env_examples_dir = os.getenv("CHIPSCOPY_EXAMPLES")
+    if env_examples_dir and os.path.isdir(env_examples_dir):
+        return env_examples_dir
+
+        # Start from the current working directory
+    current_dir = os.getcwd()
+
+    while True:
+        # Check for 'chipscopy-examples' directory
+        examples_dir = os.path.join(current_dir, "chipscopy-examples")
+        if os.path.isdir(examples_dir):
+            return examples_dir
+
+            # Check for 'examples' directory
+        examples_dir = os.path.join(current_dir, "examples")
         if os.path.isdir(examples_dir):
             return examples_dir
 
-    # Jupyter doesn't work with currentframe above, just try examples as a last resort
-    examples_dir = os.path.join(os.getcwd(), "examples")
-    if os.path.isdir(examples_dir):
-        return examples_dir
+            # Move up one directory level
+        parent_dir = os.path.dirname(current_dir)
+
+        # If the parent directory is the same as the current directory, we've reached the root
+        if parent_dir == current_dir:
+            break
+
+        current_dir = parent_dir
 
-    raise FileNotFoundError(errno.ENOENT, os.strerror(errno.ENOENT), examples_dir)
+        # If we reach here, neither directory was found
+    error_message = (
+        "Could not find the 'examples' or 'chipscopy-examples' directory.\n"
+        "Please ensure that one of these directories exists in the current or parent directories.\n"
+        "Alternatively, you can set the 'CHIPSCOPY_EXAMPLES' environment variable to the path of the examples directory.\n"
+        "Example: export CHIPSCOPY_EXAMPLES=/path/to/your/examples"
+    )
+    raise FileNotFoundError(errno.ENOENT, error_message)
 
 
 def _get_design_files_in_dir(p: Path) -> namedtuple:

pyproject.toml

@@ -15,7 +15,7 @@
 
 [tool.poetry]
 name = "chipscopy"
-version = "2024.2.1732227392"
+version = "2024.2.1732283942"
 description = "Open-source project from Xilinx® that enables high-level control of Versal debug IP running in hardware"
 authors = ["Xilinx ChipScope Team"]
 maintainers = ["Xilinx ChipScope Team"]