.. ciclope documentation master file, created by
   sphinx-quickstart on Sat Jul 30 11:12:06 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

ciclope - computed tomography to finite elements
================================================

|PyPI license| |PyPI version shields.io| |PyPI pyversions| |Docs|

.. |PyPI license| image:: https://img.shields.io/pypi/l/ansicolortags.svg
   :target: https://pypi.python.org/pypi/ansicolortags/

.. |PyPI version shields.io| image:: https://img.shields.io/pypi/v/ciclope.svg
   :target: https://pypi.python.org/pypi/ansicolortags/

.. |PyPI pyversions| image:: https://img.shields.io/pypi/pyversions/ciclope.svg
   :target: https://pypi.python.org/pypi/ansicolortags/

.. |Docs| image:: https://readthedocs.org/projects/ciclope/badge/?version=latest
   :target: https://ciclope.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

.. image:: https://joss.theoj.org/papers/10.21105/joss.04952/status.svg
   :target: https://doi.org/10.21105/joss.04952

**ciclope** is an open-source Python package that processes micro Computed Tomography (microCT) 3D images to generate Finite Element (FE) models.

License
-------

The project is licensed under `the MIT License <https://opensource.org/licenses/MIT>`_.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   about
   install
   usage
   examples
   api
   acknowledgements

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`