PyIBIS-AMI 6.2.0__tar.gz → 6.2.1__tar.gz

{pyibis_ami-6.2.0 → pyibis_ami-6.2.1}/LICENSE

@@ -1,8 +1,8 @@
-Copyright (c) 2012, David Banas
-All rights reserved World wide.
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+Copyright (c) 2012, David Banas
+All rights reserved World wide.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

{pyibis_ami-6.2.0 → pyibis_ami-6.2.1}/MANIFEST.in

@@ -1,7 +1,7 @@
-include README.md
-include LICENSE
-include src/pyibisami/tools/test_results.xsl
-include src/pyibisami/ami/generic.ami.em
-include src/pyibisami/ami/generic.ibs.em
-recursive-include docs/source *
-recursive-include examples *
+include README.md
+include LICENSE
+include src/pyibisami/tools/test_results.xsl
+include src/pyibisami/ami/generic.ami.em
+include src/pyibisami/ami/generic.ibs.em
+recursive-include docs/source *
+recursive-include examples *

{pyibis_ami-6.2.0/src/PyIBIS_AMI.egg-info → pyibis_ami-6.2.1}/PKG-INFO

@@ -1,106 +1,134 @@
-Metadata-Version: 2.1
-Name: PyIBIS-AMI
-Version: 6.2.0
-Summary: Facilitates working directly with IBIS-AMI DLLs from the Python command prompt.
-Author: David Patterson
-Author-email: David Banas <capn.freako@gmail.com>
-License: BSD
-Project-URL: Documentation, https://pyibis-ami.readthedocs.io/en/latest/
-Project-URL: Wiki, https://github.com/capn-freako/PyAMI/wiki
-Project-URL: GitHub, https://github.com/capn-freako/PyAMI
-Project-URL: PyPi, https://pypi.org/project/PyIBIS-AMI/
-Keywords: ibis-ami
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Environment :: Console
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Topic :: System :: Emulators
-Classifier: Topic :: Utilities
-Requires-Python: <3.13,>=3.9
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: chaco>=6.0.0
-Requires-Dist: click>=8.1.3
-Requires-Dist: empy>=3.3.4
-Requires-Dist: importlib_resources
-Requires-Dist: matplotlib>=3.6.1
-Requires-Dist: numpy<1.27,>=1.26
-Requires-Dist: parsec>=3.15
-Requires-Dist: scipy>=1.9
-
-[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/capn-freako/PyAMI/master.svg)](https://results.pre-commit.ci/latest/github/capn-freako/PyAMI/master)
-
-# 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
-command line applications.
-
-It can be installed via: `pip install PyIBIS-AMI`.
-
-[View API/Developer's Documentation.](https://pyibis-ami.readthedocs.io/en/latest/)
-
-## Command Line Tools
-
-### 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)
-
-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.)
-
-  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'
-  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
-  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.
-  -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
-                       "key:val" format},{Model params., in "key:val"
-                       format})), ...]), ...]
-  -x, --xml_file PATH  Sets the name of the XML output file. You should load
-                       this file into your Web browser after the program
-                       completion.
-  -r, --ref_dir PATH   Sets the name of the directory from which reference
-                       waveforms are taken.
-  -o, --out_dir PATH   Sets the name of the directory in which to place the
-                       results.
-  -v, --version TEXT   Show program version info and exit.
-  -h, --help           Show this message and exit.
-  ```
+Metadata-Version: 2.2
+Name: PyIBIS-AMI
+Version: 6.2.1
+Summary: Facilitates working directly with IBIS-AMI DLLs from the Python command prompt.
+Author-email: David Banas <capn.freako@gmail.com>
+License: BSD
+Project-URL: Documentation, https://pyibis-ami.readthedocs.io/en/latest/
+Project-URL: Wiki, https://github.com/capn-freako/PyAMI/wiki
+Project-URL: GitHub, https://github.com/capn-freako/PyAMI
+Project-URL: PyPi, https://pypi.org/project/PyIBIS-AMI/
+Keywords: ibis-ami
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: System :: Emulators
+Classifier: Topic :: Utilities
+Requires-Python: <3.13,>=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: chaco>=6.0.0
+Requires-Dist: click>=8.1.3
+Requires-Dist: empy>=3.3.4
+Requires-Dist: importlib_resources
+Requires-Dist: matplotlib>=3.6.1
+Requires-Dist: numpy<1.27,>=1.26
+Requires-Dist: papermill
+Requires-Dist: parsec>=3.15
+Requires-Dist: scipy>=1.9
+
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/capn-freako/PyAMI/master.svg)](https://results.pre-commit.ci/latest/github/capn-freako/PyAMI/master)
+
+# 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
+command line applications.
+
+It can be installed via: `pip install PyIBIS-AMI`.
+
+[View API/Developer's Documentation.](https://pyibis-ami.readthedocs.io/en/latest/)
+
+## Command Line Tools
+
+### Run IBIS-AMI Model Testing Notebook
+
+```shell
+$ run-notebook -h
+Usage: run-notebook [OPTIONS] IBIS_FILE BIT_RATE
+
+  Run a *Jupyter* notebook on an IBIS-AMI model file.
+
+Options:
+  -n, --notebook PATH  Override the default notebook file name.
+  -o, --out-dir PATH   Override the name of the directory in which to place
+                       the results.
+  -p, --params TEXT    Directory (or, file) containing configuration sweeps.
+  --debug              Provide extra debugging information.
+  --is_tx              Flags a Tx model.
+  --nspui INTEGER      Number of samples per unit interval.  [default: 32]
+  --nbits INTEGER      Number of bits to run in simulations.  [default: 200]
+  --plot-t-max FLOAT   Maximum time value for plots (s).  [default: 5e-10]
+  --f-max FLOAT        Maximum frequency for transfer functions (Hz).
+                       [default: 40000000000.0]
+  --f-step FLOAT       Frequency step for transfer functions (Hz).  [default:
+                       10000000.0]
+  --fig-x INTEGER      x-dimmension for plot figures (in).  [default: 10]
+  --fig-y INTEGER      y-dimmension for plot figures (in).  [default: 3]
+  --version            Show the version and exit.
+  -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)
+
+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.)
+
+  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'
+  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
+  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.
+  -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
+                       "key:val" format},{Model params., in "key:val"
+                       format})), ...]), ...]
+  -x, --xml_file PATH  Sets the name of the XML output file. You should load
+                       this file into your Web browser after the program
+                       completion.
+  -r, --ref_dir PATH   Sets the name of the directory from which reference
+                       waveforms are taken.
+  -o, --out_dir PATH   Sets the name of the directory in which to place the
+                       results.
+  -v, --version TEXT   Show program version info and exit.
+  -h, --help           Show this message and exit.
+  ```

{pyibis_ami-6.2.0 → pyibis_ami-6.2.1}/README.md

@@ -1,69 +1,97 @@
-[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/capn-freako/PyAMI/master.svg)](https://results.pre-commit.ci/latest/github/capn-freako/PyAMI/master)
-
-# 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
-command line applications.
-
-It can be installed via: `pip install PyIBIS-AMI`.
-
-[View API/Developer's Documentation.](https://pyibis-ami.readthedocs.io/en/latest/)
-
-## Command Line Tools
-
-### 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)
-
-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.)
-
-  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'
-  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
-  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.
-  -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
-                       "key:val" format},{Model params., in "key:val"
-                       format})), ...]), ...]
-  -x, --xml_file PATH  Sets the name of the XML output file. You should load
-                       this file into your Web browser after the program
-                       completion.
-  -r, --ref_dir PATH   Sets the name of the directory from which reference
-                       waveforms are taken.
-  -o, --out_dir PATH   Sets the name of the directory in which to place the
-                       results.
-  -v, --version TEXT   Show program version info and exit.
-  -h, --help           Show this message and exit.
-  ```
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/capn-freako/PyAMI/master.svg)](https://results.pre-commit.ci/latest/github/capn-freako/PyAMI/master)
+
+# 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
+command line applications.
+
+It can be installed via: `pip install PyIBIS-AMI`.
+
+[View API/Developer's Documentation.](https://pyibis-ami.readthedocs.io/en/latest/)
+
+## Command Line Tools
+
+### Run IBIS-AMI Model Testing Notebook
+
+```shell
+$ run-notebook -h
+Usage: run-notebook [OPTIONS] IBIS_FILE BIT_RATE
+
+  Run a *Jupyter* notebook on an IBIS-AMI model file.
+
+Options:
+  -n, --notebook PATH  Override the default notebook file name.
+  -o, --out-dir PATH   Override the name of the directory in which to place
+                       the results.
+  -p, --params TEXT    Directory (or, file) containing configuration sweeps.
+  --debug              Provide extra debugging information.
+  --is_tx              Flags a Tx model.
+  --nspui INTEGER      Number of samples per unit interval.  [default: 32]
+  --nbits INTEGER      Number of bits to run in simulations.  [default: 200]
+  --plot-t-max FLOAT   Maximum time value for plots (s).  [default: 5e-10]
+  --f-max FLOAT        Maximum frequency for transfer functions (Hz).
+                       [default: 40000000000.0]
+  --f-step FLOAT       Frequency step for transfer functions (Hz).  [default:
+                       10000000.0]
+  --fig-x INTEGER      x-dimmension for plot figures (in).  [default: 10]
+  --fig-y INTEGER      y-dimmension for plot figures (in).  [default: 3]
+  --version            Show the version and exit.
+  -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)
+
+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.)
+
+  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'
+  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
+  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.
+  -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
+                       "key:val" format},{Model params., in "key:val"
+                       format})), ...]), ...]
+  -x, --xml_file PATH  Sets the name of the XML output file. You should load
+                       this file into your Web browser after the program
+                       completion.
+  -r, --ref_dir PATH   Sets the name of the directory from which reference
+                       waveforms are taken.
+  -o, --out_dir PATH   Sets the name of the directory in which to place the
+                       results.
+  -v, --version TEXT   Show program version info and exit.
+  -h, --help           Show this message and exit.
+  ```

{pyibis_ami-6.2.0 → pyibis_ami-6.2.1}/docs/source/ami.rst

@@ -1,24 +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
+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