.. siml documentation master file, created by
   sphinx-quickstart on Mon Dec 28 19:11:24 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. image:: fig/siml_logo.svg
  :width: 400
  :alt: SiML

SiML: A Simulation ML library
=============================
*SiML* is a machine learning library focusing on geometrical and simulation
data.
It facilitates machine learning processes, including preprocessing, learning,
and prediction.
In particular, SiML has handy functionalities to handle geometrical data,
which are in graph or point cloud formats in general.


Installation
============

SiML supports Python 3.9 or newer.
SiML can be installed via pip
(note that the name of the package is :code:`pysiml`):

.. code-block:: bash

  $ pip install pysiml

However, the name of the module used to import is :code:`siml`.

.. code-block:: python

  import siml


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

  examples/index
  siml


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

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