Skip to content
Quanscient logo Quanscient Allsolve Docs

Introduction

The Allsolve Public API and Python SDK enable programmatic control of your simulations, allowing you to automate workflows, run parameter sweeps, perform optimizations, and integrate Allsolve into your existing computational pipelines.

What you can do with the API/SDK

Automation & Integration

  • Automate simulation workflows and batch processing
  • Integrate Allsolve simulations into existing computational pipelines
  • Create custom tools and applications on top of Allsolve

Parameter Studies & Optimization

  • Run large-scale parameter sweeps and sensitivity analyses
  • Implement custom optimization algorithms
  • Perform design space exploration with hundreds of parallel simulations

Project Management

  • Create and manage projects programmatically
  • Import geometries and set up simulations via code
  • Define projects declaratively using YAML/JSON configuration files

Advanced Simulation Control

  • Control all aspects of simulation setup: meshes, physics, materials, and boundary conditions
  • Run simulations with custom Python scripts
  • Monitor simulation progress and retrieve results programmatically

SDK Features

The Python SDK provides high-level classes and methods to:

  • Project Management: Create, copy, and manage projects
  • Geometry Import: Support for STEP, IGES, BREP, SAT, GDSII, MSH, and NAS files
  • Mesh Control: Configure mesh settings, refinements, and quality parameters
  • Material Definition: Create and manage materials with custom properties
  • Region Management: Define geometric regions that are available for meshing and simulation
  • Simulation Setup: Configure solver settings, runtime parameters, and hardware configuration
  • Results Processing: Retrieve simulation outputs, fields, and post-processing data
  • Job Monitoring: Track simulation progress and handle logs

Documentation Resources

API Reference

Complete SDK reference with all classes, methods, and parameters:

Limitations (Beta)

  • The OpenAPI definition for the public API not available yet
  • No high level physics definitions available. GUI generated scripts can be easily used though.
  • API endpoints may change before public release