theng: Thunderhead Utilities

Subject to Change

The theng package is a very new package. The package and portions of this documentation may change without notice as we continue to work towards the 1.0.0 release. We will attempt to strictly follow the Semantic Versioning standard during this period, however we cannot make any promises.

Tune in to Our Website to watch for the official 1.0 release!

Overview

theng is a data processing toolset for common Life Safety simulators and a collection of utilities for displaying processed data in Thunderhead Results. This toolset is designed for use in the Scripting Engine of the Thunderhead Results Viewer, however it can also be used in standalone Python scripts.

Installation

The theng package can be installed either from PyPi using pip, or directly from source:

pip install theng

Getting Started

Follow the Getting Started guide to familiarize yourself with theng.

Documentation Overview

This Document is broken up in to the following Sections:

Guides

This section provides helpful guides that walk you through common use-cases of theng. If you discover a scenario that you think could use a guide, please reach out to support@thunderheadeng.com and we can look in to adding one.

Top Guides

API

This section provides developer documentation of the theng package. In general, the classes described in this section operate behind the scenes and should not be instantiated directly. This section should mainly be used as a point of reference to understand typing and available instance attributes/methods.

Each page in this section details a module in the theng package, and all of the members of the module that are publicly accessibly. One exception to this rule is the theng page, which details the members publicly accessible directly from the top-level theng package.

Special Thanks

  • Support for FDS is provided through a thin wrapper around the fdsreader package developed by Forschungszentrum Jülich. Special thanks to the developers for their hard work.