Search Icon

    Model Generation with PPL_Min Package

    PPL_Min API

    Overview

    PPL_Min is an application programming interface (API) designed to generate valid and properly structured pole models for use within the O‑Calc Pro pole loading analysis system. The package ensures that all generated models satisfy O‑Calc’s geometric requirements and automatically assigns appropriate default values for necessary parameters and constants.

    The package is distributed as a .NET Standard 2.0 assembly, enabling full cross‑platform compatibility. It can be accessed from a variety of environments and languages, including:

      • Python (via PyNet)
      • C# and other .NET languages
      • WASM‑based runtimes
      • JavaScript, for both client‑side and server‑side execution

    For web‑focused applications, a pure JavaScript version is available for direct use in the browser. On the server, the .NET assembly may be accessed via Edge.js from Node.js, or the JavaScript package may be used natively.

    Core Concepts

    O‑Calc Pro models all physical and conceptual components as objects derived from the base class PPLElement. Each specialized element class encapsulates the regulatory rules, physical constraints, and behavioral logic required for that particular item.

    For example:

      • PPLCrossarm inherits from PPLElement and incorporates all structural, geometric, and metadata attributes required to correctly represent a crossarm within O‑Calc Pro.

    Collectively, these classes form the O‑Calc schema—the complete definition of all elements, their relationships, and their attributes.
    The schema provides authoritative documentation of:

      • Element types
      • Attribute names
      • Attribute definitions and constraints

    Understanding and referencing the schema is essential for building, editing, or manipulating O‑Calc model structures programmatically. The O-Calc Pro Schema is described on this WIKI Post.

    Getting Started

     There are multiple O-Calc Pro WIKI posts that emphasizes learning the PPL_Min by example. These WIKI posts will walk through practical usage of the PPL_Min API to help new users quickly gain familiarity and confidence using a few different languages.

     C#/.Net Examples 

    JavaScript Examples

     

     Note:
    All of these examples require a valid PPL_Min API Key to function. Please contact Osmose at ocalc@osmose.com for availability and pricing on these API keys.