Skip to main content
Ctrl+K
日本語
日本語
EMSolution Documentation - Home EMSolution Documentation - Home
  • User Guide
    • I. Analysis Types and Modules
    • II Using EMSolution
      • Installation Guide
        • Installing License Protection Software
        • License File Protection
        • Installing on Windows
        • Installing on Linux
      • Input Files
      • How to Run EMSolution
        • Running on Windows
        • Running on Linux
        • Running from Python
        • 3. Restarting an Analysis
    • III. Input Settings
      • 0. Release Number
      • 1. Execution Control
      • 2. Analysis Type
      • 3. Potentials and Gauge Conditions
      • 4. Shape Function Orders and Additional Features
      • 5. Convergence Conditions
      • 6. Gaussian Integration Points
      • 7. Initial Conditions
      • 8. Calculation Steps (Time-Domain Analysis, Including Static Analysis)
      • 8.2 Calculation Frequency (Frequency-Domain Analysis)
      • 9. Output Steps
      • 10.1 Input Files
      • 10.2 Output Files
      • 10.3 Post-Processing Data Output Files
      • 11. Output options
      • 12. Analysis Dimensions and Local Coordinate Systems
      • 13. Boundary Conditions
      • 14. Periodic Boundary Conditions
      • 15. Automatic Block Mesh Generation
      • 16. Element Properties
      • 16.1 Volume Element Properties
      • 16.1.2 Volume Element Properties (Electric-Field Analysis)
      • 16.2 Surface Element Properties
      • 17 Field Sources
      • 17.1 External Current Field Source
      • 17.2 Internal Current Source
      • 17.3 Surface-Defined Current Source
      • 17.4 Potential Current Source
      • 17.5 Multi-Conductor Potential Current Source
      • 17.6 Surface-Inlet Current Source
      • 17.7 Magnetization-Vector Source
      • 17.8 Power Supplies and Connections (CIRCUIT)
      • 17.9 Power Supplies and Connections (NETWORK)
      • 17.10 Equipotential-Surface Electric-Field Source
      • 17.11 Nodal-Potential Source
      • 18. Time-Variation Functions
      • 19. Motion Definition
      • 20. B-H curve
      • 21. Temperature-Dependent Conductivity Curve
      • Appendix 1: Formula Input
      • Appendix 2: Current and Magnetic Field Sources
      • List of Calculation Formulae
    • 2D_to_3D : two-dimensional to three-dimensional conversion
    • V Input Mesh Files
    • VI Output Files
      • VI-1. Output Mesh Files
      • VI-2. Post Files
      • VI-3. Fixed Format Files
      • VI-4. output and output.json
    • VII Error Messages
    • VIII. Release Notes
  • Input Control File Editor
  • Sample input.json Code
  • pyemsol API
    • pyemsol API Reference
    • External Mesh Morphing Integration
    • Examples
      • Python Script Examples Using pyemsol
    • Showcase
      • Running Parameter Surveys
  • .rst

pyemsol API

pyemsol API#

pyemsol provides Python bindings for running and updating EMSolution. Public APIs are governed both by their binding implementation in EMSolution and by whether they are intended for users. Not every function callable from Python is a public API. For new scripts, first choose a lifecycle from pyemsol API Reference.

  • pyemsol API Reference
    • General Usage Rules
    • Choosing an API
    • Single-Run and Iterative Analyses
    • Updates During Iterative Analysis
    • External Mesh Morphing Integration
    • Compatibility APIs for Existing Scripts
    • Information
  • External Mesh Morphing Integration
    • Overview
    • Execution flow
    • Python APIs used
    • Static mesh topology (schema version 2)
    • Dynamic deformation description (schema version 1)
    • Payload returned by the external tool
    • Results and validation
    • External-tool acceptance checks
    • Current limitations
  • Examples
    • Python Script Examples Using pyemsol
  • Showcase
    • Running Parameter Surveys

previous

Sample input.json Code

next

pyemsol API Reference

By Hiroyuki Kaimori

© Copyright 1996-2025, Science Solutions International Laboratory, Inc..