Skip to content
Quanscient logo Quanscient Allsolve Docs

SDK Examples

The SDK includes several examples demonstrating different use cases. Currently they are available in the archive that you will receive once you request for access to the public API / SDK beta.

Full script template

Basic simulation setup with custom scripts and mesh import.

  • Use case: Running script-only simulations with custom geometry
  • Physics: Acoustics
  • Key features: Mesh import, script execution

Import Project

Create entire projects from declarative YAML/JSON configuration files.

  • Use case: Reproducible project setup and configuration management
  • Key features: Geometry import, region definition, material assignment

Geometric Sweep

Parameter sweep over geometric dimensions with parallel execution.

  • Use case: Design optimization and sensitivity analysis
  • Key features: Geometry parametrization, parallel execution

Permanent Magnet

Controlling and running a GUI-created project.

  • Use case: Running simulations on pre-configured projects
  • Key features: Project reuse, result retrieval

Optimization

Custom optimization using algorithms from well-known library SciPy with simulation-based objective functions.

  • Use case: Engineering design optimization
  • Key features: Custom optimization logic, iterative simulation

Simple Sweep

Basic parameter sweep implementation.

  • Use case: Parameter studies and sensitivity analysis
  • Key features: Variable parameter scanning