PyIBIS-AMI 5.1.1__tar.gz → 5.1.4__tar.gz

{PyIBIS-AMI-5.1.1/src/PyIBIS_AMI.egg-info → pyibis_ami-5.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyIBIS-AMI
-Version: 5.1.1
+Version: 5.1.4
 Summary: Facilitates working directly with IBIS-AMI DLLs from the Python command prompt.
 Author: David Patterson
 Author-email: David Banas <capn.freako@gmail.com>
@@ -42,7 +42,7 @@ command line applications.
 It can be installed via `conda`.  PyPi support is experimental but can be installed with
  `pip install PyIBIS-AMI`.
 
-[View API/Developer's Documentation.](https://htmlpreview.github.io/?https://github.com/capn-freako/PyAMI/blob/master/docs/build/html/index.html)
+[View API/Developer's Documentation.](https://pyibis-ami.readthedocs.io/en/latest/)
 
 ## Command Line Tools
 

{PyIBIS-AMI-5.1.1 → pyibis_ami-5.1.4}/README.md

@@ -9,7 +9,7 @@ command line applications.
 It can be installed via `conda`.  PyPi support is experimental but can be installed with
  `pip install PyIBIS-AMI`.
 
-[View API/Developer's Documentation.](https://htmlpreview.github.io/?https://github.com/capn-freako/PyAMI/blob/master/docs/build/html/index.html)
+[View API/Developer's Documentation.](https://pyibis-ami.readthedocs.io/en/latest/)
 
 ## Command Line Tools
 

pyibis_ami-5.1.4/docs/source/ami.rst

@@ -0,0 +1,24 @@
+pyibisami.ami
+=============
+
+AMI related submodules in the *PyIBIS-AMI* package.
+
+config
+------
+
+.. automodule:: pyibisami.ami.config
+
+model
+-----
+
+.. automodule:: pyibisami.ami.model
+
+parameter
+---------
+
+.. automodule:: pyibisami.ami.parameter
+
+parser
+------
+
+.. automodule:: pyibisami.ami.parser

{PyIBIS-AMI-5.1.1 → pyibis_ami-5.1.4}/docs/source/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# PyBERT Developer Guide documentation build configuration file, created by
+# PyIBIS-AMI Developer Guide documentation build configuration file, created by
 # sphinx-quickstart on Tue Feb 10 10:04:12 2015.
 #
 # This file is execfile()d with the current directory set to its
@@ -18,20 +18,44 @@ import sys
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-# sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath("../../src"))
 
 # -- General configuration ------------------------------------------------
 
-# dbanas-2015_02_14
-autoclass_content = "both"
-
 # If your documentation needs a minimal Sphinx version, state it here.
 # needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode", "sphinx.ext.napoleon", "m2r2"]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.coverage",
+    "sphinx.ext.todo",
+    # "sphinx.ext.autosummary",
+    "m2r2",
+]
+autodoc_default_options = {
+    "undoc-members": True,
+    "inherited-members": False,
+    "show-inheritance": True,
+    "members": True,
+    "exclude-members": "default_traits_view",
+}
+autodoc_mock_imports = [
+    "chaco",
+    "click",
+    "em",
+    "enable",
+    "matplotlib",
+    "numpy",
+    "traits",
+    "traitsui",
+]
+autoclass_content = "both"
+autodata_content = "both"
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -45,18 +69,21 @@ source_suffix = ".rst"
 # The master toctree document.
 master_doc = "index"
 
-# General information about the project.
-project = "PyIBIS-AMI Developer Guide"
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+project = "PyIBIS-AMI User's Guide"
 copyright = "2015, David Banas"
+author = "David Banas"
+release = "v5.1.3"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = "4.0"
+version = "5.1"
 # The full version, including alpha/beta/rc tags.
-release = "4.0.0"
+release = "5.1.3"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -73,7 +100,7 @@ language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = []
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -101,10 +128,12 @@ pygments_style = "sphinx"
 
 
 # -- Options for HTML output ----------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "default"
+html_theme = "sphinx_rtd_theme"
+todo_include_todos = True
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -196,27 +225,27 @@ html_static_path = ["_static"]
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "PyIBIS-AMIDeveloperGuidedoc"
+htmlhelp_basename = "PyIBIS-AMIUserGuidedoc"
 
 # -- Options for LaTeX output ---------------------------------------------
 
-latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
-    #'papersize': 'letterpaper',
-    # The font size ('10pt', '11pt' or '12pt').
-    #'pointsize': '10pt',
-    # Additional stuff for the LaTeX preamble.
-    #'preamble': '',
-    # Latex figure (float) alignment
-    #'figure_align': 'htbp',
-}
+# latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+# Latex figure (float) alignment
+#'figure_align': 'htbp',
+# }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-    ("index", "PyIBIS-AMIDeveloperGuide.tex", "PyIBIS-AMI Developer Guide Documentation", "David Banas", "manual"),
-]
+# latex_documents = [
+#     ("index", "PyIBIS-AMIDeveloperGuide.tex", "PyIBIS-AMI Developer Guide Documentation", "David Banas", "manual"),
+# ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
@@ -243,7 +272,7 @@ latex_documents = [
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [("index", "pyibis-amideveloperguide", "PyIBIS-AMI Developer Guide Documentation", ["David Banas"], 1)]
+# man_pages = [("index", "pyibis-amideveloperguide", "PyIBIS-AMI Developer Guide Documentation", ["David Banas"], 1)]
 
 # If true, show URL addresses after external links.
 # man_show_urls = False
@@ -254,17 +283,17 @@ man_pages = [("index", "pyibis-amideveloperguide", "PyIBIS-AMI Developer Guide D
 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
-texinfo_documents = [
-    (
-        "index",
-        "PyIBIS-AMIDeveloperGuide",
-        "PyIBIS-AMI Developer Guide Documentation",
-        "David Banas",
-        "PyIBIS-AMIDeveloperGuide",
-        "One line description of project.",
-        "Miscellaneous",
-    ),
-]
+# texinfo_documents = [
+#     (
+#         "index",
+#         "PyIBIS-AMIDeveloperGuide",
+#         "PyIBIS-AMI Developer Guide Documentation",
+#         "David Banas",
+#         "PyIBIS-AMIDeveloperGuide",
+#         "One line description of project.",
+#         "Miscellaneous",
+#     ),
+# ]
 
 # Documents to append as an appendix to all manuals.
 # texinfo_appendices = []

pyibis_ami-5.1.4/docs/source/ibis.rst

@@ -0,0 +1,19 @@
+pyibisami.ibis
+==============
+
+IBIS related submodules in the *PyIBIS-AMI* package.
+
+file
+----
+
+.. automodule:: pyibisami.ibis.file
+
+model
+-----
+
+.. automodule:: pyibisami.ibis.model
+
+parser
+------
+
+.. automodule:: pyibisami.ibis.parser

{PyIBIS-AMI-5.1.1 → pyibis_ami-5.1.4}/docs/source/index.rst

@@ -3,12 +3,10 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-===========================================
- *PyIBIS-AMI* Source Code Developer's Guide
-===========================================
+*PyIBIS-AMI* API User's Guide
+==============================
 
-Welcome to the *PyIBIS-AMI Developer's Guide*!
-==============================================
+Welcome to the *PyIBIS-AMI* API user's documentation!
 
 Contents
 --------
@@ -16,11 +14,11 @@ Contents
 .. toctree::
    :maxdepth: 2
 
-   intro
+   install
    modules
 
 Indices and tables
-==================
+------------------
 
 * :ref:`genindex`
 * :ref:`modindex`

pyibis_ami-5.1.4/docs/source/install.rst

@@ -0,0 +1,31 @@
+Installation Instructions
+=========================
+
+Installation into system Python environment
+-------------------------------------------
+
+If you don't mind installing *PyIBIS-AMI* into your system Python package library then installation is as simple as:
+
+`pip install pyibis-ami`
+
+Installation into custom virtual Python environment
+---------------------------------------------------
+
+If, instead, you'd prefer to confine the *PyIBIS-AMI* package to a virtual environment, thus protecting your system Python installation from it, then execute these commands, in order:
+
+1. `python3 -m venv ~/.venv/pyibisami` (Creates a new Python virtual environment named "pyibisami".)
+
+2. `. ~/.venv/pyibisami/bin/activate` (on Windows: `. ~/.venv/pyibisami/Scripts/activate`) (Activates the new environment.)
+
+    - At this point, you should begin seeing "(pyibisami)" at the beginning of your command prompt, indicating that you have activated your `pyibisami` Python virtual environment activated.
+
+3. `pip install pyibis-ami` (Installs the *PyIBIS-AMI* package into your new virtual environment.)
+
+Testing the installation
+------------------------
+
+Either way, as a check on correct installation, run the following command:
+
+`python -c "import pyibisami"`
+
+And if you don't get a traceback/error then you've installed the package successfully!

pyibis_ami-5.1.4/docs/source/modules.rst

@@ -0,0 +1,12 @@
+*PyIBIS-AMI* Package
+====================
+
+.. automodule:: pyibisami
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Modules:
+
+   ibis
+   ami
+   tools

pyibis_ami-5.1.4/docs/source/tools.rst

@@ -0,0 +1,9 @@
+pyibisami.tools
+===============
+
+Misc. submodules in the *PyIBIS-AMI* package.
+
+run_tests
+---------
+
+.. automodule:: pyibisami.tools.run_tests

{PyIBIS-AMI-5.1.1 → pyibis_ami-5.1.4}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "PyIBIS-AMI"
 description = "Facilitates working directly with IBIS-AMI DLLs from the Python command prompt."
-version = "5.1.1"
+version = "5.1.4"
 authors = [ {name = "David Banas",     email = "capn.freako@gmail.com"}
           , {name = "David Patterson"}
           ]

{PyIBIS-AMI-5.1.1 → pyibis_ami-5.1.4/src/PyIBIS_AMI.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PyIBIS-AMI
-Version: 5.1.1
+Version: 5.1.4
 Summary: Facilitates working directly with IBIS-AMI DLLs from the Python command prompt.
 Author: David Patterson
 Author-email: David Banas <capn.freako@gmail.com>
@@ -42,7 +42,7 @@ command line applications.
 It can be installed via `conda`.  PyPi support is experimental but can be installed with
  `pip install PyIBIS-AMI`.
 
-[View API/Developer's Documentation.](https://htmlpreview.github.io/?https://github.com/capn-freako/PyAMI/blob/master/docs/build/html/index.html)
+[View API/Developer's Documentation.](https://pyibis-ami.readthedocs.io/en/latest/)
 
 ## Command Line Tools
 

{PyIBIS-AMI-5.1.1 → pyibis_ami-5.1.4}/src/PyIBIS_AMI.egg-info/SOURCES.txt

@@ -2,10 +2,13 @@ LICENSE
 MANIFEST.in
 README.md
 pyproject.toml
+docs/source/ami.rst
 docs/source/conf.py
+docs/source/ibis.rst
 docs/source/index.rst
-docs/source/intro.rst
+docs/source/install.rst
 docs/source/modules.rst
+docs/source/tools.rst
 examples/all_taps.run
 examples/bandwidth.run
 examples/dummy.em

{PyIBIS-AMI-5.1.1 → pyibis_ami-5.1.4}/src/pyibisami/__init__.py

@@ -8,6 +8,7 @@ Original Date:   3 July 2012
 
 Copyright (c) 2012 by David Banas; All rights reserved World wide.
 """
+
 from importlib.metadata import version as _get_version
 
 # Set PEP396 version attribute

{PyIBIS-AMI-5.1.1 → pyibis_ami-5.1.4}/src/pyibisami/__main__.py

@@ -1,4 +1,5 @@
 """A package of Python modules, used to configure and test IBIS-AMI models."""
+
 print("pyibisami is a package of sub-modules, and is not directly executable.")
 print("Perhaps, you meant:")
 print("    - pyibisami.ami.config")

{PyIBIS-AMI-5.1.1 → pyibis_ami-5.1.4}/src/pyibisami/ami/config.py

@@ -6,14 +6,17 @@ Original author: David Banas
 
 Original date:   February 26, 2016
 
+Copyright (c) 2016 David Banas; all rights reserved World wide.
+
 This script gets called from a makefile, when any of the following need rebuilding:
 
 * a C++ source code file
 * a ``*.AMI`` file
 * a ``*.IBS`` file
+* a ``*.TST`` file (a dummy place-holder indicating that the test run config. files have been made)
 
-All three will be rebuilt.
-(We rebuild all three, because it doesn't take very long, and we can
+All files will be rebuilt.
+(We rebuild all files, because it doesn't take very long, and we can
 insure consistency this way.)
 
 This gets triggered by one of two things:
@@ -21,11 +24,9 @@ This gets triggered by one of two things:
 #. The common model configuration information has changed, or
 #. One of the EmPy template files was updated.
 
-The idea, here, is that the ``*.IBS`` file, the ``*.AMI`` file, and the
-C++ source file should be configured from a common model configuration
-file, so as to ensure consistency between the three.
-
-Copyright (c) 2016 David Banas; all rights reserved World wide.
+The idea here is that the ``*.IBS`` file, the ``*.AMI`` file, the C++ source file,
+and the test run configuration files should be configured from a common model
+configuration file, so as to ensure consistency between them all.
 """
 import importlib.util
 from datetime import date
@@ -36,8 +37,8 @@ import em
 
 param_types = {
     "INT": {"c_type": "int", "ami_type": "Integer", "getter": "get_param_int"},
-    "FLOAT": {"c_type": "float", "ami_type": "Float", "getter": "get_param_float"},
-    "TAP": {"c_type": "float", "ami_type": "Tap", "getter": "get_param_float"},
+    "FLOAT": {"c_type": "double", "ami_type": "Float", "getter": "get_param_float"},
+    "TAP": {"c_type": "double", "ami_type": "Tap", "getter": "get_param_float"},
     "BOOL": {"c_type": "bool", "ami_type": "Boolean", "getter": "get_param_bool"},
     "STRING": {"c_type": "char *", "ami_type": "String", "getter": "get_param_str"},
 }
@@ -116,20 +117,16 @@ def print_code(pname, param):
     print("       ", "node_names.pop_back();")
 
 
-def ami_config(py_file):
-    """Read in the ``py_file`` and cpp.em file then generate a ibis, ami and
-    cpp."""
-    file_base_name = Path(py_file).stem
-
-    # Read model configuration information.
-    print(f"Reading model configuration information from file: {py_file}.")
-    spec = importlib.util.spec_from_file_location(file_base_name, py_file)
-    cfg = importlib.util.module_from_spec(spec)
-    spec.loader.exec_module(cfg)
+def mk_model(ibis_params, ami_params, model_name, description, out_dir="."):
+    """
+    Generate ibis, ami, and cpp files, by merging the
+    device specific parameterization with the templates.
+    """
 
-    # Configure the 3 files.
+    py_file = (Path(out_dir).resolve() / model_name).with_suffix(".py")
+    # Configure the model files.
     for ext in ["cpp", "ami", "ibs"]:
-        out_file = Path(py_file).with_suffix(f".{ext}")
+        out_file = py_file.with_suffix(f".{ext}")
         if ext == "ami":
             em_file = Path(__file__).parent.joinpath("generic.ami.em")
         elif ext == "ibs":
@@ -142,11 +139,11 @@ def ami_config(py_file):
             interpreter = em.Interpreter(
                 output=out_file,
                 globals={
-                    "ami_params": cfg.ami_params,
-                    "ibis_params": cfg.ibis_params,
+                    "ami_params": ami_params,
+                    "ibis_params": ibis_params,
                     "param_types": param_types,
-                    "model_name": cfg.kFileBaseName,
-                    "description": cfg.kDescription,
+                    "model_name": model_name,
+                    "description": description,
                     "date": str(date.today()),
                 },
             )
@@ -156,10 +153,93 @@ def ami_config(py_file):
                 interpreter.shutdown()
 
 
+def ami_config(py_file):
+    """
+    Read in the ``py_file`` and cpp.em files,
+    then generate: ibis, ami, and cpp files.
+    """
+
+    file_base_name = Path(py_file).stem
+
+    # Read model configuration information.
+    print(f"Reading model configuration information from file: {py_file}.")
+    spec = importlib.util.spec_from_file_location(file_base_name, py_file)
+    cfg = importlib.util.module_from_spec(spec)
+    spec.loader.exec_module(cfg)
+
+    mk_model(cfg.ibis_params, cfg.ami_params, cfg.kFileBaseName, cfg.kDescription, out_dir=Path(py_file).parent)
+
+
+def mk_combs(dict_items):
+    """Make all combinations possible from a list of dictionary items.
+
+    Args:
+        dict_items([(str, [T])]): List of dictionary key/value pairs.
+            The values are lists.
+
+    Return:
+        [[(str, T)]]: List of all possible combinations of key values.
+    """
+    if not dict_items:
+        return [
+            [],
+        ]
+    head, *tail = dict_items
+    k, vs = head
+    kvals = [(k, v) for v in vs]
+    return [[kval] + l for kval in kvals for l in mk_combs(tail)]
+
+
+def mk_tests(test_defs, file_base_name, test_dir="test_runs"):
+    """Make the test run configuration files."""
+
+    pname = Path(test_dir).resolve()
+    pname.mkdir(exist_ok=True)
+    pname = (pname / file_base_name).resolve()
+    pname.mkdir(exist_ok=True)
+    for fname in test_defs.keys():
+        desc, ami_defs, sim_defs, ref_fstr = test_defs[fname]
+        ami_str, ami_dict = ami_defs
+        sim_str, sim_dict = sim_defs
+        with open((pname / fname).with_suffix(".run"), "w", encoding="utf-8") as f:
+            f.write(desc + "\n")
+            for ami_comb in mk_combs(ami_dict.items()):
+                for sim_comb in mk_combs(sim_dict.items()):
+                    try:
+                        pdict = dict(ami_comb)
+                        pdict.update(dict(sim_comb))
+                        f.write(f"\n('{ami_str.format(pdict=pdict)}_{sim_str.format(pdict=pdict)}', \\\n")
+                    except:
+                        print(f"ami_str: {ami_str}")
+                        print(f"sim_str: {sim_str}")
+                        print(f"pdict: {pdict}")
+                        raise
+                    f.write(f"  ({{'root_name': '{file_base_name}', \\\n")
+                    for k, v in ami_comb:
+                        f.write(f"    '{k}': {v}, \\\n")
+                    f.write("   }, \\\n")
+                    if sim_comb:
+                        head, *tail = sim_comb
+                        k, v = head
+                        f.write(f"   {{'{k}': {v}, \\\n")
+                        for k, v in tail:
+                            f.write(f"    '{k}': {v}, \\\n")
+                        f.write("   } \\\n")
+                    f.write("  ), \\\n")
+                    if ref_fstr:
+                        f.write(f"  '{ref_fstr.format(pdict=pdict)}', \\\n")
+                    f.write(")\n")
+
+
+# NOTE: The following is deprecated! Instead, make your model configurator executable
+#      and import what you need from this module. This is much cleaner.
 @click.command(context_settings=dict(help_option_names=["-h", "--help"]))
 @click.argument("py_file", type=click.Path(exists=True, resolve_path=True))
+@click.option(
+    "-d", "--test_dir", show_default=True, default="test_runs", help="Output directory for test run generation."
+)
 @click.version_option()
-def main(py_file):
+def main(py_file, **kwd_args):
     """Configure IBIS-AMI model C++ source code, IBIS model, and AMI file.
 
     This command generates three files based off the input config file.

{PyIBIS-AMI-5.1.1 → pyibis_ami-5.1.4}/src/pyibisami/ami/model.py

@@ -6,6 +6,7 @@ Original Date:   July 3, 2012
 
 Copyright (c) 2019 David Banas; All rights reserved World wide.
 """
+
 import copy as cp
 from ctypes import CDLL, byref, c_char_p, c_double
 from pathlib import Path
@@ -215,7 +216,12 @@ class AMIModel:
     """
 
     def __init__(self, filename):
-        """Load the dll and bind the 3 AMI functions."""
+        """
+        Load the dll and bind the 3 AMI functions.
+
+        Args:
+            filename(str): The DLL/SO file name.
+        """
 
         self._ami_mem_handle = None
         my_dll = CDLL(filename)

{PyIBIS-AMI-5.1.1 → pyibis_ami-5.1.4}/src/pyibisami/ami/parser.py

@@ -6,6 +6,7 @@ Original date:   December 17, 2016
 
 Copyright (c) 2019 David Banas; all rights reserved World wide.
 """
+
 import re
 
 from parsec import ParseError, generate, many, many1, regex, string

{PyIBIS-AMI-5.1.1 → pyibis_ami-5.1.4}/src/pyibisami/ibis/file.py

@@ -7,8 +7,8 @@ Original Date:   November 1, 2019
 For information regarding the IBIS modeling standard, visit:
 https://ibis.org/
 
-*Note:* The ``IBISModel`` class, defined here, needs to be kept separate from the
-other IBIS-related classes, defined in the ``ibis_model`` module, in order to
+**Note:** The ``IBISModel`` class, defined here, needs to be kept separate from the
+other IBIS-related classes, defined in the ``model`` module, in order to
 avoid circular imports.
 
 Copyright (c) 2019 by David Banas; All rights reserved World wide.
@@ -103,7 +103,7 @@ class IBISModel(HasTraits):
             ibis_file_name (str): The name of the IBIS file.
             is_tx (bool): True if this is a Tx model.
 
-        KeywordArgs:
+        Keyword Args:
             debug (bool): Output debugging info to console when true.
                 Default = False
             gui (bool): Set to `False` for command line and/or script usage.
@@ -164,6 +164,7 @@ class IBISModel(HasTraits):
         return f"IBIS Model '{self._model_dict['file_name']}'"
 
     def info(self):
+        """Basic information about the IBIS model."""
         res = ""
         try:
             for k in ["ibis_ver", "file_name", "file_rev"]:

{PyIBIS-AMI-5.1.1 → pyibis_ami-5.1.4}/src/pyibisami/ibis/model.py

@@ -25,7 +25,7 @@ class Component(HasTraits):
     def __init__(self, subDict):
         """
         Args:
-            subDict (dict): Dictionary of [Component] sub-keywords/params.
+            subDict(dict): Dictionary of [Component] sub-keywords/params.
         """
 
         # Super-class initialization is ABSOLUTELY NECESSARY, in order

{PyIBIS-AMI-5.1.1 → pyibis_ami-5.1.4}/src/pyibisami/ibis/parser.py

@@ -50,7 +50,7 @@ def logf(p, preStr=""):
     Args:
         p (Parser): The original parser.
 
-    KeywordArgs:
+    Keyword Args:
         preStr (str): A prefix string to use in failure message.
                       (Default = <empty string>)
     """
@@ -472,7 +472,7 @@ def parse_ibis_file(ibis_file_contents_str, debug=False):
     Args:
         ibis_file_contents_str (str): The contents of the IBIS file, as a single string.
 
-    KeywordArgs:
+    Keyword Args:
         debug (bool): Output debugging info to console when true.
             Default = False
 

PyIBIS-AMI-5.1.1/docs/source/intro.rst

@@ -1,4 +0,0 @@
-General description of *pyibisami* package.
--------------------------------------------
-
-.. automodule:: pyibisami

PyIBIS-AMI-5.1.1/docs/source/modules.rst

@@ -1,44 +0,0 @@
-Modules in *pyibisami* package
-------------------------------
-
-ami.model - IBIS-AMI model encapsulation.
-*****************************************
-
-.. automodule:: pyibisami.ami.model
-   :members:
-
-ami.parameter - IBIS-AMI parameter encapsulation.
-*************************************************
-
-.. automodule:: pyibisami.ami.parameter
-   :members:
-
-ami.parse - AMI file parsing utilities.
-***************************************
-
-.. automodule:: pyibisami.ami.parser
-   :members:
-
-ami.config - Automatic configuration of: IBIS, AMI, and DLL/SO files, from Python configuration file.
-*****************************************************************************************************
-
-.. automodule:: pyibisami.ami.config
-   :members:
-
-ibis.file - Encapsulation of an IBIS model file.
-************************************************
-
-.. automodule:: pyibisami.ibis.file
-   :members:
-
-ibis.model - Encapsulation of IBIS *Component* and *Model* keywords.
-********************************************************************
-
-.. automodule:: pyibisami.ibis.model
-   :members:
-
-ibis.parser - *Parsec* based parser for IBIS model files.
-*********************************************************
-
-.. automodule:: pyibisami.ibis.parser
-   :members: