Skip to main content

PyDUST Utils

PyPI version Python 3.9+ Coverage Tests License: MIT

Python utilities for DUST pre- and post-processing.

Features

  • Mesh Generation: Create pointwise and parametric meshes for DUST simulations
  • C81 Airfoil Data: Generate aerodynamic tables using NeuralFoil/AeroSandbox
  • Post-Processing: Parse and analyze DUST output files (sectional loads, probes, integral forces)
  • Visualization: 3D visualization of meshes, flow fields, and vortex structures with PyVista

Installation

Installation from PyPI:

pip install pydust-utils[gui]  # Include GUI dependencies (PyQt5, PyVista)

To launch the mesh builder GUI after installation:

dust-mesh-builder  # Automatically handles Qt library conflicts on Linux

For development:

git clone git@gitlab.com:Alecocco.1994/dust-private.git
cd dust-private/pydust_utils
pip install -e ".[dev,docs,gui]"

Launching the GUI

The package provides multiple ways to launch the mesh builder GUI with automatic Qt library conflict resolution:

After pip install (Recommended):

dust-mesh-builder

For development/from source:

./run_mesh_gui.sh          # Shell script (development only)
python test_enhanced_gui.py  # Python script with auto-fix

Manual environment setup (if needed):

export LD_LIBRARY_PATH="$(python -c 'import PyQt5.QtCore, os; print(os.path.join(os.path.dirname(PyQt5.QtCore.__file__), "Qt5", "lib"))'):$LD_LIBRARY_PATH"
python -m pydust_utils.launch_gui

Note: On some Linux systems, Qt may conflict with system libraries. The dust-mesh-builder command and launcher scripts automatically fix these conflicts.
📖 For troubleshooting, see GUI Troubleshooting Guide

Quick Start

Generation of Pointwise Mesh

from pydust_utils.build_mesh import Point, Line, MeshConfig, PointwiseMesh

# Create mesh configuration
config = MeshConfig(
    title='Wing Mesh',
    el_type='v',  # vortex-lattice
    nelem_chord=20,
    type_chord='cosine_le'
)

# Define wing geometry with points
points = [
    Point(
        id=1,
        coordinates=[0.0, 0.0, 0.0],
        chord=1.0,
        twist=0.0,
        airfoil='naca0012',
        airfoil_table='naca0012'
    ),
    Point(
        id=2,
        coordinates=[0.0, 5.0, 0.5],
        chord=0.8,
        twist=-2.0,
        airfoil='naca0012',
        airfoil_table='naca0012'
    ),
]

# Connect points with lines
lines = [
    Line(
        type='spline',
        nelem_line=10,
        end_points=[1, 2],
        type_span='uniform'
    )
]

# Generate mesh file
mesh = PointwiseMesh(config, points, lines)
mesh.write('wing_pointwise.in')

Generation of Parametric Mesh

from pydust_utils.build_mesh import Section, Region, MeshConfig, ParametricMesh

# Create mesh configuration
config = MeshConfig(
    title='Wing Mesh',
    el_type='v',  # vortex-lattice
    nelem_chord=20,
    type_chord='cosine_le'
)

# Define wing geometry with points
sections = [
    Section(
        chord=1.0,
        twist=0.0,
        airfoil='naca0012',
        airfoil_table='naca0012'
    ),
    Section(
        chord=0.8,
        twist=-2.0,
        airfoil='naca0012',
        airfoil_table='naca0012'
    ),
]

# Connect points with lines
regions = [
    Region(
        sweep=0,
        dihed=2,
        nelem_span=10,
        type_span='uniform'
    )
]

# Generate mesh file
mesh = ParametricMesh(config, sections, regions)
mesh.write('wing_parametric.in')

C81 Airfoil Data Generation

from pydust_utils.c81generator import generate_airfoil_data

# Generate C81 aerodynamic table
airfoil = generate_airfoil_data(
    file_name='naca0012',
    pathprofile='airfoils/',
    reynolds=1e6,
    mach_range=(0.0, 0.3),
    n_mach=10,
    mbdynformat=False  # Use DUST format
)

Post-Processing

from pydust_utils import read_sectional, read_probes, read_integral

# Read sectional loads
sectional_data = read_sectional('sectional_loads.dat')
print(sectional_data.sec.shape)  # (n_time, n_sec)

# Read probe velocities
probe_data = read_probes('probes_velocity.dat')
print(probe_data.velocities.shape)  # (n_time, n_probes, 3)

# Read integral loads
integral_data = read_integral('integral_loads.dat')
lift = integral_data.forces[:, 2]  # Extract lift force

Visualization

import h5py
import pyvista as pv
from pydust_utils import ColorMapManager, FlowPostProcessor, plot_dustpre_pv

# Visualize DUST pre-processor mesh from HDF5 output
with h5py.File('geo_input.h5', 'r') as f:
    rr = f['Components/Comp001/Geometry/rr'][:]
    ee = f['Components/Comp001/Geometry/ee'][:]

plotter = plot_dustpre_pv(rr, ee, title="Blade Mesh", rendering_backend="trame")

# Load custom colormap and create flow post-processor
cm_manager = ColorMapManager('colormaps/cool_warm.json')
flow_viz = FlowPostProcessor(colormap_manager=cm_manager)

# Visualize Q-criterion for vortex identification
flow_data = pv.read('flow_volume.vtr')
plotter = flow_viz.visualize_q_criterion(
    flow_data,
    q_min=0.01,
    q_max=10.0,
    opacity=0.3,
    colormap='cool_warm'
)
plotter.show()

# Visualize vorticity with vector glyphs
flow_slice = pv.read('flow_slice.vtr')
plotter = flow_viz.visualize_vorticity_glyphs(
    flow_slice,
    scale=0.1,
    opacity=0.7,
    glyph_type='arrow'
)
plotter.show()

Available Features

Mesh Generation (build_mesh)

  • Pointwise meshes: Define geometry with specific control points
  • Parametric meshes: Use sections and regions for automatic interpolation
  • Multiple element types: Vortex-lattice ('v'), lifting-line ('l'), panel ('p')
  • Advanced distributions: Uniform, cosine, geometric series with refinement options

Airfoil Data (c81generator)

  • C81 table generation: Create aerodynamic coefficient tables
  • NeuralFoil integration: Use neural networks for predictions
  • Multiple Reynolds numbers: Support for Re-dependent tables
  • DUST and MBDyn formats: Compatible with multiple solvers

Post-Processing (parse_postpro_files)

  • read_sectional - Sectional aerodynamic loads
  • read_probes - Velocity probe data
  • read_chordwise - Chordwise pressure distributions
  • read_integral - Integral loads and forces
  • read_hinge - Hinge loads for control surfaces

Visualization (visualization)

  • plot_dustpre_pv: Visualize DUST pre-processor mesh output (HDF5 files)
    • Interactive (trame) and static rendering modes
    • Support for main and virtual mesh elements
    • Customizable colors, edges, and camera settings
  • ColorMapManager: Load and manage custom colormaps from ParaView/Matplotlib
  • FlowPostProcessor: Advanced flow field visualization
    • Q-criterion and Lambda2 vortex identification
    • Vorticity magnitude and vector field glyphs
    • Sectional flow visualization with customizable styling

Documentation

Build documentation locally:

cd pydust_utils
pip install -e ".[docs]"
sphinx-build -b html docs/source docs/build/html

Running Tests

pip install -e ".[dev]"
pytest tests/

Current Status: 156 tests, 94% coverage

Contributing

This package is developed and maintained by the DUST team at Politecnico di Milano.

Publishing

Build and upload to PyPI (maintainers only):

# Build distribution
pip install build
python -m build

# Upload to PyPI
pip install twine
twine upload dist/*

License

MIT License - Copyright (c) 2025 Alessandro Cocco, Politecnico di Milano


Made with ❤️ by the DUST team at Politecnico di Milano

Metadata

Release files for pydust-utils 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pydust-utils 0.2.0
File Size Uploaded Provenance Actions
pydust_utils-0.2.0.tar.gz 104.3 kB Without provenance Details for pydust_utils-0.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pydust-utils 0.2.0
File Interpreter ABI Platform Actions
pydust_utils-0.2.0-py3-none-any.whl Python 3 none any Details for pydust_utils-0.2.0-py3-none-any.whl

Total release size: 187.0 kB

Release files / pydust_utils-0.2.0.tar.gz

Download URL pydust_utils-0.2.0.tar.gz
Size 104.3 kB
Tags Source
SHA-256 checksum
How to use checksums
784e9e1eaa78f10fb8809020549bb8fa45172db9b4beefbefa1f4af754e92630
BLAKE2b-256 checksum
How to use checksums
e9f145bb0f4f5bc53d4870fe0b3dcc9625b6c2732d9b15c1102b2333ebaad240
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Release files / pydust_utils-0.2.0-py3-none-any.whl

Download URL pydust_utils-0.2.0-py3-none-any.whl
Size 82.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
11f68cfd6b8596d191a734ac6d340c0883e84db5edd9187340161c3ab6fd15e0
BLAKE2b-256 checksum
How to use checksums
46eb6235efed9c494b020871b97cd5299b85336d976b680fcb90cbc1c637922f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Security for pydust-utils 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page