Package Concurrent

SIMulation Workbench Model Access Port Client API

This API implements the ASAM AE HIL model access port specification
for Concurrent's SIMulation Workbench real-time target systems.

Only the model access port (MAPort) client is supported by this API.
Additional 'packages' needed by the MAPort are contained herein, but
should be of no general interest to the user.

All modules and methods are fully documented using the standard
Python documentation mechanisms (pydoc, help(), etc.).

The complete PDF specification for this standard can be found as a
link in the top-level PYToolkit documentation.

*** USE OF THIS PACKAGE PLACES CERTAIN REQUIREMENTS ON THE SimWB
    TEST DEFINITION:

    - The test must be using the '.default' initial conditions set.
    - Logging must be enabled.
    - The logging is NOT 'Direct I/O' (unchecked in the GUI).
        (this is now only a recommendation).
    - The SIMWB_TARGET environment variable must be properly set
        (see the simwbClient getTarget() description for details
         on what this should be for your test),
                             -or-
      A SimWB target configuration XML file must be have been
        created.
    - The user ID used to log in via the Platform class (or the
      user ID currently logged into if a test is running and the
      test is accessed via the MAPort) MUST have admin or power privileges.
      In addition, the group ID of the test must also be in the
      set of groups attached to the user ID.
    - OPTIONAL: Logging is unbuffered (by setting 'dlunbufferedio=1' in
        /etc/ccursim.conf).  Without this you may recieve slightly less
        capture data than expected (data logger caching and system load
        could result in a race condition between your read request and
        SimWB's ability to get the data to disk). Changing dlunbuffered
        will require a SimWB restart (service simwb restart).

*** Use of the MDF 4.0 writer requires the 'asammdf' package. I suggest
    using pip to first install the prerequisites:
            numpy
            xlrd
            xlwt
            xlsxwriter
    and then
            asammdf
    Do not forget to install these using each version of python that
    you plan on using to run your scripts.

While using the Concurrent ASAM package, nearly all actions are
logged into the 'Concurrent.log' file (in the working directory of
the running script). This file can be invaluable when debugging
or tracing script execution, and is the first place to look when
something goes wrong in either the client or the server.

Copyright (c) Concurrent Real-Time