Skip to content

Cheat sheet improvements #4603

Closed
Closed

Description

@seanpearsonuk

The current PyFluent cheat sheet has a few areas for improvement:

Structural Issues

  1. Too verbose.
  2. Repetitive boilerplate (imports, launching, reading, etc.).
  3. Too many detailed, low-level categories; lacks overarching structure.
  4. Too many procedural steps per panel such that it reads like a tutorial.
  5. Some outdated or inconsistent information.
  6. Sheet is 7 pages; cheat sheets should be 1–2.

UX / API Presentation Issues

  1. Uses nonessential examples module.
  2. Overly verbose objects (pyfluent.VelocityInlet).
  3. Prefers set_state() over direct assignment.
  4. Inclusion of stale modules (e.g. legacy visualization patterns).
  5. Missing modern features:
    • VariableDescriptor
    • Solver enums (26R1)
    • Updated meshing workflow (26R1)
    • PyAnsys units usage

Incorrect / Outdated Content

  • Misspellings ("case-data", title typos).
  • field_data and transactions outdated.
  • Orphaned Scheme evaluation title.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions