Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
M-Star CFD documentation
Light Logo Dark Logo

Getting Started

  • Introduction
    • Modeling Your First Process
  • Installation
    • System Requirements
    • Hardware Guide
    • Platform Diagnostics
    • Windows
    • Linux (Single Node)
    • Linux (Multi Node)
    • AWS
      • AWS Prerequisites
      • AWS (Linux)
      • AWS Advanced (EFS, PCluster, NICE DCV)
    • Azure
    • Google Cloud
    • Containers
      • Singularity
      • M-Star CFD Docker Container
    • Python Install
    • FFmpeg Linux Install
    • Remote Visualization (NICE DCV)
    • Windows Python Setup Guide
    • Troubleshooting M-Star Pre/Post start up
  • Licensing
    • Workstation License
    • Floating/Network License
    • M-Star License Utility
    • Troubleshooting License Issues
  • Tutorial Videos
    • Simple Agitated Tank
    • Free Surface Dynamics
    • Particle Blending and Suspension Modeling
    • Recirculation Systems
    • Sloshing Systems
    • Python Overview
    • Python Model Properties
    • Optimization Example
    • Mixing Tank Example
    • Python CLI Example
    • Fill Points
    • Tanks with Inlets and Outlets
    • Importing CAD Geometry
    • Using Nearest Neighbor Distance Distributions
    • Zonal Analysis
    • Types of Averaging
    • Predicting Forces on Solid Bodies
    • On and Off Lattice Boundary Conditions
    • Computed Velocity
    • Buffer Length
    • Using the Aggregator Tool
    • Introduction to M-Star Post
    • Working with Slices in M-Star Post
    • Working with Volumes in M-Star Post
    • Selecting Surfaces for Boundary Conditions
    • Gas Induction Modeling
    • Python Annotation in M-Star Post
  • How-To Guides
    • Modeling Chemical Reactions
    • Cooling and Dilution
    • Choosing a Simulation Resolution: Agitated Tanks
    • Loading Initial State
    • Predicting mass transfer (kLa) in gasified bioreactors
    • Mixing Bioreactors with Bottom Mounted Impellers
    • Computing Blend Time on any Model
    • Predicting Forces and Torques
    • Duplicate Object Pattern
    • Viewing Panel Functions
    • Custom Rheology in T-Junction Pipe
    • Custom Particle Variables
    • Simple Controller Tutorial
    • JKR Adhesion and Capillary Bridging Interaction Model for DEM
    • Residence Time Distribution
    • Tutorial for Optimizer: Complex
    • Tutorial for Optimizer: Simple
    • Design of Experiments (DOE) in M-Star CFD
  • Knowledge Base
    • Warnings and Errors
      • “No Fluid” Related Errors
    • M-Star Pre or Post does not start up on AWS on a Windows instance
    • CUDA-aware MPI
    • M-Star CFD version 4.0.x notes
    • NVRTC compilation error (Linux)
    • Understanding GPU peer access
    • Solver start up delay

M-Star Pre

  • Overview
    • Menu
      • CAD Assembly Explorer
      • Preferences
    • Toolbar
    • Context-Specific Toolbar
      • Add Conduction Surface Boundary Conditions
      • Add Conduction Volume Boundary Conditions
      • Add Fill Point
      • Add Geometry
      • Add Inclusion Zone
      • Add Isosurface Variable
      • Add Moving Body Variable
      • Add Particle Injection
      • Add Particle Reaction
      • Add Particle Scalar
      • Add Particle Variable
      • Add Patch
      • Add Refinement Zone
      • Add Scalar Injection
      • Add Static Body Reaction
      • Add Static Body Variable
      • Add Variable
      • Define Axis
      • Diagnostics
      • Edit Lookup Table
      • Edit Mesh
      • Edit Parameter Sweep
      • Edit Global Constants
      • Explode
      • Fit Bounding Box
      • Flip
      • Inlet/Outlet Setup
      • Mate
      • Move
      • Preview Flow
      • Recenter
      • Reset
      • Reset Box
      • Resize
      • Rotate
      • Scale
      • Trim
      • Volume Calculator
    • Navigation Icons
    • Viewing Panel
    • Log Window
    • Program Information
    • GUI Command Line Arguments
  • Model Tree
    • Simulation Parameters
    • Fluid Configuration
    • Main Lattice
      • External Accelerations
  • Child Geometry
    • Parametric Geometry Catalogue
      • Parametric Impellers
      • Parametric Miscellaneous
      • Parametric Moving Geometry
      • Parametric Pipes
      • Parametric Primitives
      • Parametric Tanks
    • Non-Parametric Geometry Catalog
    • Child Geometry Context-Specific Toolbar
  • Fluid
    • Single Phase
    • Free Surface
    • Immiscible Two Fluid
    • Background Fluid
    • No Fluid
    • Newtonian
    • Power-law
    • Carreau
    • Cross
    • Bingham Plastic
    • Custom Fluid
  • Create
    • Create: Fundamentals
      • Static Body
      • Moving Body
        • Motion Type
          • Motion Modifier Option
          • Driven Motion
      • Static Inlet Outlet
        • Boundary Condition Types
      • Moving Inlet Outlet
    • Create: Particles
      • Massless Tracers
      • Inertial Particles
      • Discrete Element Particles
        • DEM Particle Interactions with Solid and Static Bodies
      • Liquid Droplets
      • Gas Bubbles
      • Injection Option
      • Initial Particle Size Distribution Type
      • Advanced Particle Injection
      • Forces and Fluid Coupling
      • Breakup/Coalesce
      • Scalar Coupling and Thermal Coupling
    • Create: Lattice
      • Porous Medium
    • Create: Scalar
      • Scalar Field
        • Static Inlet Outlet Boundary Conditions
      • Fluid Reaction
    • Create: Variables
      • Voxel Variables
      • Global Variables
        • Global Variable Data Sources
      • Global Constants
      • UDF Region
    • Create: Runtime
      • Global Script
      • Control Loop
      • Statistic Filter
      • Event Detector
      • Lookup Table
      • Function Library
    • Create: Thermal
      • Thermal
      • Static Body Conduction
      • Thermal Contact
    • Create: Output
      • Probe
      • Probe Array
      • Output Line
      • Output Planes
      • Control Volume
      • Output Control Panel
      • Output Data Structure
    • Create: Analysis
      • Output Surface
      • Isosurface
      • Zonal Analysis
      • Mean Age
      • Histogram
  • Output
  • Check
    • Check Model
    • Preview Lattice
    • Preview Surface Meshes
    • Preview Motions
    • Preview Solver Output Files
  • Solve
    • Run Solver
    • Run Auto Resolver
    • Run Optimizer
    • Add Parameter Sweep to Solver Queue
    • Add to Solver Queue
  • UDFs and Tables
    • UDF and Table Editors
    • System UDF
    • Local UDF
    • Two-Column Tables
    • Multi-Column Table

M-Star Solve

  • Running the Solver
    • Standard Solver GUI
    • Solver Command Line Interface
    • M-Star Queue
    • M-Star Resolver
    • M-Star Optimizer
    • How to use Restart Initialization
  • Workflow and Integration
    • Parameter Sweeps
    • Global Scripts
    • Volume Fill Utility

M-Star Post

  • Post Processing
    • M-Star Post Overview
      • Post Menu
        • Edit Settings
      • Post Toolbar
      • Post Ray Tracing Toolbar
      • Post 3D Controls
      • Post Timestep Toolbar
      • Post Data Tree
      • Post 3D View
      • Post Output Messages
      • Post Property Panel
      • Troubleshooting
    • Post-Processing
    • Output Aggregator
    • Output Manager
    • Ffmpeg
  • Scaling Performance

M-Star API

  • Python Pre API
    • Examples
      • Command Line Example
      • Optimize Blend Time
      • Mixing Tank
      • Simple Case
      • Python Parameter Sweep
      • Workflow Parameter Sweep
      • Scripted CAD pre-processing with build123d
      • Sweep over CAD files
      • Sweep over CAD files + 1D parameter sweep
    • Installation
    • Module functions
    • Model
    • Components
    • Properties
    • Mesh Settings
    • Output
    • Foundation Classes
    • Initial State

More Resources

  • Validation / Literature
    • Flow in the Trailing Vortex of an Impeller
  • Theory
    • Theory and Implementation
    • Large Eddy Simulation Review
    • Porous Medium Review
    • Nearest Neighbor Distribution
  • Architecture Technical Overview
    • Data Flow
    • Software Architecture
    • Technical Diagrams
    • Quality/Security Assurance
  • Webinars
  • References
Back to top

Python Annotation in M-Star Post¶

Download Sample File: Python Annotation Case

Download Sample File: Text File - Python Annotation String

Next
How-To Guides
Previous
Gas Induction Modeling
Copyright © 2025 M-Star Simulations, LLC
Made with Furo