API Reference

This reference provides detailed information for all subpackages, modules, functions and objects included in TetraX. This is the place, if you need detailed information on what certain parts of the package are and what they do. If you want to learn how to use TetraX, please refer to the User Guide or the Examples.

User packages

These are the subpackages and modules that are regularly consulted by the user.

• TetraX tetrax

• Experiments tetrax.experiments

• Geometries tetrax.geometries

• Vectorfields tetrax.vectorfields

• Materials tetrax.materials

Internal modules

Packages/modules that are important to TetraX, but not often directly used.

• Common tetrax.common

• Interactions tetrax.interactions

• Plotting tetrax.plotting

• Sample tetrax.sample