.. age3d documentation master file, created by
   sphinx-quickstart on Mon Apr  3 23:50:07 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Age3d: A 3D Simulation for Erosion
==================================
.. image:: img/age3d_logo.png
  :alt: age3d Logo
  :width: 100%
  :align: center

Welcome to the Age3d Library. 
Age3D is a Python Library that allows for eroding of 3d models. 
It uses the .stl file format and incorporates Open3D functionality, allowing users to simulate material removal.

Features:

-  Conversion of ``.stl`` to ``TriangleMesh``
-  Allows for Segmentation of Mesh Vertices based on Height Params
-  Erodes Mesh by Simulating Erosion Particles

   -  Customizable Number of Particles
   -  Customizable Lifetime of Particles
   -  Performs Raycasting Computation to Only Remove Material

For a quickstart, Use the Getting Started which includes Installation of the library.

.. toctree::
   :maxdepth: 1
   :caption: Documentation

   getting_started
   documentation
   examples
   contributing

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

* :ref:`genindex`