Operation API using the Python language
Last update: 03.07.2024
Operation API using the Python language
The Ansys Motion Standalone Postprocessor C# library can be used in the python code by using Python.NET or IronPython.
System requirements
If you are using CPython, you will need to install Python.NET first.
pip install pythonnet
Notes
- As shown in the figures below, to create curves using the Operation API, you need to know the following information. When you see the "AddCurves" function within the UI, you can observe Characteristics and Components. The combination of these paths(Characteristics, Components) can be used as input values within the function "AddCurves"
How to execute Operation API
For executing operations, Import file includes Python script as follows :
- Make the file includes operation script.
- Import the file on Postprocessor.(Dropdown menu -> Import -> Python Script)
The API class
The Ansys Motion Standalone Postprocessor C# library supports the headless application interface. The API class allows you to use it.
from VM.Operations.Post.Models import *
applicationHandler = ApplicationHandler()
# Enter your code here.
Example
The following sample code illustrates how to create and analyze a simple example:
# Using Python.NET
# Import the appropriate classes from .Net C# library.
from System.Collections.Generic import List
# Import the appropriate classes from the Ansys Motion Standalone Postprocessor C# library.
from VM.Models.OutputReader import *
from VM.Operations.Post.Models import *
# Start the headless application interface
applicationHandler = ApplicationHandler()
# Import result file
filepath = r'result file path'
paths = List[str](1)
paths.Add(filepath)
applicationHandler.AddDocument(paths)
# Create PlotView
chartView = applicationHandler.AddPlotView()
# Get a active plot view
chartView = applicationHandler.GetActivePlotView()
# Create Curve
parameters = PlotParameters()
parameters.Paths = List[str](2)
parameters.Target = "BD_001"
parameters.Paths.Add(r'Displacement/X')
parameters.Paths.Add(r'Displacement/Z')
chartView.AddCurves(filepath, parameters)
# Close a view
applicationHandler.RemoveView("view name")
# Close a Document
applicationHandler.RemoveDocument("result file path")