Skip to main content
The simulators API provides access to simulator configurations registered in CDF. Simulators represent external simulation software (like process simulators, reservoir simulators, or structural analysis tools) that can be integrated with CDF. You can list and filter available simulators in your project.

​
What simulators are

Simulators are metadata records that describe external simulation software available in your CDF project. Each simulator entry identifies the software type, version, and configuration needed to run simulations. Simulators serve as the foundation for simulator models, routines, and runs.

​
Listing and filtering

You can list all simulators in your project and filter them by criteria such as name or type. This helps you discover which simulation tools are available and select the right one for your use case.
Simulators are typically registered during setup of a simulator integration. You usually do not create or delete simulators directly through the API.

​
Common use cases

  • Discover available simulators: List simulators to see what simulation software is configured.
  • Drive automation: Use simulator metadata when building automation that runs simulations.
  • Integrate with models and routines: Reference simulators when creating or running simulator models and routines.
Use the simulators API to inspect and work with the simulation capabilities configured in your CDF project.

​
Rate and concurrency limits

For Simulators rate and concurrency limits, see API rate limits.
Last modified on April 23, 2026