Nominal: API

The Nominal simulation backend runs on a C# library. This contains the infrastructure of the simulation code for all products, including Nominal Editor, Nominal Studio and the public API. Although the Unreal products access the simulation architecture via the Mono runtime interpreter, nominalpy and Editor.CSharp can access the library in other ways. The Python interface to the public API, nominalpy, enables easy-to-access simulation objects that can run scenarios via the REST endpoints. In this case, the code is deployed on the cloud and can be accessed via HTTP requests and a valid API key. The C# scripting environment, Editor.CSharp is provided alongside Nominal Editor builds and allows for custom code to be written and compiled for the simulation. This environment has reference libraries from Nominal’s core infrastructure that allow for classes to be created that work in the simulation.

This page includes articles that are auto-generated from the C# simulation library and the Python API. Each module showcases the public (accessible) functions and variables within the components that can be accessed within Nominal Editor, Nominal Studio or a C# implementation of the code. The code is broken down into sections divided by the namespaces of each script.

For more information on how to access the data within the C# classes and Python API, see the Guides page of the documentation, particularly the C# Scripting and Python Scripting sections.