Quick start

• C++ Take a look at the unit tests, found in the library's source (.cpp or .cu) files.

  #include <pbat/Pbat.h>

• Python To download and install from PyPI, run in command line

  pip install pbatoolkit

  or, alternatively

  pip install pbatoolkit-gpu

  if your environment is properly setup to use our GPU algorithms.

  Verify pbatoolkit's contents in a Python shell

  import pbatoolkit as pbat
  help(pbat.fem)
  help(pbat.geometry)
  help(pbat.profiling)
  help(pbat.math)
  help(pbat.gpu)

  A bunch of Python scripts demonstrating usage of pbatoolkit can be found in the examples folder, along with their associated requirements.txt for easily downloading necessary dependencies via pip install -r path/to/requirements.txt.

  Their command line interface follows the pattern

  python[.exe] path/to/examples/[example].py -i path/to/input/mesh

  The full interface is always revealed by -h or --help, i.e.

  python[.exe] path/to/examples/[example].py -h

  Note

  The examples assume the user provides the meshes to pbatoolkit. Triangle (surface) meshes can easily be obtained via Thingi10K, TurboSquid or authored yourself in Blender. Tools like TetWild, fTetWild and TetGen can then convert them into tetrahedral (volume) meshes. We provide helper scripts to facilitate mesh processing and their associated requirements.txt.

Example results are showcased in our Gallery.

Previous	Next
Features	Gallery