User Guide#

Package Overview#

MyMesh has a collection of algorithms for generation, manipulation, and analysis of 2D and 3D meshes. These capabilities are organized into the following submodules:

booleans

Boolean operations for meshes

contour

Tools for extracting isosurfaces from images or implicit functions

converter

Mesh conversion tools

curvature

Tools for calculating curvature

delaunay

Delaunay triangulation and related methods

image

Image-based meshing tools

implicit

Implicit function meshing tools

improvement

Mesh quality improvement

octree

Octree data structure and related methods.

primitives

Mesh generation for pre-defined shapes

quality

Element quality measurements

rays

Ray casting and intersection tests

utils

Various mesh utilities

visualize

Mesh visualization and plotting

Importing MyMesh#

There are several ways MyMesh can be imported and used.

import mymesh
S = mymesh.primitives.Sphere([0,0,0], 1)

Alternatively, submodules can be imported directly as

from mymesh import primitives
S = primitives.Sphere([0,0,0], 1)

Or to import all submodules (and the mesh class), they can be imported as using *, but this should be done carefully to avoid conflicts with other variables or modules that might have the same names.

from mymesh import *
S = primitives.Sphere([0,0,0], 1)