pyibis-ami 7.2.0__tar.gz → 7.2.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/LICENSE +8 -8
  2. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/MANIFEST.in +7 -7
  3. {pyibis_ami-7.2.0/src/PyIBIS_AMI.egg-info → pyibis_ami-7.2.1}/PKG-INFO +134 -134
  4. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/README.md +97 -97
  5. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/docs/source/ami.rst +27 -27
  6. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/docs/source/conf.py +313 -313
  7. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/docs/source/ibis.rst +22 -22
  8. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/docs/source/index.rst +27 -27
  9. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/docs/source/install.rst +31 -31
  10. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/docs/source/modules.rst +12 -12
  11. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/docs/source/tools.rst +9 -9
  12. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/examples/all_taps.run +46 -46
  13. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/examples/bandwidth.run +23 -23
  14. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/examples/dummy.em +24 -24
  15. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/examples/examples.md +6 -6
  16. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/examples/freq_resp.em +103 -103
  17. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/examples/impulse.em +57 -57
  18. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/examples/mode.run +34 -34
  19. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/examples/stratix4_ami_tx_runs/all_taps.run +77 -77
  20. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/examples/stratix4_ami_tx_runs/test_results.xml +202 -202
  21. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/examples/test_results/test_results.xsl +42 -42
  22. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/pyproject.toml +101 -102
  23. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/setup.cfg +4 -4
  24. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1/src/pyibis_ami.egg-info}/PKG-INFO +134 -134
  25. {pyibis_ami-7.2.0/src/PyIBIS_AMI.egg-info → pyibis_ami-7.2.1/src/pyibis_ami.egg-info}/SOURCES.txt +0 -6
  26. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/src/pyibisami/IBIS_AMI_Checker.ipynb +1693 -1693
  27. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/src/pyibisami/IBIS_AMI_Tester.ipynb +1457 -1457
  28. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/src/pyibisami/__init__.py +22 -22
  29. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/src/pyibisami/__main__.py +7 -7
  30. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/src/pyibisami/ami/config.py +297 -297
  31. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/src/pyibisami/ami/generic.ami.em +20 -20
  32. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/src/pyibisami/ami/generic.ibs.em +139 -139
  33. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/src/pyibisami/ami/model.py +596 -596
  34. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/src/pyibisami/ami/parameter.py +316 -316
  35. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/src/pyibisami/ami/parser.py +674 -674
  36. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/src/pyibisami/ami/reserved_parameter_names.py +84 -84
  37. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/src/pyibisami/common.py +42 -42
  38. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/src/pyibisami/ibis/file.py +325 -325
  39. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/src/pyibisami/ibis/model.py +399 -399
  40. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/src/pyibisami/ibis/parser.py +525 -525
  41. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/src/pyibisami/tools/run_notebook.py +144 -144
  42. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/src/pyibisami/tools/run_tests.py +273 -273
  43. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/src/pyibisami/tools/test_results.xsl +42 -42
  44. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/tests/test_run_tests.py +139 -139
  45. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/examples/impulse_response_8ma.txt +0 -0
  46. {pyibis_ami-7.2.0/src/PyIBIS_AMI.egg-info → pyibis_ami-7.2.1/src/pyibis_ami.egg-info}/dependency_links.txt +0 -0
  47. {pyibis_ami-7.2.0/src/PyIBIS_AMI.egg-info → pyibis_ami-7.2.1/src/pyibis_ami.egg-info}/entry_points.txt +0 -0
  48. {pyibis_ami-7.2.0/src/PyIBIS_AMI.egg-info → pyibis_ami-7.2.1/src/pyibis_ami.egg-info}/requires.txt +0 -0
  49. {pyibis_ami-7.2.0/src/PyIBIS_AMI.egg-info → pyibis_ami-7.2.1/src/pyibis_ami.egg-info}/top_level.txt +0 -0
  50. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/src/pyibisami/ami/__init__.py +0 -0
  51. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/src/pyibisami/ibis/__init__.py +0 -0
  52. {pyibis_ami-7.2.0 → pyibis_ami-7.2.1}/src/pyibisami/tools/__init__.py +0 -0
@@ -1,8 +1,8 @@
1
- Copyright (c) 2012, David Banas
2
- All rights reserved World wide.
3
-
4
- Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
5
-
6
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
7
- 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.
8
- 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.
1
+ Copyright (c) 2012, David Banas
2
+ All rights reserved World wide.
3
+
4
+ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
5
+
6
+ Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
7
+ 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.
8
+ 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.
@@ -1,7 +1,7 @@
1
- include README.md
2
- include LICENSE
3
- include src/pyibisami/tools/test_results.xsl
4
- include src/pyibisami/ami/generic.ami.em
5
- include src/pyibisami/ami/generic.ibs.em
6
- recursive-include docs/source *
7
- recursive-include examples *
1
+ include README.md
2
+ include LICENSE
3
+ include src/pyibisami/tools/test_results.xsl
4
+ include src/pyibisami/ami/generic.ami.em
5
+ include src/pyibisami/ami/generic.ibs.em
6
+ recursive-include docs/source *
7
+ recursive-include examples *
@@ -1,134 +1,134 @@
1
- Metadata-Version: 2.2
2
- Name: pyibis-ami
3
- Version: 7.2.0
4
- Summary: Facilitates working directly with IBIS-AMI DLLs from the Python command prompt.
5
- Author-email: David Banas <capn.freako@gmail.com>
6
- License: BSD
7
- Project-URL: Documentation, https://pyibis-ami.readthedocs.io/en/latest/
8
- Project-URL: Wiki, https://github.com/capn-freako/PyAMI/wiki
9
- Project-URL: GitHub, https://github.com/capn-freako/PyAMI
10
- Project-URL: PyPi, https://pypi.org/project/PyIBIS-AMI/
11
- Keywords: ibis-ami
12
- Classifier: Development Status :: 5 - Production/Stable
13
- Classifier: Environment :: Console
14
- Classifier: Intended Audience :: Developers
15
- Classifier: License :: OSI Approved :: BSD License
16
- Classifier: Operating System :: OS Independent
17
- Classifier: Programming Language :: Python
18
- Classifier: Programming Language :: Python :: 3
19
- Classifier: Programming Language :: Python :: 3.10
20
- Classifier: Programming Language :: Python :: 3.11
21
- Classifier: Programming Language :: Python :: 3.12
22
- Classifier: Programming Language :: Python :: Implementation :: CPython
23
- Classifier: Topic :: System :: Emulators
24
- Classifier: Topic :: Utilities
25
- Requires-Python: <3.13,>=3.10
26
- Description-Content-Type: text/markdown
27
- License-File: LICENSE
28
- Requires-Dist: chaco>=6.0.0
29
- Requires-Dist: click>=8.1.3
30
- Requires-Dist: empy>=3.3.4
31
- Requires-Dist: importlib_resources
32
- Requires-Dist: matplotlib>=3.6.1
33
- Requires-Dist: numpy<1.27,>=1.26
34
- Requires-Dist: papermill
35
- Requires-Dist: parsec>=3.15
36
- Requires-Dist: scipy>=1.9
37
-
38
- [![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)
39
-
40
- # PyIBIS-AMI
41
-
42
- PyIBIS-AMI is a Python package of tools useful in the development and testing of IBIS-AMI models.
43
- This library is used in [PyBERT](https://github.com/capn-freako/PyBERT) and also provides two
44
- command line applications.
45
-
46
- It can be installed via: `pip install PyIBIS-AMI`.
47
-
48
- [View API/Developer's Documentation.](https://pyibis-ami.readthedocs.io/en/latest/)
49
-
50
- ## Command Line Tools
51
-
52
- ### Run IBIS-AMI Model Testing Notebook
53
-
54
- ```shell
55
- $ run-notebook -h
56
- Usage: run-notebook [OPTIONS] IBIS_FILE BIT_RATE
57
-
58
- Run a *Jupyter* notebook on an IBIS-AMI model file.
59
-
60
- Options:
61
- -n, --notebook PATH Override the default notebook file name.
62
- -o, --out-dir PATH Override the name of the directory in which to place
63
- the results.
64
- -p, --params TEXT Directory (or, file) containing configuration sweeps.
65
- --debug Provide extra debugging information.
66
- --is_tx Flags a Tx model.
67
- --nspui INTEGER Number of samples per unit interval. [default: 32]
68
- --nbits INTEGER Number of bits to run in simulations. [default: 200]
69
- --plot-t-max FLOAT Maximum time value for plots (s). [default: 5e-10]
70
- --f-max FLOAT Maximum frequency for transfer functions (Hz).
71
- [default: 40000000000.0]
72
- --f-step FLOAT Frequency step for transfer functions (Hz). [default:
73
- 10000000.0]
74
- --fig-x INTEGER x-dimmension for plot figures (in). [default: 10]
75
- --fig-y INTEGER y-dimmension for plot figures (in). [default: 3]
76
- --version Show the version and exit.
77
- -h, --help Show this message and exit.
78
- ```
79
-
80
- ### AMI Config
81
-
82
- ```shell
83
- ami_config -h
84
- Usage: ami_config [OPTIONS] PY_FILE
85
-
86
- Configure IBIS-AMI model C++ source code, IBIS model, and AMI file.
87
-
88
- py_file: name of model configuration file (*.py)
89
-
90
- Options:
91
- -h, --help Show this message and exit.
92
- ```
93
-
94
- ### Run Tests
95
-
96
- ```shell
97
- run_tests -h
98
- Usage: run_tests [OPTIONS] [TESTS]...
99
-
100
- Run a series of tests on a AMI model DLL file.
101
-
102
- If no tests are specified on the command line, run all tests found in
103
- `test_dir'. (See `-t' option.)
104
-
105
- usage: %prog [options] [test1 [test2 ...]]
106
-
107
- Tests are written in the EmPy templating language, and produce XML output.
108
- (See the examples provided in the `examples' directory of the `pyibisami'
109
- Python package.)
110
-
111
- Test results should be viewed by loading the XML output file into a Web
112
- browser. By default, the XML output file refers to the supplied XSLT file,
113
- `test_results.xsl'. It is possible that you may need to copy this file
114
- from the pyibisami package directory to your local working directory, in
115
- order to avoid file loading errors in your Web browser.
116
-
117
- Options:
118
- -t, --test_dir PATH Sets the name of the directory from which tests are
119
- taken.
120
- -m, --model PATH Sets the AMI model DLL file name.
121
- -p, --params TEXT List of lists of model configurations. Format:
122
- <filename> or [(name, [(label, ({AMI params., in
123
- "key:val" format},{Model params., in "key:val"
124
- format})), ...]), ...]
125
- -x, --xml_file PATH Sets the name of the XML output file. You should load
126
- this file into your Web browser after the program
127
- completion.
128
- -r, --ref_dir PATH Sets the name of the directory from which reference
129
- waveforms are taken.
130
- -o, --out_dir PATH Sets the name of the directory in which to place the
131
- results.
132
- -v, --version TEXT Show program version info and exit.
133
- -h, --help Show this message and exit.
134
- ```
1
+ Metadata-Version: 2.4
2
+ Name: pyibis-ami
3
+ Version: 7.2.1
4
+ Summary: Facilitates working directly with IBIS-AMI DLLs from the Python command prompt.
5
+ Author-email: David Banas <capn.freako@gmail.com>
6
+ License-Expression: BSD-3-Clause
7
+ Project-URL: Documentation, https://pyibis-ami.readthedocs.io/en/latest/
8
+ Project-URL: Wiki, https://github.com/capn-freako/PyAMI/wiki
9
+ Project-URL: GitHub, https://github.com/capn-freako/PyAMI
10
+ Project-URL: PyPi, https://pypi.org/project/PyIBIS-AMI/
11
+ Keywords: ibis-ami
12
+ Classifier: Development Status :: 5 - Production/Stable
13
+ Classifier: Environment :: Console
14
+ Classifier: Intended Audience :: Developers
15
+ Classifier: Operating System :: OS Independent
16
+ Classifier: Programming Language :: Python
17
+ Classifier: Programming Language :: Python :: 3
18
+ Classifier: Programming Language :: Python :: 3.10
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Classifier: Programming Language :: Python :: Implementation :: CPython
22
+ Classifier: Topic :: System :: Emulators
23
+ Classifier: Topic :: Utilities
24
+ Requires-Python: <3.13,>=3.10
25
+ Description-Content-Type: text/markdown
26
+ License-File: LICENSE
27
+ Requires-Dist: chaco>=6.0.0
28
+ Requires-Dist: click>=8.1.3
29
+ Requires-Dist: empy>=3.3.4
30
+ Requires-Dist: importlib_resources
31
+ Requires-Dist: matplotlib>=3.6.1
32
+ Requires-Dist: numpy<1.27,>=1.26
33
+ Requires-Dist: papermill
34
+ Requires-Dist: parsec>=3.15
35
+ Requires-Dist: scipy>=1.9
36
+ Dynamic: license-file
37
+
38
+ [![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)
39
+
40
+ # PyIBIS-AMI
41
+
42
+ PyIBIS-AMI is a Python package of tools useful in the development and testing of IBIS-AMI models.
43
+ This library is used in [PyBERT](https://github.com/capn-freako/PyBERT) and also provides two
44
+ command line applications.
45
+
46
+ It can be installed via: `pip install PyIBIS-AMI`.
47
+
48
+ [View API/Developer's Documentation.](https://pyibis-ami.readthedocs.io/en/latest/)
49
+
50
+ ## Command Line Tools
51
+
52
+ ### Run IBIS-AMI Model Testing Notebook
53
+
54
+ ```shell
55
+ $ run-notebook -h
56
+ Usage: run-notebook [OPTIONS] IBIS_FILE BIT_RATE
57
+
58
+ Run a *Jupyter* notebook on an IBIS-AMI model file.
59
+
60
+ Options:
61
+ -n, --notebook PATH Override the default notebook file name.
62
+ -o, --out-dir PATH Override the name of the directory in which to place
63
+ the results.
64
+ -p, --params TEXT Directory (or, file) containing configuration sweeps.
65
+ --debug Provide extra debugging information.
66
+ --is_tx Flags a Tx model.
67
+ --nspui INTEGER Number of samples per unit interval. [default: 32]
68
+ --nbits INTEGER Number of bits to run in simulations. [default: 200]
69
+ --plot-t-max FLOAT Maximum time value for plots (s). [default: 5e-10]
70
+ --f-max FLOAT Maximum frequency for transfer functions (Hz).
71
+ [default: 40000000000.0]
72
+ --f-step FLOAT Frequency step for transfer functions (Hz). [default:
73
+ 10000000.0]
74
+ --fig-x INTEGER x-dimmension for plot figures (in). [default: 10]
75
+ --fig-y INTEGER y-dimmension for plot figures (in). [default: 3]
76
+ --version Show the version and exit.
77
+ -h, --help Show this message and exit.
78
+ ```
79
+
80
+ ### AMI Config
81
+
82
+ ```shell
83
+ ami_config -h
84
+ Usage: ami_config [OPTIONS] PY_FILE
85
+
86
+ Configure IBIS-AMI model C++ source code, IBIS model, and AMI file.
87
+
88
+ py_file: name of model configuration file (*.py)
89
+
90
+ Options:
91
+ -h, --help Show this message and exit.
92
+ ```
93
+
94
+ ### Run Tests
95
+
96
+ ```shell
97
+ run_tests -h
98
+ Usage: run_tests [OPTIONS] [TESTS]...
99
+
100
+ Run a series of tests on a AMI model DLL file.
101
+
102
+ If no tests are specified on the command line, run all tests found in
103
+ `test_dir'. (See `-t' option.)
104
+
105
+ usage: %prog [options] [test1 [test2 ...]]
106
+
107
+ Tests are written in the EmPy templating language, and produce XML output.
108
+ (See the examples provided in the `examples' directory of the `pyibisami'
109
+ Python package.)
110
+
111
+ Test results should be viewed by loading the XML output file into a Web
112
+ browser. By default, the XML output file refers to the supplied XSLT file,
113
+ `test_results.xsl'. It is possible that you may need to copy this file
114
+ from the pyibisami package directory to your local working directory, in
115
+ order to avoid file loading errors in your Web browser.
116
+
117
+ Options:
118
+ -t, --test_dir PATH Sets the name of the directory from which tests are
119
+ taken.
120
+ -m, --model PATH Sets the AMI model DLL file name.
121
+ -p, --params TEXT List of lists of model configurations. Format:
122
+ <filename> or [(name, [(label, ({AMI params., in
123
+ "key:val" format},{Model params., in "key:val"
124
+ format})), ...]), ...]
125
+ -x, --xml_file PATH Sets the name of the XML output file. You should load
126
+ this file into your Web browser after the program
127
+ completion.
128
+ -r, --ref_dir PATH Sets the name of the directory from which reference
129
+ waveforms are taken.
130
+ -o, --out_dir PATH Sets the name of the directory in which to place the
131
+ results.
132
+ -v, --version TEXT Show program version info and exit.
133
+ -h, --help Show this message and exit.
134
+ ```
@@ -1,97 +1,97 @@
1
- [![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)
2
-
3
- # PyIBIS-AMI
4
-
5
- PyIBIS-AMI is a Python package of tools useful in the development and testing of IBIS-AMI models.
6
- This library is used in [PyBERT](https://github.com/capn-freako/PyBERT) and also provides two
7
- command line applications.
8
-
9
- It can be installed via: `pip install PyIBIS-AMI`.
10
-
11
- [View API/Developer's Documentation.](https://pyibis-ami.readthedocs.io/en/latest/)
12
-
13
- ## Command Line Tools
14
-
15
- ### Run IBIS-AMI Model Testing Notebook
16
-
17
- ```shell
18
- $ run-notebook -h
19
- Usage: run-notebook [OPTIONS] IBIS_FILE BIT_RATE
20
-
21
- Run a *Jupyter* notebook on an IBIS-AMI model file.
22
-
23
- Options:
24
- -n, --notebook PATH Override the default notebook file name.
25
- -o, --out-dir PATH Override the name of the directory in which to place
26
- the results.
27
- -p, --params TEXT Directory (or, file) containing configuration sweeps.
28
- --debug Provide extra debugging information.
29
- --is_tx Flags a Tx model.
30
- --nspui INTEGER Number of samples per unit interval. [default: 32]
31
- --nbits INTEGER Number of bits to run in simulations. [default: 200]
32
- --plot-t-max FLOAT Maximum time value for plots (s). [default: 5e-10]
33
- --f-max FLOAT Maximum frequency for transfer functions (Hz).
34
- [default: 40000000000.0]
35
- --f-step FLOAT Frequency step for transfer functions (Hz). [default:
36
- 10000000.0]
37
- --fig-x INTEGER x-dimmension for plot figures (in). [default: 10]
38
- --fig-y INTEGER y-dimmension for plot figures (in). [default: 3]
39
- --version Show the version and exit.
40
- -h, --help Show this message and exit.
41
- ```
42
-
43
- ### AMI Config
44
-
45
- ```shell
46
- ami_config -h
47
- Usage: ami_config [OPTIONS] PY_FILE
48
-
49
- Configure IBIS-AMI model C++ source code, IBIS model, and AMI file.
50
-
51
- py_file: name of model configuration file (*.py)
52
-
53
- Options:
54
- -h, --help Show this message and exit.
55
- ```
56
-
57
- ### Run Tests
58
-
59
- ```shell
60
- run_tests -h
61
- Usage: run_tests [OPTIONS] [TESTS]...
62
-
63
- Run a series of tests on a AMI model DLL file.
64
-
65
- If no tests are specified on the command line, run all tests found in
66
- `test_dir'. (See `-t' option.)
67
-
68
- usage: %prog [options] [test1 [test2 ...]]
69
-
70
- Tests are written in the EmPy templating language, and produce XML output.
71
- (See the examples provided in the `examples' directory of the `pyibisami'
72
- Python package.)
73
-
74
- Test results should be viewed by loading the XML output file into a Web
75
- browser. By default, the XML output file refers to the supplied XSLT file,
76
- `test_results.xsl'. It is possible that you may need to copy this file
77
- from the pyibisami package directory to your local working directory, in
78
- order to avoid file loading errors in your Web browser.
79
-
80
- Options:
81
- -t, --test_dir PATH Sets the name of the directory from which tests are
82
- taken.
83
- -m, --model PATH Sets the AMI model DLL file name.
84
- -p, --params TEXT List of lists of model configurations. Format:
85
- <filename> or [(name, [(label, ({AMI params., in
86
- "key:val" format},{Model params., in "key:val"
87
- format})), ...]), ...]
88
- -x, --xml_file PATH Sets the name of the XML output file. You should load
89
- this file into your Web browser after the program
90
- completion.
91
- -r, --ref_dir PATH Sets the name of the directory from which reference
92
- waveforms are taken.
93
- -o, --out_dir PATH Sets the name of the directory in which to place the
94
- results.
95
- -v, --version TEXT Show program version info and exit.
96
- -h, --help Show this message and exit.
97
- ```
1
+ [![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)
2
+
3
+ # PyIBIS-AMI
4
+
5
+ PyIBIS-AMI is a Python package of tools useful in the development and testing of IBIS-AMI models.
6
+ This library is used in [PyBERT](https://github.com/capn-freako/PyBERT) and also provides two
7
+ command line applications.
8
+
9
+ It can be installed via: `pip install PyIBIS-AMI`.
10
+
11
+ [View API/Developer's Documentation.](https://pyibis-ami.readthedocs.io/en/latest/)
12
+
13
+ ## Command Line Tools
14
+
15
+ ### Run IBIS-AMI Model Testing Notebook
16
+
17
+ ```shell
18
+ $ run-notebook -h
19
+ Usage: run-notebook [OPTIONS] IBIS_FILE BIT_RATE
20
+
21
+ Run a *Jupyter* notebook on an IBIS-AMI model file.
22
+
23
+ Options:
24
+ -n, --notebook PATH Override the default notebook file name.
25
+ -o, --out-dir PATH Override the name of the directory in which to place
26
+ the results.
27
+ -p, --params TEXT Directory (or, file) containing configuration sweeps.
28
+ --debug Provide extra debugging information.
29
+ --is_tx Flags a Tx model.
30
+ --nspui INTEGER Number of samples per unit interval. [default: 32]
31
+ --nbits INTEGER Number of bits to run in simulations. [default: 200]
32
+ --plot-t-max FLOAT Maximum time value for plots (s). [default: 5e-10]
33
+ --f-max FLOAT Maximum frequency for transfer functions (Hz).
34
+ [default: 40000000000.0]
35
+ --f-step FLOAT Frequency step for transfer functions (Hz). [default:
36
+ 10000000.0]
37
+ --fig-x INTEGER x-dimmension for plot figures (in). [default: 10]
38
+ --fig-y INTEGER y-dimmension for plot figures (in). [default: 3]
39
+ --version Show the version and exit.
40
+ -h, --help Show this message and exit.
41
+ ```
42
+
43
+ ### AMI Config
44
+
45
+ ```shell
46
+ ami_config -h
47
+ Usage: ami_config [OPTIONS] PY_FILE
48
+
49
+ Configure IBIS-AMI model C++ source code, IBIS model, and AMI file.
50
+
51
+ py_file: name of model configuration file (*.py)
52
+
53
+ Options:
54
+ -h, --help Show this message and exit.
55
+ ```
56
+
57
+ ### Run Tests
58
+
59
+ ```shell
60
+ run_tests -h
61
+ Usage: run_tests [OPTIONS] [TESTS]...
62
+
63
+ Run a series of tests on a AMI model DLL file.
64
+
65
+ If no tests are specified on the command line, run all tests found in
66
+ `test_dir'. (See `-t' option.)
67
+
68
+ usage: %prog [options] [test1 [test2 ...]]
69
+
70
+ Tests are written in the EmPy templating language, and produce XML output.
71
+ (See the examples provided in the `examples' directory of the `pyibisami'
72
+ Python package.)
73
+
74
+ Test results should be viewed by loading the XML output file into a Web
75
+ browser. By default, the XML output file refers to the supplied XSLT file,
76
+ `test_results.xsl'. It is possible that you may need to copy this file
77
+ from the pyibisami package directory to your local working directory, in
78
+ order to avoid file loading errors in your Web browser.
79
+
80
+ Options:
81
+ -t, --test_dir PATH Sets the name of the directory from which tests are
82
+ taken.
83
+ -m, --model PATH Sets the AMI model DLL file name.
84
+ -p, --params TEXT List of lists of model configurations. Format:
85
+ <filename> or [(name, [(label, ({AMI params., in
86
+ "key:val" format},{Model params., in "key:val"
87
+ format})), ...]), ...]
88
+ -x, --xml_file PATH Sets the name of the XML output file. You should load
89
+ this file into your Web browser after the program
90
+ completion.
91
+ -r, --ref_dir PATH Sets the name of the directory from which reference
92
+ waveforms are taken.
93
+ -o, --out_dir PATH Sets the name of the directory in which to place the
94
+ results.
95
+ -v, --version TEXT Show program version info and exit.
96
+ -h, --help Show this message and exit.
97
+ ```
@@ -1,27 +1,27 @@
1
- pyibisami.ami
2
- =============
3
-
4
- AMI related submodules in the *PyIBIS-AMI* package.
5
-
6
- config
7
- ------
8
-
9
- .. automodule:: pyibisami.ami.config
10
-
11
- model
12
- -----
13
-
14
- .. automodule:: pyibisami.ami.model
15
-
16
- parameter
17
- ---------
18
-
19
- .. automodule:: pyibisami.ami.parameter
20
-
21
- parser
22
- ------
23
-
24
- Sorry, the code in this module breaks the *Sphinx* ``autodoc`` processor.
25
- So, we have to exclude it from these docs.
26
- You'll have to peruse the comments in the code, manually.
27
- See the ``pyibisami/ami/parser.py`` file.
1
+ pyibisami.ami
2
+ =============
3
+
4
+ AMI related submodules in the *PyIBIS-AMI* package.
5
+
6
+ config
7
+ ------
8
+
9
+ .. automodule:: pyibisami.ami.config
10
+
11
+ model
12
+ -----
13
+
14
+ .. automodule:: pyibisami.ami.model
15
+
16
+ parameter
17
+ ---------
18
+
19
+ .. automodule:: pyibisami.ami.parameter
20
+
21
+ parser
22
+ ------
23
+
24
+ Sorry, the code in this module breaks the *Sphinx* ``autodoc`` processor.
25
+ So, we have to exclude it from these docs.
26
+ You'll have to peruse the comments in the code, manually.
27
+ See the ``pyibisami/ami/parser.py`` file.