SimWB PYToolkit
SIMulation Workbench's python toolkit, PYToolkit, provides a complete
client-side API for all of the SimWB capabilities related to test manipulation
and control. There are currently seven modules and one package in the toolkit.
Information on using the toolkit with different versions of python, and which
versions of Python are supported, can be found here.
This module is used to modify a Python program path so that
subsequent SimWB module imports will come from either a PYToolkit
install specifically for the version of Python being used, or
failing that, the default PYToolkit install.
This module provides complete SimWB configuration and control
from any machine with a network connection to the SimWB host (or
target), i.e. the system running the SimWB test.
A companion to simwbClient, this module contains constants, messages,
parameters, etc., that might be needed by simwbClient, or by the
user (depending on what you want to configure/control). This module
need not be directly imported by the user.
Another companion to simwbClient, this module gives you the ability
to connect to multiple systems at the same time (or to a single
system with different logins).
This module provides client access to the SimWB data logger
from any machine with a network connection to the SimWB logging
host (this need not be the same as the systerm running the test).
This module provides access to SimWB server-side API's
from any machine with a network connection to the SimWB host (or
target), i.e. the system running the SimWB test.
This package implements the ASAM HIL V1.0.2 specification for a Concurrent SIMulation
Workbench model access port. A complete functional description of this API can be
found in the first five sections of the specification. The original V1.0.0 specification
(provided here
in it's entirety) does not functionally differ from V1.0.2. All of the syntactic
and symantic changes are outlined here.
This package has been extended with the inclusion of several functions defined in the
ASAM XIL-MA V2.1.0 (the replacement for the ASAM HIL). These are duly noted in the
documentation.
When running on the SimWB server machine, this module is available for those wanting to
write SimWB initialization or test scripts in Python. The module has reduced functionality,
as it excludes configuration routines, and focuses on only those useful in a real-time
environment.
This module, while distributed with the PYToolkit, does not require the PYToolkit to use.
It is considered a part of the SimWB core and is distributed with the PYToolkit for
historical reasons.
There are python scripts, provided in source form, that the user might find useful and/or instructive. Also information about freely available Python modules that are required for enhanced data functionality.
From time to time routines may be deprecated and eventually removed from PYToolkit. These routines
will always issue warnings well in advance of their removal. This is a complete list of deprecated
routines and their replacements.
Project Documentation
All the following pages start and end with links to Trees, Index and Help.
The Trees page contains the module and class hierarchies:
- The module hierarchy lists every package and module, with
modules grouped into packages. At the top level, and within each
package, modules and sub-packages are listed alphabetically.
- The class hierarchy lists every class, grouped by base
class. If a class has more than one base class, then it will be
listed under each base class. At the top level, and under each base
class, classes are listed alphabetically.
The Index page contains indices of terms and
identifiers:
- The term index lists every term indexed by any object's
documentation. For each term, the index provides links to each
place where the term is indexed.
- The identifier index lists the (short) name of every package,
module, class, method, function, variable, and parameter. For each
identifier, the index provides a short description, and a link to
its documentation.
The Help is what you are viewing now.
