https://github.com/ABI-EIT/tetrahedralizer

Libraries and Apps for converting ABI Lungsim models to EIT models
https://github.com/ABI-EIT/tetrahedralizer

Last synced: 2 months ago
JSON representation

Libraries and Apps for converting ABI Lungsim models to EIT models

• Host: GitHub
• URL: https://github.com/ABI-EIT/tetrahedralizer
• Owner: ABI-EIT
• Created: 2022-03-07T00:31:04.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-05T22:09:06.000Z (10 months ago)
• Last Synced: 2024-07-31T23:44:36.391Z (5 months ago)
• Language: Python
• Size: 5.24 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Contributing: docs/contributing.rst

Awesome Lists containing this project

• awesome-eit - tetrahedralizer

README

        
===============

Tetrahedralizer

===============

Tetrahedralizer is an app and python library for automating the process of converting

surface meshes to volumetric meshes.

Documentation is available at: https://abi-eit.github.io/tetrahedralizer/

.. image:: _static/Tetrahedralizer_app_1.png

Tetrahedralizer is able to create a constrained tetrahedralization from any number of input

surfaces defining the boundaries of sections within the output mesh. The output mesh is saved

in a .vtu file (VTK unstructured grid) which preserves the individual sections and can be

easily imported into other programs for further processing. The entire process is configurable

through a user editable configuraiton file.

The individual features are also available to use through the Tetrahedralizer API.

Features

--------

* Mesh fixing with PyMeshfix

* Removal of shared mesh faces

* Boolean operations with PyMeshlab

* Tetrahedralization with gmsh

* Visualization with PyVista

* Automated tetrahedralization of multi-surface meshes

Installation

------------

Installation of Tetrahedralizer requires that you have python_ installed on your computer.

Once python is installed type the following command into your terminal:

.. code-block:: console

    $ pip install git+https://github.com/ABI-EIT/tetrahedralizer

To install the GUI app, run:

.. code-block:: console

    $ python -m tetrahedralizer --install tetrahedralizer_qt

This will create a folder containing the installation of the Tetrahedralizer GUI

app in your current directory. Run the app using tetrahedralizer_qt.exe contained within this folder.

.. _python: https://www.python.org/

Quick Start

-----------

To use the Tetrahedralizer app, simply select one outer mesh, representing the outermost boundary

of the desired output mesh, then select any number of inner meshes, representing the boundaries of inner

sections of the output mesh:

|select_outer| |select_inner|

.. |select_outer| image:: _static/select_outer_mesh.png

    :width: 45%

.. |select_inner| image:: _static/select_inner_meshes.png

    :width: 45%

Click Tetrahedralize, and the automated process will begin, with

progress displayed in the text box on the left had side of the screen. When finished, the

resulting tetrahedralized mesh will be saved as a .vtu file in the output directory of the

Tetrahedralizer installation:

|in_progress| |done|

.. |in_progress| image:: _static/Tetrahedralizer_in_progress.png

    :width: 45%

.. |done| image:: _static/tetrahedralizer_mock_done.png

    :width: 45%

Credits

-------

* Development Lead: Andrew Creegan