PyIBIS-AMI 7.2.8__tar.gz → 7.2.10__tar.gz

{pyibis_ami-7.2.8/src/pyibis_ami.egg-info → pyibis_ami-7.2.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyibis-ami
-Version: 7.2.8
+Version: 7.2.10
 Summary: Facilitates working directly with IBIS-AMI DLLs from the Python command prompt.
 Author-email: David Banas <capn.freako@gmail.com>
 Project-URL: Documentation, https://pyibis-ami.readthedocs.io/en/latest/
@@ -40,7 +40,7 @@ Dynamic: license-file
 # PyIBIS-AMI
 
 PyIBIS-AMI is a Python package of tools useful in the development and testing of IBIS-AMI models.
-This library is used in [PyBERT](https://github.com/capn-freako/PyBERT) and also provides two
+This library is used in [PyBERT](https://github.com/capn-freako/PyBERT) and also provides three
 command line applications.
 
 It can be installed via: `pip install PyIBIS-AMI`.
@@ -49,9 +49,23 @@ It can be installed via: `pip install PyIBIS-AMI`.
 
 ## Command Line Tools
 
-### Run IBIS-AMI Model Testing Notebook
+### AMI Config
+
+```
+ami_config -h
+Usage: ami_config [OPTIONS] PY_FILE
+
+  Configure IBIS-AMI model C++ source code, IBIS model, and AMI file.
+
+  py_file: name of model configuration file (*.py)
+
+Options:
+  -h, --help  Show this message and exit.
+```
+
+### Run (New) IBIS-AMI Model Testing Notebook
 
-```shell
+```
 $ run-notebook -h
 Usage: run-notebook [OPTIONS] IBIS_FILE BIT_RATE
 
@@ -77,46 +91,31 @@ Options:
   -h, --help           Show this message and exit.
 ```
 
-### AMI Config
-
-```shell
-ami_config -h
-Usage: ami_config [OPTIONS] PY_FILE
-
-  Configure IBIS-AMI model C++ source code, IBIS model, and AMI file.
-
-  py_file: name of model configuration file (*.py)
+### Run (Old Style) Tests
 
-Options:
-  -h, --help  Show this message and exit.
 ```
-
-### Run Tests
-
-```shell
 run_tests -h
 Usage: run_tests [OPTIONS] [TESTS]...
 
   Run a series of tests on a AMI model DLL file.
 
   If no tests are specified on the command line, run all tests found in
-  `test_dir'. (See `-t' option.)
+  `test_dir`. (See `-t` option.)
 
   usage: %prog [options] [test1 [test2 ...]]
 
   Tests are written in the EmPy templating language, and produce XML output.
-  (See the examples provided in the `examples' directory of the `pyibisami'
+  (See the examples provided in the `examples` directory of the `pyibisami`
   Python package.)
 
   Test results should be viewed by loading the XML output file into a Web
   browser. By default, the XML output file refers to the supplied XSLT file,
-  `test_results.xsl'. It is possible that you may need to copy this file
+  `test_results.xsl`. It is possible that you may need to copy this file
   from the pyibisami package directory to your local working directory, in
   order to avoid file loading errors in your Web browser.
 
 Options:
-  -t, --test_dir PATH  Sets the name of the directory from which tests are
-                       taken.
+  -t, --test_dir PATH  Sets the name of the directory from which tests are taken.
   -m, --model PATH     Sets the AMI model DLL file name.
   -p, --params TEXT    List of lists of model configurations. Format:
                        <filename> or [(name, [(label, ({AMI params., in
@@ -131,4 +130,4 @@ Options:
                        results.
   -v, --version TEXT   Show program version info and exit.
   -h, --help           Show this message and exit.
-  ```
+```

{pyibis_ami-7.2.8 → pyibis_ami-7.2.10}/README.md

@@ -3,7 +3,7 @@
 # PyIBIS-AMI
 
 PyIBIS-AMI is a Python package of tools useful in the development and testing of IBIS-AMI models.
-This library is used in [PyBERT](https://github.com/capn-freako/PyBERT) and also provides two
+This library is used in [PyBERT](https://github.com/capn-freako/PyBERT) and also provides three
 command line applications.
 
 It can be installed via: `pip install PyIBIS-AMI`.
@@ -12,9 +12,23 @@ It can be installed via: `pip install PyIBIS-AMI`.
 
 ## Command Line Tools
 
-### Run IBIS-AMI Model Testing Notebook
+### AMI Config
+
+```
+ami_config -h
+Usage: ami_config [OPTIONS] PY_FILE
+
+  Configure IBIS-AMI model C++ source code, IBIS model, and AMI file.
+
+  py_file: name of model configuration file (*.py)
+
+Options:
+  -h, --help  Show this message and exit.
+```
+
+### Run (New) IBIS-AMI Model Testing Notebook
 
-```shell
+```
 $ run-notebook -h
 Usage: run-notebook [OPTIONS] IBIS_FILE BIT_RATE
 
@@ -40,46 +54,31 @@ Options:
   -h, --help           Show this message and exit.
 ```
 
-### AMI Config
-
-```shell
-ami_config -h
-Usage: ami_config [OPTIONS] PY_FILE
-
-  Configure IBIS-AMI model C++ source code, IBIS model, and AMI file.
-
-  py_file: name of model configuration file (*.py)
+### Run (Old Style) Tests
 
-Options:
-  -h, --help  Show this message and exit.
 ```
-
-### Run Tests
-
-```shell
 run_tests -h
 Usage: run_tests [OPTIONS] [TESTS]...
 
   Run a series of tests on a AMI model DLL file.
 
   If no tests are specified on the command line, run all tests found in
-  `test_dir'. (See `-t' option.)
+  `test_dir`. (See `-t` option.)
 
   usage: %prog [options] [test1 [test2 ...]]
 
   Tests are written in the EmPy templating language, and produce XML output.
-  (See the examples provided in the `examples' directory of the `pyibisami'
+  (See the examples provided in the `examples` directory of the `pyibisami`
   Python package.)
 
   Test results should be viewed by loading the XML output file into a Web
   browser. By default, the XML output file refers to the supplied XSLT file,
-  `test_results.xsl'. It is possible that you may need to copy this file
+  `test_results.xsl`. It is possible that you may need to copy this file
   from the pyibisami package directory to your local working directory, in
   order to avoid file loading errors in your Web browser.
 
 Options:
-  -t, --test_dir PATH  Sets the name of the directory from which tests are
-                       taken.
+  -t, --test_dir PATH  Sets the name of the directory from which tests are taken.
   -m, --model PATH     Sets the AMI model DLL file name.
   -p, --params TEXT    List of lists of model configurations. Format:
                        <filename> or [(name, [(label, ({AMI params., in
@@ -94,4 +93,4 @@ Options:
                        results.
   -v, --version TEXT   Show program version info and exit.
   -h, --help           Show this message and exit.
-  ```
+```

{pyibis_ami-7.2.8 → pyibis_ami-7.2.10}/pyproject.toml

@@ -5,12 +5,11 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "pyibis-ami"
 description = "Facilitates working directly with IBIS-AMI DLLs from the Python command prompt."
-version = "7.2.8"
+version = "7.2.10"
 authors = [ {name = "David Banas",     email = "capn.freako@gmail.com"}
           ]
 readme = "README.md"
 requires-python = ">=3.10,<3.13"
-# license = "BSD-3-Clause"
 dependencies = [
     "chaco>=6.0.0",
     "click>=8.1.3",

{pyibis_ami-7.2.8 → pyibis_ami-7.2.10/src/pyibis_ami.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyibis-ami
-Version: 7.2.8
+Version: 7.2.10
 Summary: Facilitates working directly with IBIS-AMI DLLs from the Python command prompt.
 Author-email: David Banas <capn.freako@gmail.com>
 Project-URL: Documentation, https://pyibis-ami.readthedocs.io/en/latest/
@@ -40,7 +40,7 @@ Dynamic: license-file
 # PyIBIS-AMI
 
 PyIBIS-AMI is a Python package of tools useful in the development and testing of IBIS-AMI models.
-This library is used in [PyBERT](https://github.com/capn-freako/PyBERT) and also provides two
+This library is used in [PyBERT](https://github.com/capn-freako/PyBERT) and also provides three
 command line applications.
 
 It can be installed via: `pip install PyIBIS-AMI`.
@@ -49,9 +49,23 @@ It can be installed via: `pip install PyIBIS-AMI`.
 
 ## Command Line Tools
 
-### Run IBIS-AMI Model Testing Notebook
+### AMI Config
+
+```
+ami_config -h
+Usage: ami_config [OPTIONS] PY_FILE
+
+  Configure IBIS-AMI model C++ source code, IBIS model, and AMI file.
+
+  py_file: name of model configuration file (*.py)
+
+Options:
+  -h, --help  Show this message and exit.
+```
+
+### Run (New) IBIS-AMI Model Testing Notebook
 
-```shell
+```
 $ run-notebook -h
 Usage: run-notebook [OPTIONS] IBIS_FILE BIT_RATE
 
@@ -77,46 +91,31 @@ Options:
   -h, --help           Show this message and exit.
 ```
 
-### AMI Config
-
-```shell
-ami_config -h
-Usage: ami_config [OPTIONS] PY_FILE
-
-  Configure IBIS-AMI model C++ source code, IBIS model, and AMI file.
-
-  py_file: name of model configuration file (*.py)
+### Run (Old Style) Tests
 
-Options:
-  -h, --help  Show this message and exit.
 ```
-
-### Run Tests
-
-```shell
 run_tests -h
 Usage: run_tests [OPTIONS] [TESTS]...
 
   Run a series of tests on a AMI model DLL file.
 
   If no tests are specified on the command line, run all tests found in
-  `test_dir'. (See `-t' option.)
+  `test_dir`. (See `-t` option.)
 
   usage: %prog [options] [test1 [test2 ...]]
 
   Tests are written in the EmPy templating language, and produce XML output.
-  (See the examples provided in the `examples' directory of the `pyibisami'
+  (See the examples provided in the `examples` directory of the `pyibisami`
   Python package.)
 
   Test results should be viewed by loading the XML output file into a Web
   browser. By default, the XML output file refers to the supplied XSLT file,
-  `test_results.xsl'. It is possible that you may need to copy this file
+  `test_results.xsl`. It is possible that you may need to copy this file
   from the pyibisami package directory to your local working directory, in
   order to avoid file loading errors in your Web browser.
 
 Options:
-  -t, --test_dir PATH  Sets the name of the directory from which tests are
-                       taken.
+  -t, --test_dir PATH  Sets the name of the directory from which tests are taken.
   -m, --model PATH     Sets the AMI model DLL file name.
   -p, --params TEXT    List of lists of model configurations. Format:
                        <filename> or [(name, [(label, ({AMI params., in
@@ -131,4 +130,4 @@ Options:
                        results.
   -v, --version TEXT   Show program version info and exit.
   -h, --help           Show this message and exit.
-  ```
+```

{pyibis_ami-7.2.8 → pyibis_ami-7.2.10}/src/pyibisami/IBIS_AMI_Tester.ipynb

@@ -148,14 +148,14 @@
     "\n",
     "# Changing these will only have an effect if you are running this notebook manually.\n",
     "\n",
-    "ibis_dir   = \"/Users/davibana/prj/IBISAMI/celestica\"\n",
-    "ibis_file  = \"rx.ibs\"                     # IBIS-AMI model to test.\n",
-    "# params     = \"test_runs/rx/ctle_1p5.run\"  # Directory or file containing AMI parameter sweep definitions.\n",
-    "params     = \"debug.run\"  # Directory or file containing AMI parameter sweep definitions.\n",
+    "ibis_dir   = \".\"\n",
+    "ibis_file  = \"rx.ibs\"       # IBIS-AMI model to test.\n",
+    "params     = \"rx_test.run\"  # Directory or file containing AMI parameter sweep definitions.\n",
     "is_tx = False        # True for Tx; False for Rx.\n",
     "debug = False        # Set to 'True' if you're having trouble and need some debugging info.\n",
     "bit_rate = 53.125e9\n",
     "nspui = 32           # vector samples per unit interval\n",
+    "no_nspui_swp = False # Skip samples per UI sweeping when true.\n",
     "nbits = 20           # number of bits for AMI_Init() exercising\n",
     "plot_t_max = 0.5e-9  # maximum x-axis extent for time domain plots (s)\n",
     "f_max = 40e9         # maximum frequency (Hz)\n",
@@ -1177,7 +1177,8 @@
     }
    ],
    "source": [
-    "samples_per_bit()\n"
+    "if not no_nspui_swp:\n",
+    "    samples_per_bit()\n"
    ]
   },
   {
@@ -1388,7 +1389,8 @@
     }
    ],
    "source": [
-    "samples_per_bit()\n"
+    "if not no_nspui_swp:\n",
+    "    samples_per_bit()\n"
    ]
   },
   {
@@ -1449,7 +1451,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.16"
+   "version": "3.11.13"
   }
  },
  "nbformat": 4,

{pyibis_ami-7.2.8 → pyibis_ami-7.2.10}/src/pyibisami/ami/model.py

@@ -332,16 +332,26 @@ class AMIModel:  # pylint: disable=too-many-instance-attributes
                 )
 
         # Construct the AMI parameters string.
-        def sexpr(pname, pval):
-            """Create an S-expression from a parameter name/value pair, calling
-            recursively as needed to elaborate sub-parameter dictionaries."""
+        def sexpr(pname: str, pval: Any) -> str:
+            """
+            Create an S-expression from a parameter name/value pair, calling
+            recursively as needed to elaborate sub-parameter dictionaries.
+
+            Args:
+                pname: Parameter name.
+                pval: Parameter value.
+
+            Returns:
+                A string containing the S-expression constructed.
+            """
             if isinstance(pval, str):
                 return f'({pname} "{pval}")'
             if isinstance(pval, dict):
                 subs = []
                 for sname in pval:
                     subs.append(sexpr(sname, pval[sname]))
-                return sexpr(pname, " ".join(subs))
+                # return sexpr(pname, " ".join(subs))
+                return f"({pname} {' '.join(subs)})"
             return f"({pname} {pval})"
 
         ami_params_in = f"({init_object.ami_params['root_name']} "

{pyibis_ami-7.2.8 → pyibis_ami-7.2.10}/src/pyibisami/ami/parser.py

@@ -15,7 +15,7 @@ import numpy as np
 from numpy.typing import NDArray
 from parsec import ParseError, generate, many, regex, string
 from traits.api import Bool, Enum, HasTraits, Range, Trait, TraitType
-from traitsui.api import Group, HFlow, Item, VGroup, View
+from traitsui.api import Group, HGroup, Item, VGroup, View
 from traitsui.menu import ModalButtons
 
 from .model                     import AMIModelInitializer
@@ -594,18 +594,44 @@ def make_gui(params: ModelSpecificDict) -> tuple[Group, list[TraitType]]:
     Notes:
         1. The dictionary passed through ``params`` may have sub-dictionaries.
         The window layout will reflect this nesting.
+        2. Some AMI files are written to encode the AMI parameter hierarchy
+        via some parameter naming scheme. This function makes a primitive attempt
+        to decode one particular example of this: ``<grp>_<param>``.
     """
 
     gui_items: list[Item | Group] = []
     new_traits: list[tuple[str, TraitType]] = []
+
+    # Place parameters with a common prefix in their names,
+    # but no pre-existing enclosing group, in a ``VGroup``.
+    # - Generate grouped parameter names and list of unique group names.
     pnames = list(params.keys())
-    pnames.sort()
-    for pname in pnames:
-        gui_item, new_trait = make_gui_items(pname, params[pname])
-        gui_items.extend(gui_item)
-        new_traits.extend(new_trait)
+    pnames_split = list(map(lambda n: n.split('_'), pnames))
+    group_names = list(map(lambda xs: xs[0], pnames_split))
+    grouped_pnames = list(zip(pnames, group_names))
+    # The following doesn't preserve the parameter ordering of the AMI file!
+    # for group_name in set(group_names):  # Iterate over unique group names.
+    unique_group_names = []
+    for group_name in group_names:
+        if group_name not in unique_group_names:
+            unique_group_names.append(group_name)
+    # - Process all parameters, trapping those from a non-explicit group for special processing.
+    for group_name in unique_group_names:
+        pnames_in_group = [pname for pname, grp_name in grouped_pnames if grp_name == group_name]
+        if len(pnames_in_group) > 1:
+            _gui_items: list[Item | Group] = []
+            for pname in pnames_in_group:
+                gui_item, new_trait = make_gui_items(pname, params[pname])
+                _gui_items.extend(gui_item)
+                new_traits.extend(new_trait)
+            gui_items.append(VGroup(*_gui_items, label=group_name, show_border=True))
+        else:
+            pname = pnames_in_group[0]
+            gui_item, new_trait = make_gui_items(pname, params[pname])
+            gui_items.extend(gui_item)
+            new_traits.extend(new_trait)
 
-    return (HFlow(*gui_items), new_traits)
+    return (HGroup(*gui_items), new_traits)
 
 
 def make_gui_items(  # pylint: disable=too-many-locals,too-many-branches

{pyibis_ami-7.2.8 → pyibis_ami-7.2.10}/src/pyibisami/ibis/model.py

@@ -209,7 +209,8 @@ class Model(HasTraits):  # pylint: disable=too-many-instance-attributes
             self._slew = (ramp["rising"][0] + ramp["falling"][0]) / 2e9  # (V/ns)
         elif mtype == "input":
             if "gnd_clamp" not in subDict and "power_clamp" not in subDict:
-                raise LookupError("Missing clamp curves!")
+                # raise LookupError("Missing clamp curves!")
+                pass
 
             plotdata = ArrayPlotData()
 
@@ -220,6 +221,8 @@ class Model(HasTraits):  # pylint: disable=too-many-instance-attributes
                 plotdata.set_data("gc_ityps", gc_ityps)
                 plotdata.set_data("gc_imins", gc_imins)
                 plotdata.set_data("gc_imaxs", gc_imaxs)
+            else:
+                gc_z = 2e6
 
             if "power_clamp" in subDict:
                 pc_vs, pc_ityps, pc_imins, pc_imaxs, pc_zs = proc_iv(subDict["power_clamp"])
@@ -232,6 +235,8 @@ class Model(HasTraits):  # pylint: disable=too-many-instance-attributes
                 plotdata.set_data("pc_ityps", pc_ityps)
                 plotdata.set_data("pc_imins", pc_imins)
                 plotdata.set_data("pc_imaxs", pc_imaxs)
+            else:
+                pc_z = 2e6
 
             plot_iv = Plot(plotdata)  # , padding_left=75)
             # The 'line_style' trait of a LinePlot instance must be 'dash' or 'dot dash' or 'dot' or 'long dash' or 'solid'.

{pyibis_ami-7.2.8 → pyibis_ami-7.2.10}/src/pyibisami/ibis/parser.py

@@ -91,8 +91,11 @@ def word(p):
 @generate("remainder of line")
 def rest_line():
     "Parse remainder of line."
-    chars = yield many(none_of("\n\r")) << ignore  # So that we still function as a lexeme.
-    return "".join(chars)
+    chars = yield many(none_of("[\n\r")) << ignore  # So that we still function as a lexeme.
+    rslt = "".join(chars)
+    if DEBUG:
+        print(f"rest_line(): {rslt}", flush=True)
+    return rslt
 
 
 skip_line = lexeme(rest_line).result("(Skipped.)")
@@ -348,6 +351,17 @@ def model():
 rlc = lexeme(string("R_pin") | string("L_pin") | string("C_pin"))
 
 
+@generate("[Manufacturer]")
+def manufacturer():
+    "Parse manufacturer."
+    rslt = yield rest_line
+    if not rslt:
+        rslt = "(n/a)"
+    if DEBUG:
+        print(f"Manufacturer: {rslt}", flush=True)
+    return rslt
+
+
 @generate("[Package]")
 def package():
     "Parse package RLC values."
@@ -392,7 +406,7 @@ def pins():
 
 
 Component_keywords = {
-    "manufacturer": rest_line,
+    "manufacturer": manufacturer,
     "package": package,
     "pin": pins,
     "diff_pin": skip_keyword,
@@ -495,6 +509,9 @@ def parse_ibis_file(ibis_file_contents_str, debug=False):
                 Dictionary containing keyword definitions (empty upon failure).
     """
 
+    global DEBUG  # pylint: disable=W0603
+    DEBUG = debug
+
     try:
         nodes = ibis_file.parse_strict(ibis_file_contents_str)  # Parse must consume the entire file.
         if debug:

{pyibis_ami-7.2.8 → pyibis_ami-7.2.10}/src/pyibisami/tools/run_notebook.py

@@ -107,6 +107,7 @@ def run_notebook(
 @click.option("--debug", is_flag=True, help="Provide extra debugging information.")
 @click.option("--is_tx", is_flag=True, help="Flags a Tx model.")
 @click.option("--nspui", default=32, show_default=True, help="Number of samples per unit interval.")
+@click.option("--no-nspui-swp", is_flag=True, help="Skip samples per UI sweep.")
 @click.option("--nbits", default=200, show_default=True, help="Number of bits to run in simulations.")
 @click.option("--plot-t-max", default=0.5e-9, show_default=True, help="Maximum time value for plots (s).")
 @click.option("--f-max",  default=40e9, show_default=True, help="Maximum frequency for transfer functions (Hz).")
@@ -117,18 +118,20 @@ def run_notebook(
 @click.argument("bit_rate", type=float)
 @click.version_option(package_name="PyIBIS-AMI")
 # pylint: disable=too-many-arguments,too-many-positional-arguments
-def main(notebook, out_dir, params, ibis_file, bit_rate, debug, is_tx, nspui, nbits,
+def main(notebook, out_dir, params, ibis_file, bit_rate,
+         debug, is_tx, nspui, no_nspui_swp, nbits,
          plot_t_max, f_max, f_step, fig_x, fig_y):
     "Run a *Jupyter* notebook on an IBIS-AMI model file."
     run_notebook(
         Path(ibis_file).resolve(), Path(notebook).resolve(),
-        out_dir=out_dir,
+        out_dir=Path(out_dir).resolve(),
         notebook_params={
             'ibis_dir': ".",
             'ibis_file': ibis_file,
             'debug': debug,
             'is_tx': is_tx,
             'nspui': nspui,
+            'no_nspui_swp': no_nspui_swp,
             'nbits': nbits,
             'plot_t_max': plot_t_max,
             'f_max': f_max,