pyibis-ami 7.1.0__tar.gz

pyibis_ami-7.1.0/LICENSE

@@ -0,0 +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.

pyibis_ami-7.1.0/MANIFEST.in

@@ -0,0 +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 *

pyibis_ami-7.1.0/PKG-INFO

@@ -0,0 +1,134 @@
+Metadata-Version: 2.2
+Name: pyibis-ami
+Version: 7.1.0
+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.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: System :: Emulators
+Classifier: Topic :: Utilities
+Requires-Python: <3.13,>=3.10
+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-7.1.0/README.md

@@ -0,0 +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
+
+### 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-7.1.0/docs/source/ami.rst

@@ -0,0 +1,27 @@
+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
+------
+
+Sorry, the code in this module breaks the *Sphinx* ``autodoc`` processor.
+So, we have to exclude it from these docs.
+You'll have to peruse the comments in the code, manually.
+See the ``pyibisami/ami/parser.py`` file.

pyibis_ami-7.1.0/docs/source/conf.py

@@ -0,0 +1,311 @@
+# -*- coding: utf-8 -*-
+#
+# PyIBIS-AMI Developer Guide documentation build configuration file, created by
+# sphinx-quickstart on Tue Feb 10 10:04:12 2015.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+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("../../src"))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.coverage",
+    "sphinx.ext.todo",
+    # "sphinx.ext.autosummary",
+    "m2r2",
+]
+autodoc_default_options = {
+    "undoc-members": True,
+    "inherited-members": False,
+    "show-inheritance": True,
+    "members": True,
+    "exclude-members": "default_traits_view",
+}
+autodoc_mock_imports = [
+    "chaco",
+    "click",
+    "em",
+    "enable",
+    "matplotlib",
+    "numpy",
+    "parsec",
+    "pyibisami.ami.parser",
+    "pyibisami.ibis.parser",
+    "scipy",
+    "traits",
+    "traitsui",
+]
+autoclass_content = "both"
+autodata_content = "both"
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The suffix of source filenames.
+source_suffix = ".rst"
+
+# The encoding of source files.
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = "index"
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+project = "PyIBIS-AMI User's Guide"
+copyright = "2015, David Banas"
+author = "David Banas"
+
+# 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 = "7.1"
+# The full version, including alpha/beta/rc tags.
+release = "7.1.0"
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+# today = ''
+# Else, today_fmt is used as the format for a strftime call.
+# today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+# 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
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+# keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = "sphinx_rtd_theme"
+todo_include_todos = True
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+# html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+# html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+# html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+# 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
+
+# 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
+
+# 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"]
+
+# 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 = []
+
+# 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'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+# html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+# html_domain_indices = True
+
+# If false, no index is generated.
+# html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+# html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+# html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+# html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+# html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+# 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'
+
+# A dictionary with options for the search language support, empty by default.
+# Now only 'ja' uses this config value
+# 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'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "PyIBIS-AMIUserGuidedoc"
+
+# -- Options for LaTeX output ---------------------------------------------
+
+# latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+# Latex figure (float) alignment
+#'figure_align': 'htbp',
+# }
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+# latex_documents = [
+#     ("index", "PyIBIS-AMIDeveloperGuide.tex", "PyIBIS-AMI Developer Guide Documentation", "David Banas", "manual"),
+# ]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+# latex_use_parts = False
+
+# If true, show page references after internal links.
+# latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+# latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+# latex_appendices = []
+
+# If false, no module index is generated.
+# 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", "PyIBIS-AMI Developer Guide Documentation", ["David Banas"], 1)]
+
+# If true, show URL addresses after external links.
+# man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+# texinfo_documents = [
+#     (
+#         "index",
+#         "PyIBIS-AMIDeveloperGuide",
+#         "PyIBIS-AMI Developer Guide Documentation",
+#         "David Banas",
+#         "PyIBIS-AMIDeveloperGuide",
+#         "One line description of project.",
+#         "Miscellaneous",
+#     ),
+# ]
+
+# Documents to append as an appendix to all manuals.
+# texinfo_appendices = []
+
+# If false, no module index is generated.
+# texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+# texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+# texinfo_no_detailmenu = False

pyibis_ami-7.1.0/docs/source/ibis.rst

@@ -0,0 +1,22 @@
+pyibisami.ibis
+==============
+
+IBIS related submodules in the *PyIBIS-AMI* package.
+
+file
+----
+
+.. automodule:: pyibisami.ibis.file
+
+model
+-----
+
+.. automodule:: pyibisami.ibis.model
+
+parser
+------
+
+Sorry, the code in this module breaks the *Sphinx* ``autodoc`` processor.
+So, we have to exclude it from these docs.
+You'll have to peruse the comments in the code, manually.
+See the ``pyibisami/ibis/parser.py`` file.

pyibis_ami-7.1.0/docs/source/index.rst

@@ -0,0 +1,27 @@
+.. PyIBIS-AMI Developer Guide documentation master file, created by
+   copying PyIBIS-AMI Sphinx files on Tue Jan 24 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+*PyIBIS-AMI* API User's Guide
+==============================
+
+Welcome to the *PyIBIS-AMI* API user's documentation!
+
+Contents
+--------
+
+.. toctree::
+   :maxdepth: 2
+
+   install
+   modules
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+.. mdinclude:: ../../README.md

pyibis_ami-7.1.0/docs/source/install.rst

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

pyibis_ami-7.1.0/docs/source/modules.rst

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