TReK Python

Table of Contents

• Getting Starting
  • Windows Users
    • Python installation
  • Linux Users
    • Python installation

The Python Package provides the TReK Telemetry, Command and Data API's from the Python language. This package is layered atop the existing C++ API (see C++ API for more information). While Python is not as performant as C++, it is an effective means for applications where performance is less critical such as rapid development and testing or to integration with existing Python implementations.

This implementation currently requires Python 3.8+.

Getting Starting

To use the TReK Python implementation, the Python package module must be installed in your Python package environment using the "pip" installer (i.e. installing TReK does not do this step). In addition, this package depends on proper installation of the dependent TReK libraries to function and is not a full package installer (one that installs the depedencies for you). Environment variables associated with those installations must be available and are referred below in the platform instructions.

To "get started":

1. Installation
   • Install for Windows Users
   • Install for Linux Users
2. Introduction
3. Tutorials
4. API Classes Provided

Windows Users

For windows, all the dependent Dynamic Link Libraries (DLLs) are installed by default. The package depends on TREK_LIB environment variable.

Python installation

To install the TReK Python, locate the .tar.gz below.

py -m pip install "c:\program files\trek 5.3.3\extras\pytrek-5.3.3.tar.gz"

Linux Users

For Linux, the Package depends on the following RPMs and depends on the TREKROOT environment variable:

1. trek-python (Contains the Python installation package)
2. trek-nativeinterop (Provides native interoperability between Pyton and C++)
3. trek-data (Supported API)
4. trek-cmd (Supported API)
5. trek-core (Supported API)

Python installation

To install the TReK Python, locate the .tar.gz below.

To install the Python Package within your Python environment:

python3.8 -m pip install /usr/trek-5.3.3/extras/pytrek-5.3.3.tar.gz

It also requires a newer version of attrs.

python3.8 -m pip install --upgrade attrs

Note

On some systems the "python" command may be different allowing for multiple versions of python on your system. For RHEL8, the package support Python 3.8 or above.

Sections

• Introduction
• Tutorials