=============
API reference
=============

This section contains the API reference and usage information for **ciclope**.

ciclope core modules
--------------------

Voxel Finite Elements
~~~~~~~~~~~~~~~~~~~~~

.. automodule:: ciclope.core.voxelFE
   :members:
   :undoc-members:
   :show-inheritance:

Tetrahedra Finite Elements
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: ciclope.core.tetraFE
   :members:
   :undoc-members:
   :show-inheritance:

ciclope utilities
-----------------

Data pre-processing
~~~~~~~~~~~~~~~~~~~

.. automodule:: ciclope.utils.preprocess
   :members:
   :undoc-members:
   :show-inheritance:

MicroCT reconstruction utilities
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: ciclope.utils.recon_utils
   :members:
   :undoc-members:
   :show-inheritance:

Post-processing of FE results
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: ciclope.utils.postprocess
   :members:
   :undoc-members:
   :show-inheritance: