From 20f7a48fb07c5d3a49eb05d0c06aeb0fafcfdc44 Mon Sep 17 00:00:00 2001 From: David Banas Date: Sat, 29 Oct 2022 17:48:37 -0700 Subject: [PATCH 1/2] Update README.md Added badge for pre-commit.ci. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 353bb37..ae2e8f2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +[![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. From 44508f461ad7f0246988124b02b3f40a276a03b7 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 2 Nov 2022 18:51:59 -0700 Subject: [PATCH 2/2] [pre-commit.ci] pre-commit autoupdate (#20) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * [pre-commit.ci] pre-commit autoupdate updates: - [github.com/psf/black: 22.3.0 → 22.10.0](https://github.com/psf/black/compare/22.3.0...22.10.0) - [github.com/pre-commit/pre-commit-hooks: v4.2.0 → v4.3.0](https://github.com/pre-commit/pre-commit-hooks/compare/v4.2.0...v4.3.0) * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- .pre-commit-config.yaml | 4 +- docs/build/html/_modules/index.html | 16 +- .../html/_modules/pyibisami/ami_config.html | 16 +- .../html/_modules/pyibisami/ami_model.html | 16 +- .../_modules/pyibisami/ami_parameter.html | 16 +- .../html/_modules/pyibisami/ami_parse.html | 18 +- .../html/_modules/pyibisami/ibis_file.html | 18 +- .../html/_modules/pyibisami/ibis_model.html | 24 +-- .../html/_modules/pyibisami/ibis_parser.html | 16 +- docs/build/html/_sources/intro.rst.txt | 1 - docs/build/html/_static/basic.css | 2 +- docs/build/html/_static/classic.css | 2 +- .../html/_static/documentation_options.js | 2 +- docs/build/html/_static/language_data.js | 4 +- docs/build/html/_static/pygments.css | 2 +- docs/build/html/_static/sidebar.js | 16 +- docs/build/html/genindex.html | 18 +- docs/build/html/index.html | 16 +- docs/build/html/intro.html | 16 +- docs/build/html/modules.html | 16 +- docs/build/html/py-modindex.html | 16 +- docs/build/html/search.html | 22 +-- docs/build/html/searchindex.js | 2 +- docs/source/conf.py | 160 +++++++++--------- docs/source/intro.rst | 1 - examples/all_taps.run | 1 - examples/bandwidth.run | 1 - examples/dummy.em | 5 +- examples/freq_resp.em | 5 +- examples/impulse.em | 5 +- examples/mode.run | 1 - examples/stratix4_ami_tx_runs/all_taps.run | 1 - .../stratix4_ami_tx_runs/test_results.xml | 56 +++--- src/pyibisami/ami/generic.ibs.em | 1 - src/pyibisami/tools/test_results.xsl | 3 +- tests/ami/test_config.py | 12 +- tests/ami/test_model.py | 6 +- tests/ami/test_parser.py | 6 +- tests/examples/example_tx.cpp.em | 1 - tests/examples/runs/posttap1.run | 1 - tests/examples/runs/posttap2.run | 1 - tests/examples/runs/pretap.run | 1 - tests/examples/tests/freq_resp.em | 5 +- tests/test_run_tests.py | 8 +- 44 files changed, 274 insertions(+), 286 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index f4ac103..95aba1b 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,6 +1,6 @@ repos: - repo: https://github.com/psf/black - rev: 22.3.0 + rev: 22.10.0 hooks: - id: black - repo: https://github.com/pycqa/isort @@ -9,7 +9,7 @@ repos: - id: isort args: ["--profile", "black", "--filter-files"] - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.2.0 + rev: v4.3.0 hooks: - id: trailing-whitespace - id: end-of-file-fixer diff --git a/docs/build/html/_modules/index.html b/docs/build/html/_modules/index.html index a2ebdd7..1a529ea 100644 --- a/docs/build/html/_modules/index.html +++ b/docs/build/html/_modules/index.html @@ -7,15 +7,15 @@ Overview: module code — PyIBIS-AMI Developer Guide 3.3.0 documentation - + - + - + +
- \ No newline at end of file + diff --git a/docs/build/html/_modules/pyibisami/ami_config.html b/docs/build/html/_modules/pyibisami/ami_config.html index 5fbac99..9d60843 100644 --- a/docs/build/html/_modules/pyibisami/ami_config.html +++ b/docs/build/html/_modules/pyibisami/ami_config.html @@ -7,15 +7,15 @@ pyibisami.ami_config — PyIBIS-AMI Developer Guide 3.3.0 documentation - + - + - + +
- +

Source code for pyibisami.ami_config

 #! /usr/bin/env python
 
@@ -245,7 +245,7 @@ 

Navigation

modules | - +
- \ No newline at end of file + diff --git a/docs/build/html/_modules/pyibisami/ami_model.html b/docs/build/html/_modules/pyibisami/ami_model.html index 38eed16..0d9f9b0 100644 --- a/docs/build/html/_modules/pyibisami/ami_model.html +++ b/docs/build/html/_modules/pyibisami/ami_model.html @@ -7,15 +7,15 @@ pyibisami.ami_model — PyIBIS-AMI Developer Guide 3.3.0 documentation - + - + - + +
- +

Source code for pyibisami.ami_model

 """
 Class definitions for working with IBIS-AMI models
@@ -472,7 +472,7 @@ 

Navigation

modules | - +
- \ No newline at end of file + diff --git a/docs/build/html/_modules/pyibisami/ami_parameter.html b/docs/build/html/_modules/pyibisami/ami_parameter.html index 88f8599..37c3971 100644 --- a/docs/build/html/_modules/pyibisami/ami_parameter.html +++ b/docs/build/html/_modules/pyibisami/ami_parameter.html @@ -7,15 +7,15 @@ pyibisami.ami_parameter — PyIBIS-AMI Developer Guide 3.3.0 documentation - + - + - + +
- +

Source code for pyibisami.ami_parameter

 """
 ``AMIParameter`` class definition, plus some helpers.
@@ -397,7 +397,7 @@ 

Navigation

modules | - +
- \ No newline at end of file + diff --git a/docs/build/html/_modules/pyibisami/ami_parse.html b/docs/build/html/_modules/pyibisami/ami_parse.html index 15f284b..361b519 100644 --- a/docs/build/html/_modules/pyibisami/ami_parse.html +++ b/docs/build/html/_modules/pyibisami/ami_parse.html @@ -7,15 +7,15 @@ pyibisami.ami_parse — PyIBIS-AMI Developer Guide 3.3.0 documentation - + - + - + +
- +

Source code for pyibisami.ami_parse

 """
 IBIS-AMI parameter parsing and configuration utilities.
@@ -130,7 +130,7 @@ 

Source code for pyibisami.ami_parse

 
     def __call__(self):
         self.open_gui()
-        
+
 
[docs] def open_gui(self): """Present a customized GUI to the user, for parameter customization.""" self.edit_traits()
@@ -511,7 +511,7 @@

Navigation

modules | - +
- \ No newline at end of file + diff --git a/docs/build/html/_modules/pyibisami/ibis_file.html b/docs/build/html/_modules/pyibisami/ibis_file.html index d678c68..f66598c 100644 --- a/docs/build/html/_modules/pyibisami/ibis_file.html +++ b/docs/build/html/_modules/pyibisami/ibis_file.html @@ -7,15 +7,15 @@ pyibisami.ibis_file — PyIBIS-AMI Developer Guide 3.3.0 documentation - + - + - + +
- +

Source code for pyibisami.ibis_file

 """
 A class for encapsulating IBIS model files.
@@ -99,7 +99,7 @@ 

Source code for pyibisami.ibis_file

     """
 
     debug = False
-    
+
     _log = ""
 
     pin_     = Property(Any,  depends_on=["pin"])
@@ -364,7 +364,7 @@ 

Navigation

modules | - +
- \ No newline at end of file + diff --git a/docs/build/html/_modules/pyibisami/ibis_model.html b/docs/build/html/_modules/pyibisami/ibis_model.html index 6a99da8..bfe181f 100644 --- a/docs/build/html/_modules/pyibisami/ibis_model.html +++ b/docs/build/html/_modules/pyibisami/ibis_model.html @@ -7,15 +7,15 @@ pyibisami.ibis_model — PyIBIS-AMI Developer Guide 3.3.0 documentation - + - + - + +
- +

Source code for pyibisami.ibis_model

 """
 Classes for encapsulating IBIS model constituents.
@@ -92,7 +92,7 @@ 

Source code for pyibisami.ibis_model

             raise LookupError("Missing [Package]!")
         if not self._pins:
             raise LookupError("Missing [Pin]!")
-        
+
         # Set up the GUI.
         self.add_trait('manufacturer', String(self._mfr))
         self.add_trait('package',      String(self._pkg))
@@ -175,7 +175,7 @@ 

Source code for pyibisami.ibis_model

             raise LookupError("Missing Model_type!")
         if not self._vrange:
             raise LookupError("Missing [Voltage Range]!")
-        
+
         # Infer impedance and rise/fall time for output models.
         mtype = self._mtype.lower()
         if mtype == 'output' or mtype == 'i/o':
@@ -347,12 +347,12 @@ 

Source code for pyibisami.ibis_model

     def slew(self):
         "The driver slew rate."
         return self._slew
-        
+
     @property
     def ccomp(self):
         "The parasitic capacitance."
         return self._ccomp
-        
+
     @property
     def mtype(self):
         """Model type."""
@@ -388,7 +388,7 @@ 

Navigation

modules | - +
- \ No newline at end of file + diff --git a/docs/build/html/_modules/pyibisami/ibis_parser.html b/docs/build/html/_modules/pyibisami/ibis_parser.html index 1a520eb..9ebf456 100644 --- a/docs/build/html/_modules/pyibisami/ibis_parser.html +++ b/docs/build/html/_modules/pyibisami/ibis_parser.html @@ -7,15 +7,15 @@ pyibisami.ibis_parser — PyIBIS-AMI Developer Guide 3.3.0 documentation - + - + - + +
- +

Source code for pyibisami.ibis_parser

 """
 Parse an IBIS model file.
@@ -467,7 +467,7 @@ 

Navigation

modules | - +
- \ No newline at end of file + diff --git a/docs/build/html/_sources/intro.rst.txt b/docs/build/html/_sources/intro.rst.txt index 82b14af..c325138 100644 --- a/docs/build/html/_sources/intro.rst.txt +++ b/docs/build/html/_sources/intro.rst.txt @@ -2,4 +2,3 @@ General description of *pyibisami* package. ------------------------------------------- .. automodule:: pyibisami - diff --git a/docs/build/html/_static/basic.css b/docs/build/html/_static/basic.css index ea6972d..5ba9911 100644 --- a/docs/build/html/_static/basic.css +++ b/docs/build/html/_static/basic.css @@ -761,4 +761,4 @@ div.math:hover a.headerlink { #top-link { display: none; } -} \ No newline at end of file +} diff --git a/docs/build/html/_static/classic.css b/docs/build/html/_static/classic.css index a414f1f..a641f29 100644 --- a/docs/build/html/_static/classic.css +++ b/docs/build/html/_static/classic.css @@ -263,4 +263,4 @@ div.viewcode-block:target { div.code-block-caption { color: #efefef; background-color: #1c4e63; -} \ No newline at end of file +} diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js index 2774cc5..13c7bd4 100644 --- a/docs/build/html/_static/documentation_options.js +++ b/docs/build/html/_static/documentation_options.js @@ -7,4 +7,4 @@ var DOCUMENTATION_OPTIONS = { HAS_SOURCE: true, SOURCELINK_SUFFIX: '.txt', NAVIGATION_WITH_KEYS: false -}; \ No newline at end of file +}; diff --git a/docs/build/html/_static/language_data.js b/docs/build/html/_static/language_data.js index 5266fb1..f891ac1 100644 --- a/docs/build/html/_static/language_data.js +++ b/docs/build/html/_static/language_data.js @@ -13,7 +13,7 @@ var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"]; -/* Non-minified version JS is _stemmer.js if file is provided */ +/* Non-minified version JS is _stemmer.js if file is provided */ /** * Porter Stemmer */ @@ -293,5 +293,3 @@ function splitQuery(query) { } return result; } - - diff --git a/docs/build/html/_static/pygments.css b/docs/build/html/_static/pygments.css index 20c4814..9b7363c 100644 --- a/docs/build/html/_static/pygments.css +++ b/docs/build/html/_static/pygments.css @@ -66,4 +66,4 @@ .highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ .highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ .highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */ -.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */ \ No newline at end of file +.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */ diff --git a/docs/build/html/_static/sidebar.js b/docs/build/html/_static/sidebar.js index 686ca39..6e38206 100644 --- a/docs/build/html/_static/sidebar.js +++ b/docs/build/html/_static/sidebar.js @@ -22,13 +22,13 @@ */ $(function() { - - - - - - - + + + + + + + // global elements used by the functions. // the 'sidebarbutton' element is defined as global after its @@ -156,4 +156,4 @@ $(function() { add_sidebar_button(); var sidebarbutton = $('#sidebarbutton'); set_position_from_cookie(); -}); \ No newline at end of file +}); diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index a949cab..f93ce6b 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -8,15 +8,15 @@ Index — PyIBIS-AMI Developer Guide 3.3.0 documentation - + - + - + +
- +

Index

@@ -57,7 +57,7 @@

Index

| S | W | Z - +

A

@@ -391,7 +391,7 @@

Navigation

  • modules |
  • - + - \ No newline at end of file + diff --git a/docs/build/html/index.html b/docs/build/html/index.html index 2005eae..9a9300f 100644 --- a/docs/build/html/index.html +++ b/docs/build/html/index.html @@ -7,16 +7,16 @@ PyIBIS-AMI Source Code Developer’s Guide — PyIBIS-AMI Developer Guide 3.3.0 documentation - + - + - + +
    - +

    PyIBIS-AMI Source Code Developer’s Guide

    - \ No newline at end of file + diff --git a/docs/build/html/intro.html b/docs/build/html/intro.html index 131f80c..ef08a3e 100644 --- a/docs/build/html/intro.html +++ b/docs/build/html/intro.html @@ -7,17 +7,17 @@ General description of pyibisami package. — PyIBIS-AMI Developer Guide 3.3.0 documentation - + - + - + +
    - +

    General description of pyibisami package.

    A package of Python modules, used to configure and test IBIS-AMI models.

    @@ -99,7 +99,7 @@

    Navigation

  • previous |
  • - +
    - \ No newline at end of file + diff --git a/docs/build/html/modules.html b/docs/build/html/modules.html index 93e0f30..fbb55d6 100644 --- a/docs/build/html/modules.html +++ b/docs/build/html/modules.html @@ -7,16 +7,16 @@ Modules in pyibisami package — PyIBIS-AMI Developer Guide 3.3.0 documentation - + - + - + +
    - +

    Modules in pyibisami package

    - \ No newline at end of file + diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html index 3829a1a..a1fb4a9 100644 --- a/docs/build/html/py-modindex.html +++ b/docs/build/html/py-modindex.html @@ -7,16 +7,16 @@ Python Module Index — PyIBIS-AMI Developer Guide 3.3.0 documentation - + - + - + @@ -29,15 +29,15 @@

    Navigation

  • modules |
  • - + -
    +
    - +

    Python Module Index

    @@ -121,7 +121,7 @@

    Navigation

  • modules |
  • - +
    - \ No newline at end of file + diff --git a/docs/build/html/search.html b/docs/build/html/search.html index ce632d7..5c86fca 100644 --- a/docs/build/html/search.html +++ b/docs/build/html/search.html @@ -7,19 +7,19 @@ Search — PyIBIS-AMI Developer Guide 3.3.0 documentation - - + + - + - + +
    - +

    Search

    @@ -59,9 +59,9 @@

    Search

    - +
    - +
    @@ -82,7 +82,7 @@

    Navigation

  • modules |
  • - +
    - \ No newline at end of file + diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index 2e8ff19..b0264d9 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["index","intro","modules"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.viewcode":1,sphinx:56},filenames:["index.rst","intro.rst","modules.rst"],objects:{"":{pyibisami:[1,0,0,"-"]},"pyibisami.ami_config":{ami_config:[2,1,1,""],print_code:[2,1,1,""],print_param:[2,1,1,""]},"pyibisami.ami_model":{AMIModel:[2,2,1,""],AMIModelInitializer:[2,2,1,""],interpFile:[2,1,1,""],loadWave:[2,1,1,""]},"pyibisami.ami_model.AMIModel":{ami_params_in:[2,3,1,""],ami_params_out:[2,3,1,""],bit_time:[2,3,1,""],channel_response:[2,3,1,""],clock_times:[2,3,1,""],getWave:[2,3,1,""],initOut:[2,3,1,""],initialize:[2,3,1,""],msg:[2,3,1,""],num_aggressors:[2,3,1,""],row_size:[2,3,1,""],sample_interval:[2,3,1,""]},"pyibisami.ami_model.AMIModelInitializer":{bit_time:[2,3,1,""],channel_response:[2,3,1,""],num_aggressors:[2,3,1,""],row_size:[2,3,1,""],sample_interval:[2,3,1,""]},"pyibisami.ami_parameter":{AMIParamError:[2,4,1,""],AMIParameter:[2,2,1,""]},"pyibisami.ami_parameter.AMIParameter":{msg:[2,3,1,""],pdefault:[2,3,1,""],pdescription:[2,3,1,""],pformat:[2,3,1,""],plist_tip:[2,3,1,""],pmax:[2,3,1,""],pmin:[2,3,1,""],pname:[2,3,1,""],ptype:[2,3,1,""],pusage:[2,3,1,""],pvalue:[2,3,1,""]},"pyibisami.ami_parse":{AMIParamConfigurator:[2,2,1,""],lexeme:[2,1,1,""],make_gui_items:[2,1,1,""],parse_ami_param_defs:[2,1,1,""],proc_branch:[2,1,1,""]},"pyibisami.ami_parse.AMIParamConfigurator":{ami_param_defs:[2,3,1,""],ami_parsing_errors:[2,3,1,""],default_traits_view:[2,3,1,""],fetch_param_val:[2,3,1,""],input_ami_params:[2,3,1,""],open_gui:[2,3,1,""]},"pyibisami.ibis_file":{IBISModel:[2,2,1,""]},"pyibisami.ibis_file.IBISModel":{default_traits_view:[2,3,1,""],get_models:[2,3,1,""],get_pins:[2,3,1,""],ibis_parsing_errors:[2,3,1,""],log:[2,3,1,""],log_txt:[2,3,1,""],model_dict:[2,3,1,""]},"pyibisami.ibis_model":{Component:[2,2,1,""],Model:[2,2,1,""]},"pyibisami.ibis_model.Component":{default_traits_view:[2,3,1,""],pin:[2,3,1,""],pins:[2,3,1,""]},"pyibisami.ibis_model.Model":{ccomp:[2,3,1,""],default_traits_view:[2,3,1,""],mtype:[2,3,1,""],slew:[2,3,1,""],zout:[2,3,1,""]},"pyibisami.ibis_parser":{keyword:[2,1,1,""],lexeme:[2,1,1,""],many1True:[2,1,1,""],manyTrue:[2,1,1,""],node:[2,1,1,""],parse_ibis_file:[2,1,1,""],pin:[2,1,1,""],word:[2,1,1,""]},pyibisami:{ami_config:[2,0,0,"-"],ami_model:[2,0,0,"-"],ami_parameter:[2,0,0,"-"],ami_parse:[2,0,0,"-"],ibis_file:[2,0,0,"-"],ibis_model:[2,0,0,"-"],ibis_parser:[2,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","exception","Python exception"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:exception"},terms:{"100e":2,"25e":2,"class":2,"default":[0,2],"float":2,"function":2,"import":2,"long":2,"new":2,"null":2,"return":2,"true":2,"while":2,For:2,IBS:2,One:2,That:2,The:2,_not_:2,_param_def_tag_proc:2,abov:2,accept:2,access:2,actual:2,adjac:2,after:0,aggressor:2,alert:2,all:[0,1,2],allow:2,along:2,ami:1,ami_clos:2,ami_config:0,ami_fil:2,ami_file_contents_str:2,ami_file_nam:2,ami_getwav:2,ami_init:2,ami_model:0,ami_param:2,ami_param_def:2,ami_paramet:0,ami_params_in:2,ami_params_out:2,ami_pars:0,ami_parsing_error:2,amimodel:2,amimodeliniti:2,amiparamconfigur:2,amiparamerror:2,amiparamet:2,analog:2,ani:2,anyth:2,applic:0,appropri:2,argument:2,arrai:2,assembl:2,associ:2,assum:2,attribut:2,author:[1,2],automag:2,automat:0,avail:2,avoid:[0,2],back:2,bana:[1,2],base:0,becaus:2,befor:[0,2],behavior:2,being:2,between:2,bind:2,bit:2,bit_tim:2,bits_per_cal:2,bool:2,both:2,branch:2,branch_nam:2,browser:0,build:2,c_doubl:2,call:2,can:[0,2],canonic:2,capacit:2,capn:[1,2],care:2,ccomp:2,chang:2,channel:2,channel_respons:2,circular:2,clock:2,clock_tim:2,code:2,com:[1,2],command:[0,2],common:2,complet:[0,2],compon:0,conda:0,configur:[0,1],consist:2,consol:2,constant:2,constitu:2,construct:2,constructor:2,contain:2,content:2,convert:2,convolv:2,copi:0,copyright:[1,2],cosmosscop:2,cpp:2,creat:2,crosstalk:2,custom:2,customiz:2,cython:0,data:2,date:[1,2],david:[1,2],debug:2,decemb:2,default_traits_view:2,defin:2,definit:2,defint:2,describ:2,descript:[0,2],destructor:2,dialog:2,dict:2,dictionari:2,differ:2,directori:0,discard:2,distinguish:2,dll:0,doesn:2,domain:2,driver:2,dual:2,due:[0,2],dure:2,each:2,either:2,element:2,empi:[0,2],empti:2,encapsul:0,encount:2,end:2,ensur:2,entir:2,err_str:2,error:[0,2],everi:2,exampl:[0,2],except:2,execut:2,exist:2,exit:0,experi:2,facilit:2,fact:2,fail:2,failur:2,fals:2,far:2,februari:2,fetch_param_v:2,fext:2,field:2,file:0,filenam:[0,2],filter:2,first:2,first_cal:2,follow:2,form:2,format:[0,2],found:[0,2],freako:[1,2],from:0,gbit:2,gener:[0,2],get:2,get_model:2,get_pin:2,getwav:2,ghz:2,give:2,given:2,gmail:[1,2],guarante:2,gui:2,handl:2,has:2,hasn:2,hastrait:2,have:2,header:2,help:[0,2],helper:2,here:2,him:2,http:2,ibi:[0,1],ibis_fil:0,ibis_file_contents_str:2,ibis_file_nam:2,ibis_model:0,ibis_pars:0,ibis_parsing_error:2,ibismodel:2,idea:2,ideal:2,ignor:2,imped:2,impuls:2,increment:2,indent:2,index:[0,2],indiviu:2,info:0,inform:2,init_object:2,initi:2,initout:2,inout:2,input:2,input_ami_param:2,instal:0,instanc:2,instant:2,instanti:2,insur:2,integ:2,intend:2,interact:2,interpfil:2,interpol:2,interv:2,invoc:2,invok:2,is_tx:2,item:2,iter:2,its:2,juli:[1,2],just:2,kei:[0,2],kept:2,keyword:0,kind:2,kywrd:2,label:0,languag:0,latest:2,leaf:2,least:2,length:2,let:2,level:2,lexem:2,lexer:2,like:2,limit:2,line:[0,2],linear:2,link:2,list:[0,2],load:[0,2],loadwav:2,local:[0,2],log:2,log_txt:2,lot:2,made:2,mai:[0,2],make:2,make_gui_item:2,makefil:2,mandatori:2,many1tru:2,manytru:2,match:2,matrix:2,maximum:2,member:2,messag:[0,2],minimum:2,minu:2,mname:2,model:[0,1],model_dict:2,model_specif:2,modifi:2,modul:[0,1],most:2,msg:2,mtype:2,multipl:2,must:[0,2],name:[0,2],natur:2,need:[0,2],nest:2,newli:2,node:2,none:2,note:2,novemb:2,num_aggressor:2,number:2,numpi:[0,2],object:2,occur:2,onc:2,one:2,onli:2,open:2,open_gui:2,option:[0,2],optional_arg:2,order:[0,2],org:2,origin:[1,2],other:2,our:2,out:2,out_dir:0,output:0,overrid:2,packag:0,page:0,pair:2,param:[0,2],param_dict:2,param_str:2,paramet:0,parasit:2,pars:0,parse_ami_param_def:2,parse_ibis_fil:2,parsec:0,parser:0,particular:2,pass:2,path:0,pattern:2,payload:2,pdefault:2,pdescript:2,peak:2,per:2,perform:2,period:2,pformat:2,pin:2,pip:0,place:0,plist_tip:2,plu:2,pmax:2,pmin:2,pname:2,pop:2,possibl:[0,2],present:2,primari:2,primarili:2,print:2,print_cod:2,print_param:2,proc_branch:2,process:2,produc:0,prog:0,program:0,prompt:2,properli:2,properti:2,provid:[0,2],ptype:2,pusag:2,pvalu:2,py_fil:[0,2],pyami:2,pyibisami:0,pylab:2,python:[0,1],queri:2,rate:2,read:2,rebuild:2,rebuilt:2,recent:2,recov:2,recurs:2,redund:2,ref_dir:0,refer:0,regard:2,relat:2,remain:2,rememb:2,report:2,repres:2,requir:2,resampl:2,reserv:[1,2],reserved_paramet:2,respect:2,respons:2,rest:2,result:[0,2],retriev:2,right:[1,2],rlc:2,root:2,row:2,row_siz:2,run:2,run_test:0,same:2,sampl:2,sample_interv:2,sample_p:2,save:2,scope:2,script:2,search:0,second:2,see:0,select:2,separ:2,seri:0,set:[0,2],sever:2,she:2,should:[0,2],show:0,sinc:2,singl:2,size:2,slew:2,slicer:2,some:2,sourc:2,space:2,specif:2,specifi:0,stack:2,standard:2,stop:2,stop_keyword:2,store:2,str:2,string:2,structur:2,sub:2,subclass:2,subdict:2,subparamet:2,succe:2,success:2,suitabl:2,suppli:0,tag:2,take:2,taken:0,templat:[0,2],termin:2,test1:0,test2:0,test:[1,2],test_dir:0,test_result:0,text:0,thei:2,them:2,thi:[0,2],thing:2,those:2,three:2,time:2,tip:2,tool:0,top:2,trait:[0,2],travers:2,tree:2,trigger:2,twice:2,two:[0,2],type:2,underscor:2,unit:2,unprocess:2,updat:2,upon:2,usag:[0,2],use:2,used:[1,2],useful:[0,2],user:2,using:2,util:0,val:0,valid:2,valid_keyword:2,valu:2,vector:2,veri:2,version:0,via:[0,2],victim:2,view:[0,2],visit:2,voltag:2,wai:2,want:2,warn:2,wave:2,waveform:[0,2],web:0,well:2,were:2,when:2,where:2,whether:2,which:[0,2],wide:[1,2],word:2,work:[0,2],world:[1,2],wrap:2,written:0,xml:0,xml_file:0,xsl:0,xslt:0,yet:2,you:[0,2],your:0,zout:2},titles:["PyIBIS-AMI Source Code Developer\u2019s Guide","General description of pyibisami package.","Modules in pyibisami package"],titleterms:{ami:[0,2],ami_config:2,ami_model:2,ami_paramet:2,ami_pars:2,automat:2,base:2,code:0,compon:2,config:0,configur:2,content:0,descript:1,develop:0,dll:2,encapsul:2,file:2,from:2,gener:1,guid:0,ibi:2,ibis_fil:2,ibis_model:2,ibis_pars:2,indic:0,keyword:2,model:2,modul:2,packag:[1,2],paramet:2,pars:2,parsec:2,parser:2,pyibi:0,pyibisami:[1,2],python:2,run:0,sourc:0,tabl:0,test:0,util:2,welcom:0}}) \ No newline at end of file +Search.setIndex({docnames:["index","intro","modules"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.viewcode":1,sphinx:56},filenames:["index.rst","intro.rst","modules.rst"],objects:{"":{pyibisami:[1,0,0,"-"]},"pyibisami.ami_config":{ami_config:[2,1,1,""],print_code:[2,1,1,""],print_param:[2,1,1,""]},"pyibisami.ami_model":{AMIModel:[2,2,1,""],AMIModelInitializer:[2,2,1,""],interpFile:[2,1,1,""],loadWave:[2,1,1,""]},"pyibisami.ami_model.AMIModel":{ami_params_in:[2,3,1,""],ami_params_out:[2,3,1,""],bit_time:[2,3,1,""],channel_response:[2,3,1,""],clock_times:[2,3,1,""],getWave:[2,3,1,""],initOut:[2,3,1,""],initialize:[2,3,1,""],msg:[2,3,1,""],num_aggressors:[2,3,1,""],row_size:[2,3,1,""],sample_interval:[2,3,1,""]},"pyibisami.ami_model.AMIModelInitializer":{bit_time:[2,3,1,""],channel_response:[2,3,1,""],num_aggressors:[2,3,1,""],row_size:[2,3,1,""],sample_interval:[2,3,1,""]},"pyibisami.ami_parameter":{AMIParamError:[2,4,1,""],AMIParameter:[2,2,1,""]},"pyibisami.ami_parameter.AMIParameter":{msg:[2,3,1,""],pdefault:[2,3,1,""],pdescription:[2,3,1,""],pformat:[2,3,1,""],plist_tip:[2,3,1,""],pmax:[2,3,1,""],pmin:[2,3,1,""],pname:[2,3,1,""],ptype:[2,3,1,""],pusage:[2,3,1,""],pvalue:[2,3,1,""]},"pyibisami.ami_parse":{AMIParamConfigurator:[2,2,1,""],lexeme:[2,1,1,""],make_gui_items:[2,1,1,""],parse_ami_param_defs:[2,1,1,""],proc_branch:[2,1,1,""]},"pyibisami.ami_parse.AMIParamConfigurator":{ami_param_defs:[2,3,1,""],ami_parsing_errors:[2,3,1,""],default_traits_view:[2,3,1,""],fetch_param_val:[2,3,1,""],input_ami_params:[2,3,1,""],open_gui:[2,3,1,""]},"pyibisami.ibis_file":{IBISModel:[2,2,1,""]},"pyibisami.ibis_file.IBISModel":{default_traits_view:[2,3,1,""],get_models:[2,3,1,""],get_pins:[2,3,1,""],ibis_parsing_errors:[2,3,1,""],log:[2,3,1,""],log_txt:[2,3,1,""],model_dict:[2,3,1,""]},"pyibisami.ibis_model":{Component:[2,2,1,""],Model:[2,2,1,""]},"pyibisami.ibis_model.Component":{default_traits_view:[2,3,1,""],pin:[2,3,1,""],pins:[2,3,1,""]},"pyibisami.ibis_model.Model":{ccomp:[2,3,1,""],default_traits_view:[2,3,1,""],mtype:[2,3,1,""],slew:[2,3,1,""],zout:[2,3,1,""]},"pyibisami.ibis_parser":{keyword:[2,1,1,""],lexeme:[2,1,1,""],many1True:[2,1,1,""],manyTrue:[2,1,1,""],node:[2,1,1,""],parse_ibis_file:[2,1,1,""],pin:[2,1,1,""],word:[2,1,1,""]},pyibisami:{ami_config:[2,0,0,"-"],ami_model:[2,0,0,"-"],ami_parameter:[2,0,0,"-"],ami_parse:[2,0,0,"-"],ibis_file:[2,0,0,"-"],ibis_model:[2,0,0,"-"],ibis_parser:[2,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","exception","Python exception"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:exception"},terms:{"100e":2,"25e":2,"class":2,"default":[0,2],"float":2,"function":2,"import":2,"long":2,"new":2,"null":2,"return":2,"true":2,"while":2,For:2,IBS:2,One:2,That:2,The:2,_not_:2,_param_def_tag_proc:2,abov:2,accept:2,access:2,actual:2,adjac:2,after:0,aggressor:2,alert:2,all:[0,1,2],allow:2,along:2,ami:1,ami_clos:2,ami_config:0,ami_fil:2,ami_file_contents_str:2,ami_file_nam:2,ami_getwav:2,ami_init:2,ami_model:0,ami_param:2,ami_param_def:2,ami_paramet:0,ami_params_in:2,ami_params_out:2,ami_pars:0,ami_parsing_error:2,amimodel:2,amimodeliniti:2,amiparamconfigur:2,amiparamerror:2,amiparamet:2,analog:2,ani:2,anyth:2,applic:0,appropri:2,argument:2,arrai:2,assembl:2,associ:2,assum:2,attribut:2,author:[1,2],automag:2,automat:0,avail:2,avoid:[0,2],back:2,bana:[1,2],base:0,becaus:2,befor:[0,2],behavior:2,being:2,between:2,bind:2,bit:2,bit_tim:2,bits_per_cal:2,bool:2,both:2,branch:2,branch_nam:2,browser:0,build:2,c_doubl:2,call:2,can:[0,2],canonic:2,capacit:2,capn:[1,2],care:2,ccomp:2,chang:2,channel:2,channel_respons:2,circular:2,clock:2,clock_tim:2,code:2,com:[1,2],command:[0,2],common:2,complet:[0,2],compon:0,conda:0,configur:[0,1],consist:2,consol:2,constant:2,constitu:2,construct:2,constructor:2,contain:2,content:2,convert:2,convolv:2,copi:0,copyright:[1,2],cosmosscop:2,cpp:2,creat:2,crosstalk:2,custom:2,customiz:2,cython:0,data:2,date:[1,2],david:[1,2],debug:2,decemb:2,default_traits_view:2,defin:2,definit:2,defint:2,describ:2,descript:[0,2],destructor:2,dialog:2,dict:2,dictionari:2,differ:2,directori:0,discard:2,distinguish:2,dll:0,doesn:2,domain:2,driver:2,dual:2,due:[0,2],dure:2,each:2,either:2,element:2,empi:[0,2],empti:2,encapsul:0,encount:2,end:2,ensur:2,entir:2,err_str:2,error:[0,2],everi:2,exampl:[0,2],except:2,execut:2,exist:2,exit:0,experi:2,facilit:2,fact:2,fail:2,failur:2,fals:2,far:2,februari:2,fetch_param_v:2,fext:2,field:2,file:0,filenam:[0,2],filter:2,first:2,first_cal:2,follow:2,form:2,format:[0,2],found:[0,2],freako:[1,2],from:0,gbit:2,gener:[0,2],get:2,get_model:2,get_pin:2,getwav:2,ghz:2,give:2,given:2,gmail:[1,2],guarante:2,gui:2,handl:2,has:2,hasn:2,hastrait:2,have:2,header:2,help:[0,2],helper:2,here:2,him:2,http:2,ibi:[0,1],ibis_fil:0,ibis_file_contents_str:2,ibis_file_nam:2,ibis_model:0,ibis_pars:0,ibis_parsing_error:2,ibismodel:2,idea:2,ideal:2,ignor:2,imped:2,impuls:2,increment:2,indent:2,index:[0,2],indiviu:2,info:0,inform:2,init_object:2,initi:2,initout:2,inout:2,input:2,input_ami_param:2,instal:0,instanc:2,instant:2,instanti:2,insur:2,integ:2,intend:2,interact:2,interpfil:2,interpol:2,interv:2,invoc:2,invok:2,is_tx:2,item:2,iter:2,its:2,juli:[1,2],just:2,kei:[0,2],kept:2,keyword:0,kind:2,kywrd:2,label:0,languag:0,latest:2,leaf:2,least:2,length:2,let:2,level:2,lexem:2,lexer:2,like:2,limit:2,line:[0,2],linear:2,link:2,list:[0,2],load:[0,2],loadwav:2,local:[0,2],log:2,log_txt:2,lot:2,made:2,mai:[0,2],make:2,make_gui_item:2,makefil:2,mandatori:2,many1tru:2,manytru:2,match:2,matrix:2,maximum:2,member:2,messag:[0,2],minimum:2,minu:2,mname:2,model:[0,1],model_dict:2,model_specif:2,modifi:2,modul:[0,1],most:2,msg:2,mtype:2,multipl:2,must:[0,2],name:[0,2],natur:2,need:[0,2],nest:2,newli:2,node:2,none:2,note:2,novemb:2,num_aggressor:2,number:2,numpi:[0,2],object:2,occur:2,onc:2,one:2,onli:2,open:2,open_gui:2,option:[0,2],optional_arg:2,order:[0,2],org:2,origin:[1,2],other:2,our:2,out:2,out_dir:0,output:0,overrid:2,packag:0,page:0,pair:2,param:[0,2],param_dict:2,param_str:2,paramet:0,parasit:2,pars:0,parse_ami_param_def:2,parse_ibis_fil:2,parsec:0,parser:0,particular:2,pass:2,path:0,pattern:2,payload:2,pdefault:2,pdescript:2,peak:2,per:2,perform:2,period:2,pformat:2,pin:2,pip:0,place:0,plist_tip:2,plu:2,pmax:2,pmin:2,pname:2,pop:2,possibl:[0,2],present:2,primari:2,primarili:2,print:2,print_cod:2,print_param:2,proc_branch:2,process:2,produc:0,prog:0,program:0,prompt:2,properli:2,properti:2,provid:[0,2],ptype:2,pusag:2,pvalu:2,py_fil:[0,2],pyami:2,pyibisami:0,pylab:2,python:[0,1],queri:2,rate:2,read:2,rebuild:2,rebuilt:2,recent:2,recov:2,recurs:2,redund:2,ref_dir:0,refer:0,regard:2,relat:2,remain:2,rememb:2,report:2,repres:2,requir:2,resampl:2,reserv:[1,2],reserved_paramet:2,respect:2,respons:2,rest:2,result:[0,2],retriev:2,right:[1,2],rlc:2,root:2,row:2,row_siz:2,run:2,run_test:0,same:2,sampl:2,sample_interv:2,sample_p:2,save:2,scope:2,script:2,search:0,second:2,see:0,select:2,separ:2,seri:0,set:[0,2],sever:2,she:2,should:[0,2],show:0,sinc:2,singl:2,size:2,slew:2,slicer:2,some:2,sourc:2,space:2,specif:2,specifi:0,stack:2,standard:2,stop:2,stop_keyword:2,store:2,str:2,string:2,structur:2,sub:2,subclass:2,subdict:2,subparamet:2,succe:2,success:2,suitabl:2,suppli:0,tag:2,take:2,taken:0,templat:[0,2],termin:2,test1:0,test2:0,test:[1,2],test_dir:0,test_result:0,text:0,thei:2,them:2,thi:[0,2],thing:2,those:2,three:2,time:2,tip:2,tool:0,top:2,trait:[0,2],travers:2,tree:2,trigger:2,twice:2,two:[0,2],type:2,underscor:2,unit:2,unprocess:2,updat:2,upon:2,usag:[0,2],use:2,used:[1,2],useful:[0,2],user:2,using:2,util:0,val:0,valid:2,valid_keyword:2,valu:2,vector:2,veri:2,version:0,via:[0,2],victim:2,view:[0,2],visit:2,voltag:2,wai:2,want:2,warn:2,wave:2,waveform:[0,2],web:0,well:2,were:2,when:2,where:2,whether:2,which:[0,2],wide:[1,2],word:2,work:[0,2],world:[1,2],wrap:2,written:0,xml:0,xml_file:0,xsl:0,xslt:0,yet:2,you:[0,2],your:0,zout:2},titles:["PyIBIS-AMI Source Code Developer\u2019s Guide","General description of pyibisami package.","Modules in pyibisami package"],titleterms:{ami:[0,2],ami_config:2,ami_model:2,ami_paramet:2,ami_pars:2,automat:2,base:2,code:0,compon:2,config:0,configur:2,content:0,descript:1,develop:0,dll:2,encapsul:2,file:2,from:2,gener:1,guid:0,ibi:2,ibis_fil:2,ibis_model:2,ibis_pars:2,indic:0,keyword:2,model:2,modul:2,packag:[1,2],paramet:2,pars:2,parsec:2,parser:2,pyibi:0,pyibisami:[1,2],python:2,run:0,sourc:0,tabl:0,test:0,util:2,welcom:0}}) diff --git a/docs/source/conf.py b/docs/source/conf.py index e89f923..2b08cf8 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -12,56 +12,51 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys import os +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('.')) # -- General configuration ------------------------------------------------ # dbanas-2015_02_14 -autoclass_content = 'both' +autoclass_content = "both" # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +# 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', - 'm2r' -] +extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode", "sphinx.ext.napoleon", "m2r"] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = ".rst" # The encoding of source files. -#source_encoding = 'utf-8-sig' +# source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = u'PyIBIS-AMI Developer Guide' -copyright = u'2015, David Banas' +project = "PyIBIS-AMI Developer Guide" +copyright = "2015, David Banas" # 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 = '3.3' +version = "3.3" # The full version, including alpha/beta/rc tags. -release = '3.3.0' +release = "3.3.0" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -72,9 +67,9 @@ # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -82,183 +77,176 @@ # The reST default role (used for this markup: `text`) to use for all # documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False +# keep_warnings = False # -- 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 = "default" # 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 # documentation. -#html_theme_options = {} +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +# html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +# html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ["_static"] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. -#html_extra_path = [] +# html_extra_path = [] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +# html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +# html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Language to be used for generating the HTML full-text search index. # Sphinx supports the following languages: # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -#html_search_language = 'en' +# html_search_language = 'en' # A dictionary with options for the search language support, empty by default. # Now only 'ja' uses this config value -#html_search_options = {'type': 'default'} +# html_search_options = {'type': 'default'} # The name of a javascript file (relative to the configuration directory) that # implements a search results scorer. If empty, the default will be used. -#html_search_scorer = 'scorer.js' +# html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. -htmlhelp_basename = 'PyIBIS-AMIDeveloperGuidedoc' +htmlhelp_basename = "PyIBIS-AMIDeveloperGuidedoc" # -- 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', + # 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', u'PyIBIS-AMI Developer Guide Documentation', - u'David Banas', 'manual'), + ("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. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'pyibis-amideveloperguide', u'PyIBIS-AMI Developer Guide Documentation', - [u'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 +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------- @@ -267,19 +255,25 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'PyIBIS-AMIDeveloperGuide', u'PyIBIS-AMI Developer Guide Documentation', - u'David Banas', 'PyIBIS-AMIDeveloperGuide', 'One line description of project.', - 'Miscellaneous'), + ( + "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 = [] +# texinfo_appendices = [] # If false, no module index is generated. -#texinfo_domain_indices = True +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' +# texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False +# texinfo_no_detailmenu = False diff --git a/docs/source/intro.rst b/docs/source/intro.rst index 82b14af..c325138 100644 --- a/docs/source/intro.rst +++ b/docs/source/intro.rst @@ -2,4 +2,3 @@ General description of *pyibisami* package. ------------------------------------------- .. automodule:: pyibisami - diff --git a/examples/all_taps.run b/examples/all_taps.run index c1fd891..5b40a07 100644 --- a/examples/all_taps.run +++ b/examples/all_taps.run @@ -44,4 +44,3 @@ Sweep of Tx pre-emphasis filter tap weight values. } \ ) \ ) - diff --git a/examples/bandwidth.run b/examples/bandwidth.run index 437ed14..fd4e982 100644 --- a/examples/bandwidth.run +++ b/examples/bandwidth.run @@ -21,4 +21,3 @@ Sweep of `Bandwidth` parameter values. {} \ ) \ ) - diff --git a/examples/dummy.em b/examples/dummy.em index d302f07..260c7c9 100644 --- a/examples/dummy.em +++ b/examples/dummy.em @@ -1,8 +1,8 @@ @# Example input file for `run_tests.py'. -@# +@# @# Original Author: David Banas @# Original Date: July 20, 2012 -@# +@# @# Copyright (c) 2012 David Banas; All rights reserved World wide. @@ -22,4 +22,3 @@ And you should see the Python logo, below: - diff --git a/examples/freq_resp.em b/examples/freq_resp.em index 6107f0a..c6c2235 100644 --- a/examples/freq_resp.em +++ b/examples/freq_resp.em @@ -1,8 +1,8 @@ @# Example input file for `run_tests.py'. -@# +@# @# Original Author: David Banas @# Original Date: July 20, 2012 -@# +@# @# Copyright (c) 2012 David Banas; All rights reserved World wide. @@ -101,4 +101,3 @@ savefig(filename2) @(filename2) - diff --git a/examples/impulse.em b/examples/impulse.em index 9eb687a..dd58cc2 100644 --- a/examples/impulse.em +++ b/examples/impulse.em @@ -1,8 +1,8 @@ @# Example input file for `run_tests.py'. -@# +@# @# Original Author: David Banas @# Original Date: July 20, 2012 -@# +@# @# Copyright (c) 2012 David Banas; All rights reserved World wide. @@ -55,4 +55,3 @@ savefig(filename) - diff --git a/examples/mode.run b/examples/mode.run index d92bd25..a1be672 100644 --- a/examples/mode.run +++ b/examples/mode.run @@ -32,4 +32,3 @@ Sweep of `Mode` parameter values. {} \ ) \ ) - diff --git a/examples/stratix4_ami_tx_runs/all_taps.run b/examples/stratix4_ami_tx_runs/all_taps.run index b18e46b..65f5ed5 100644 --- a/examples/stratix4_ami_tx_runs/all_taps.run +++ b/examples/stratix4_ami_tx_runs/all_taps.run @@ -75,4 +75,3 @@ Sweep of Stratix-4 Tx pre-emphasis filter tap weight values. ), \ 'impulse_response_8ma.txt' \ ) - diff --git a/examples/stratix4_ami_tx_runs/test_results.xml b/examples/stratix4_ami_tx_runs/test_results.xml index 949bda5..18ba1b4 100644 --- a/examples/stratix4_ami_tx_runs/test_results.xml +++ b/examples/stratix4_ami_tx_runs/test_results.xml @@ -1,13 +1,13 @@ - - - impulse (all_taps) - Pass - Model impulse response for: Sweep of Stratix-4 Tx pre-emphasis filter tap weight values. - - + + + impulse (all_taps) + Pass + Model impulse response for: Sweep of Stratix-4 Tx pre-emphasis filter tap weight values. + + (Stratix4_Tx (tap1 4)(Vod 8)(tap2 2)(ptap 2)(inv_ptap 1)(inv_tap2 0)) @@ -93,20 +93,20 @@ Calculated tap weights: - - - plot_1.png - - - - - - - freq_resp (all_taps) - Pass - Model frequency response for: Sweep of Stratix-4 Tx pre-emphasis filter tap weight values. - - + + + plot_1.png + + + + + + + freq_resp (all_taps) + Pass + Model frequency response for: Sweep of Stratix-4 Tx pre-emphasis filter tap weight values. + + (Stratix4_Tx (tap1 4)(Vod 8)(tap2 2)(ptap 2)(inv_ptap 1)(inv_tap2 0)) @@ -192,11 +192,11 @@ Calculated tap weights: - - - plot_2.png - - - - + + + plot_2.png + + + + diff --git a/src/pyibisami/ami/generic.ibs.em b/src/pyibisami/ami/generic.ibs.em index 2779d2d..0982bc3 100644 --- a/src/pyibisami/ami/generic.ibs.em +++ b/src/pyibisami/ami/generic.ibs.em @@ -139,4 +139,3 @@ else: } [END] - diff --git a/src/pyibisami/tools/test_results.xsl b/src/pyibisami/tools/test_results.xsl index 616c1a9..3aad6e6 100644 --- a/src/pyibisami/tools/test_results.xsl +++ b/src/pyibisami/tools/test_results.xsl @@ -23,7 +23,7 @@ xmlns:xsl="http://www.w3.org/1999/XSL/Transform">

    Test Results - Details

    -

    -

    +

    -

    @@ -40,4 +40,3 @@ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> - diff --git a/tests/ami/test_config.py b/tests/ami/test_config.py index 0364ea6..98e653d 100644 --- a/tests/ami/test_config.py +++ b/tests/ami/test_config.py @@ -5,7 +5,6 @@ class TestAMIConfig(object): - @patch.object(config, "date", autospec=True) def test_ami_config(self, mock_date): """Using the example_tx.py and supporting cpp.em file verify the output.""" @@ -16,7 +15,9 @@ def test_ami_config(self, mock_date): with open(Path(__file__).parents[1].joinpath("examples", "example_tx.ami")) as ami_file: ami = ami_file.read() - assert ami == r"""(example_tx + assert ( + ami + == r"""(example_tx (Description "Example Tx model from ibisami package.") @@ -69,11 +70,13 @@ def test_ami_config(self, mock_date): ) """ - + ) with open(Path(__file__).parents[1].joinpath("examples", "example_tx.cpp")) as cpp_file: cpp = cpp_file.read() - assert cpp == r"""/** \file example_tx.cpp + assert ( + cpp + == r"""/** \file example_tx.cpp * \brief Example of using ibisami to build a Tx model. * * Original author: David Banas
    @@ -162,6 +165,7 @@ class MyTx : public AmiTx { AMIModel *ami_model = &my_tx; ///< The pointer required by the API implementation. """ + ) Path(__file__).parents[1].joinpath("examples", "example_tx.ami").unlink() Path(__file__).parents[1].joinpath("examples", "example_tx.ibs").unlink() Path(__file__).parents[1].joinpath("examples", "example_tx.cpp").unlink() diff --git a/tests/ami/test_model.py b/tests/ami/test_model.py index 1e3ba02..f59c954 100644 --- a/tests/ami/test_model.py +++ b/tests/ami/test_model.py @@ -1,9 +1,9 @@ -from pathlib import Path import sys +from pathlib import Path import pytest -from pyibisami.ami.model import loadWave, AMIModelInitializer, AMIModel +from pyibisami.ami.model import AMIModel, AMIModelInitializer, loadWave def test_loadWave(tmp_path): @@ -38,7 +38,7 @@ def test_init(self): the_model = AMIModel(example_so) - initializer = AMIModelInitializer({'root_name': "exampleTx"}) + initializer = AMIModelInitializer({"root_name": "exampleTx"}) the_model.initialize(initializer) assert the_model.msg == b"Initializing Tx...\n\n" diff --git a/tests/ami/test_parser.py b/tests/ami/test_parser.py index c07608b..a1082c0 100644 --- a/tests/ami/test_parser.py +++ b/tests/ami/test_parser.py @@ -1,6 +1,8 @@ import pytest + import pyibisami.ami.parser as ami_parse + @pytest.fixture def test_ami_config(): return r"""(example_tx @@ -58,9 +60,9 @@ def test_ami_config(): """ -@pytest.mark.usefixtures("test_ami_config") -class TestAMIParse(): +@pytest.mark.usefixtures("test_ami_config") +class TestAMIParse: def test_parse_ami_param_defs(self, test_ami_config): error_string, param_defs = ami_parse.parse_ami_param_defs(test_ami_config) assert error_string == "" diff --git a/tests/examples/example_tx.cpp.em b/tests/examples/example_tx.cpp.em index 713f8ef..de522d7 100644 --- a/tests/examples/example_tx.cpp.em +++ b/tests/examples/example_tx.cpp.em @@ -86,4 +86,3 @@ for tap_num in range(max_tap_pos + 1): } my_tx; AMIModel *ami_model = &my_tx; ///< The pointer required by the API implementation. - diff --git a/tests/examples/runs/posttap1.run b/tests/examples/runs/posttap1.run index ab703b9..724cf35 100644 --- a/tests/examples/runs/posttap1.run +++ b/tests/examples/runs/posttap1.run @@ -83,4 +83,3 @@ Sweep of Tx pre-emphasis filter posttap1 values. } \ ) \ ) - diff --git a/tests/examples/runs/posttap2.run b/tests/examples/runs/posttap2.run index 6c7025f..c56a667 100644 --- a/tests/examples/runs/posttap2.run +++ b/tests/examples/runs/posttap2.run @@ -83,4 +83,3 @@ Sweep of Tx pre-emphasis filter posttap2 values. } \ ) \ ) - diff --git a/tests/examples/runs/pretap.run b/tests/examples/runs/pretap.run index 18df01c..07f95a9 100644 --- a/tests/examples/runs/pretap.run +++ b/tests/examples/runs/pretap.run @@ -95,4 +95,3 @@ Sweep of Tx pre-emphasis filter pretap values. } \ ) \ ) - diff --git a/tests/examples/tests/freq_resp.em b/tests/examples/tests/freq_resp.em index 6107f0a..c6c2235 100644 --- a/tests/examples/tests/freq_resp.em +++ b/tests/examples/tests/freq_resp.em @@ -1,8 +1,8 @@ @# Example input file for `run_tests.py'. -@# +@# @# Original Author: David Banas @# Original Date: July 20, 2012 -@# +@# @# Copyright (c) 2012 David Banas; All rights reserved World wide. @@ -101,4 +101,3 @@ savefig(filename2) @(filename2) - diff --git a/tests/test_run_tests.py b/tests/test_run_tests.py index 96b9b32..629b07e 100644 --- a/tests/test_run_tests.py +++ b/tests/test_run_tests.py @@ -2,7 +2,13 @@ import pytest -from pyibisami.tools.run_tests import color_picker, plot_name, hsv2rgb, expand_params, run_tests +from pyibisami.tools.run_tests import ( + color_picker, + expand_params, + hsv2rgb, + plot_name, + run_tests, +) class TestRunTests(object):