pyFormex reference manual — pyFormex 0.9.1 documentation

### Navigation

- index
- modules |
- next |
- previous |
- pyFormex 0.9.1 documentation >

# pyFormex reference manual

Abstract

This is the reference manual for pyFormex 0.9.1. It describes most of the classes and functions defined in the pyFormex modules. It was built automatically from the pyFormex sources and is therefore the ultimate reference document if you want to look up the precise arguments (and their meaning) of any class constructor or function in pyFormex. The Index and Module Index may be helpful in navigating through this document.

This reference manual describes the classes in functions defined in most of the pyFormex modules. It was built automatically from the docstrings in the pyFormex sources. The pyFormex modules are placed in three paths:

- `pyformex` contains the core functionality, with most of the geometrical transformations, the pyFormex scripting language and utilities,
- `pyformex/gui` contains all the modules that form the interactive graphical user interface,
- `pyformex/plugins` contains extensions that are not considered to be essential parts of pyFormex. They usually provide additional functionality for specific applications.

Some of the modules are loaded automatically when pyFormex is started. Currently this is the case with the modules `coords`, `formex`, `arraytools`, `script` and, if the GUI is used, `draw` and `colors`. All the public definitions in these modules are available to pyFormex scripts without explicitly importing them. Also available is the complete `numpy` namespace, because it is imported by `arraytools`.

The definitions in the other modules can only be accessed using the normal Python `import` statements.

## Autoloaded modules

The definitions in these modules are always available to your scripts, without the need to explicitely import them.

- 1. `coords` — A structured collection of 3D coordinates.
- 2. `formex` — Formex algebra in Python
- 3. `arraytools` — A collection of numerical array utilities.
- 4. `script` — Basic pyFormex script functions
- 5. `draw` — Create 3D graphical representations.
- 6. `colors` — Playing with colors.

## Other pyFormex core modules

Together with the autoloaded modules, the following modules located under the main pyformex path are considered to belong to the pyformex core functionality.

- 7. `geometry` — A generic interface to the Coords transformation methods
- 8. `connectivity` — A class and functions for handling nodal connectivity.
- 9. `adjacency` — A class for storing and handling adjacency tables.
- 10. `elements` — Definition of elements.
- 11. `mesh` — Finite element meshes in pyFormex.
- 12. `simple` — Predefined geometries with a simple shape.
- 13. `project` — project.py
- 14. `utils` — A collection of miscellaneous utility functions.
- 15. `geomtools` — Basic geometrical operations.
- 16. `fileread` — Read geometry from file in a whole number of formats.
- 17. `filewrite` — Write geometry to file in a whole number of formats.

## pyFormex GUI modules

These modules are located under pyformex/gui.

- 18. `widgets` — A collection of custom widgets used in the pyFormex GUI
- 19. `menu` — Menus for the pyFormex GUI.
- 20. `colorscale` — Color mapping of a range of values.
- 21. `actors` — OpenGL actors for populating the 3D scene.
- 22. `decors` — 2D decorations for the OpenGL canvas.
- 23. `marks` — OpenGL marks for annotating 3D actors.
- 24. `gluttext` — 2D text decorations using GLUT fonts
- 25. `canvas` — This implements an OpenGL drawing widget for painting 3D scenes.
- 26. `viewport` — Interactive OpenGL Canvas embedded in a Qt4 widget.
- 27. `camera` — OpenGL camera handling
- 28. `image` — Saving OpenGL renderings to image files.
- 29. `imageViewer` — A general image viewer
- 30. `imagearray` — Convert bitmap images into numpy arrays.
- 31. `appMenu` — Menu with pyFormex apps.
- 32. `toolbar` — Toolbars for the pyFormex GUI.

## pyFormex plugins

Plugin modules extend the basic pyFormex functions to variety of specific applications. Apart from being located under the pyformex/plugins path, these modules are in no way different from other pyFormex modules.

- 33. `calpy_itf` — Calpy interface for pyFormex.
- 34. `cameratools` — Camera tools
- 35. `ccxdat` —
- 36. `ccxinp` —
- 37. `curve` — Definition of curves in pyFormex.
- 38. `datareader` — Numerical data reader
- 39. `dxf` — Read/write geometry in DXF format.
- 40. `export` — Classes and functions for exporting geometry in various formats.
- 41. `fe` — Finite Element Models in pyFormex.
- 42. `fe_abq` — Exporting finite element models in Abaqus™ input file format.
- 43. `fe_post` — A class for holding results from Finite Element simulations.
- 44. `flavia` —
- 45. `inertia` — inertia.py
- 46. `isopar` — Isoparametric transformations
- 47. `isosurface` — Isosurface: surface reconstruction algorithms
- 48. `lima` — Lindenmayer Systems
- 49. `neu_exp` — Gambit neutral file exporter.
- 50. `nurbs` — Using NURBS in pyFormex.
- 51. `objects` — Selection of objects from the global dictionary.
- 52. `partition` — Partitioning tools
- 53. `plot2d` — plot2d.py
- 54. `polygon` — Polygonal facets.
- 55. `polynomial` — Polynomials
- 56. `postproc` — Postprocessing functions
- 57. `properties` — General framework for attributing properties to geometrical elements.
- 58. `pyformex_gts` — Operations on triangulated surfaces using GTS functions.
- 59. `section2d` — Some functions operating on 2D structures.
- 60. `sectionize` — sectionize.py
- 61. `tetgen` — Interface with tetgen
- 62. `tools` — tools.py
- 63. `trisurface` — Operations on triangulated surfaces.
- 64. `turtle` — Turtle graphics for pyFormex
- 65. `units` — A Python wrapper for unit conversion of physical quantities.
- 66. `vascularsweepingmesher` — Vascular Sweeping Mesher
- 67. `webgl` — View and manipulate 3D models in your browser.

## pyFormex plugin menus

Plugin menus are optionally loadable menus for the pyFormex GUI, providing specialized interactive functionality. Because these are still under heavy development, they are currently not documented. Look to the source code or try them out in the GUI. They can be loaded from the File menu option and switched on permanently from the Settings menu.

Currently avaliable:

- geometry_menu
- formex_menu
- surface_menu
- tools_menu
- draw2d_menu
- nurbs_menu
- dxf_tools
- jobs menu
- postproc_menu
- bifmesh_menu

## pyFormex tools

The main pyformex path contains a number of modules that are not considered to be part of the pyFormex core, but are rather tools that were used in the implementation of other modules, but can also be useful elsewhere.

- 68. `olist` — Some convenient shortcuts for common list operations.
- 69. `mydict` —
- 70. `odict` — Specialized dictionary type structures.
- 71. `collection` — Tools for handling collections of elements belonging to multiple parts.
- 72. `config` — A general yet simple configuration class.
- 73. `flatkeydb` — Flat Text File Database.
- 74. `sendmail` — sendmail.py: a simple program to send an email message
- 75. `timer` — A timer class.

### Navigation

- index
- modules |
- next |
- previous |
- pyFormex 0.9.1 documentation >