Installation

Python Package Index (PyPI)

MyMesh can be installed from the python package index (PyPI):

pip install mymesh[all]

Installing from source:

Download/clone the repository from github, then run:

pip install -e <path>/mymesh[all]

with <path> replaced with the file path to the mymesh root directory. To install with only the required dependencies, the [all] can be omitted.

Dependencies

MyMesh depends on a small number of built-in or well established python packages. Additionally, there are several optional dependencies that are required only for specific functions or use-cases.

Core dependencies

Package	Install
numpy	pip install numpy
scipy	pip install scipy
sympy	pip install sympy

Optional dependencies

Package	Purpose	Used in	Install
meshio	Mesh file I/O	mesh	pip install meshio
numba	Enhanced efficiency	delaunay, utils, quality	pip install numba
pydicom	DICOM image file I/O	image	pip install pydicom
opencv (cv2)	Image file I/O	image	pip install opencv-python
triangle	Constrained Delaunay	delaunay	pip install triangle
vispy	Mesh visualization	visualize	pip install vispy
matplotlib	Mesh visualization	visualize	pip install matplotlib
pillow	Mesh visualization	visualize	pip install pillow
jupyter_rfb	Mesh visualization	visualize	pip install jupyter_rfb
colorspacious	Mesh visualization	visualize	pip install colorspacious

MyMesh can be used without these optional dependencies and if a function requires them, an error will be raised instructing the user to install the needed dependency.