| Name | PyIBIS-AMI JSON |
| Version |
6.2.2
JSON |
| download |
| home_page | None |
| Summary | Facilitates working directly with IBIS-AMI DLLs from the Python command prompt. |
| upload_time | 2025-02-23 13:57:21 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.13,>=3.9 |
| license | BSD |
| keywords |
ibis-ami
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](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.
```
Raw data
{
"_id": null,
"home_page": null,
"name": "PyIBIS-AMI",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": null,
"keywords": "ibis-ami",
"author": null,
"author_email": "David Banas <capn.freako@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/72/3c/28866d52c300e58d7ed452c417899f4fc9186f8bdf66e7a55c28eea155af/pyibis_ami-6.2.2.tar.gz",
"platform": null,
"description": "[](https://results.pre-commit.ci/latest/github/capn-freako/PyAMI/master)\n\n# PyIBIS-AMI\n\nPyIBIS-AMI is a Python package of tools useful in the development and testing of IBIS-AMI models.\nThis library is used in [PyBERT](https://github.com/capn-freako/PyBERT) and also provides two\ncommand line applications.\n\nIt can be installed via: `pip install PyIBIS-AMI`.\n\n[View API/Developer's Documentation.](https://pyibis-ami.readthedocs.io/en/latest/)\n\n## Command Line Tools\n\n### Run IBIS-AMI Model Testing Notebook\n\n```shell\n$ run-notebook -h\nUsage: run-notebook [OPTIONS] IBIS_FILE BIT_RATE\n\n Run a *Jupyter* notebook on an IBIS-AMI model file.\n\nOptions:\n -n, --notebook PATH Override the default notebook file name.\n -o, --out-dir PATH Override the name of the directory in which to place\n the results.\n -p, --params TEXT Directory (or, file) containing configuration sweeps.\n --debug Provide extra debugging information.\n --is_tx Flags a Tx model.\n --nspui INTEGER Number of samples per unit interval. [default: 32]\n --nbits INTEGER Number of bits to run in simulations. [default: 200]\n --plot-t-max FLOAT Maximum time value for plots (s). [default: 5e-10]\n --f-max FLOAT Maximum frequency for transfer functions (Hz).\n [default: 40000000000.0]\n --f-step FLOAT Frequency step for transfer functions (Hz). [default:\n 10000000.0]\n --fig-x INTEGER x-dimmension for plot figures (in). [default: 10]\n --fig-y INTEGER y-dimmension for plot figures (in). [default: 3]\n --version Show the version and exit.\n -h, --help Show this message and exit.\n```\n\n### AMI Config\n\n```shell\nami_config -h\nUsage: ami_config [OPTIONS] PY_FILE\n\n Configure IBIS-AMI model C++ source code, IBIS model, and AMI file.\n\n py_file: name of model configuration file (*.py)\n\nOptions:\n -h, --help Show this message and exit.\n```\n\n### Run Tests\n\n```shell\nrun_tests -h\nUsage: run_tests [OPTIONS] [TESTS]...\n\n Run a series of tests on a AMI model DLL file.\n\n If no tests are specified on the command line, run all tests found in\n `test_dir'. (See `-t' option.)\n\n usage: %prog [options] [test1 [test2 ...]]\n\n Tests are written in the EmPy templating language, and produce XML output.\n (See the examples provided in the `examples' directory of the `pyibisami'\n Python package.)\n\n Test results should be viewed by loading the XML output file into a Web\n browser. By default, the XML output file refers to the supplied XSLT file,\n `test_results.xsl'. It is possible that you may need to copy this file\n from the pyibisami package directory to your local working directory, in\n order to avoid file loading errors in your Web browser.\n\nOptions:\n -t, --test_dir PATH Sets the name of the directory from which tests are\n taken.\n -m, --model PATH Sets the AMI model DLL file name.\n -p, --params TEXT List of lists of model configurations. Format:\n <filename> or [(name, [(label, ({AMI params., in\n \"key:val\" format},{Model params., in \"key:val\"\n format})), ...]), ...]\n -x, --xml_file PATH Sets the name of the XML output file. You should load\n this file into your Web browser after the program\n completion.\n -r, --ref_dir PATH Sets the name of the directory from which reference\n waveforms are taken.\n -o, --out_dir PATH Sets the name of the directory in which to place the\n results.\n -v, --version TEXT Show program version info and exit.\n -h, --help Show this message and exit.\n ```\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Facilitates working directly with IBIS-AMI DLLs from the Python command prompt.",
"version": "6.2.2",
"project_urls": {
"Documentation": "https://pyibis-ami.readthedocs.io/en/latest/",
"GitHub": "https://github.com/capn-freako/PyAMI",
"PyPi": "https://pypi.org/project/PyIBIS-AMI/",
"Wiki": "https://github.com/capn-freako/PyAMI/wiki"
},
"split_keywords": [
"ibis-ami"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "50acef7bd8b2c9b89c457a065cc5f5b9ab6de74777f24563ee9508872f51e183",
"md5": "12f6f2ce37f16ab48e58135a7713bfa7",
"sha256": "3f829b8e8174351e8c31c610584e4c653c034b97821e9a704c608367a748ffa9"
},
"downloads": -1,
"filename": "PyIBIS_AMI-6.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "12f6f2ce37f16ab48e58135a7713bfa7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 1599846,
"upload_time": "2025-02-23T13:57:18",
"upload_time_iso_8601": "2025-02-23T13:57:18.670153Z",
"url": "https://files.pythonhosted.org/packages/50/ac/ef7bd8b2c9b89c457a065cc5f5b9ab6de74777f24563ee9508872f51e183/PyIBIS_AMI-6.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "723c28866d52c300e58d7ed452c417899f4fc9186f8bdf66e7a55c28eea155af",
"md5": "cadc97c049d69c33bcb0ba80212478c5",
"sha256": "4b9bf52d129ca5ce654c8c06ba53589ead1e132de0d723aa1b62343a3da372f7"
},
"downloads": -1,
"filename": "pyibis_ami-6.2.2.tar.gz",
"has_sig": false,
"md5_digest": "cadc97c049d69c33bcb0ba80212478c5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 1612424,
"upload_time": "2025-02-23T13:57:21",
"upload_time_iso_8601": "2025-02-23T13:57:21.512547Z",
"url": "https://files.pythonhosted.org/packages/72/3c/28866d52c300e58d7ed452c417899f4fc9186f8bdf66e7a55c28eea155af/pyibis_ami-6.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-23 13:57:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "capn-freako",
"github_project": "PyAMI",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "pyibis-ami"
}
