diff --git a/doc/sphinx/source/index.rst b/doc/sphinx/source/index.rst index abe4fc1..fd63f13 100644 --- a/doc/sphinx/source/index.rst +++ b/doc/sphinx/source/index.rst @@ -1,98 +1,102 @@ .. Tamaas documentation master file, created by sphinx-quickstart on Mon Apr 29 18:08:33 2019. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Tamaas --- A blazingly fast rough contact library ================================================= +.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3479236.svg + :target: https://doi.org/10.5281/zenodo.3479236 + + Tamaas (from تماس meaning "contact" in Arabic and Farsi) is a high-performance rough-surface periodic contact code based on boundary and volume integral equations. The clever mathematical formulation of the underlying numerical methods (see e.g. `10.1007/s00466-017-1392-5 `_ and `arXiv:1811.11558 `_) allows the use of the fast-Fourier Transform, a great help in achieving peak performance: Tamaas is consistently :doc:`two orders of magnitude faster ` (and lighter) than traditional FEM! Tamaas is aimed at researchers and practitioners wishing to compute realistic contact solutions for the study of interface phenomena. Library overview ---------------- Tamaas is mainly composed of three components: - Random surface generation procedures - Model state objects and operators - Contact solving procedures These parts are meant to be independent as well as inter-operable. The first one provides an interface to several stochastic surface generation algorithms described in :doc:`rough_surfaces`. The second provides an interface to a state object :py:class:`Model ` (and C++ class :cpp:class:`tamaas::Model`) as well as integral operators based on the state object (see :doc:`model`). Finally, the third part provides contact solving routines that make use of the integral operators for performance (see :doc:`contact`). .. toctree:: :maxdepth: 2 :caption: Table of Contents: ./quickstart ./rough_surfaces ./model ./contact ./examples ./performance ./api_reference Seeking help ------------ You can ask your questions on `c4science `_ using this `form `_. If you do not have an account, you can create one `here `_. Contribution ------------ Code .... To contribute code to Tamaas, you can use `Arcanist `_ to send code differentials. In a nutshell, the process to contribute is: 1. Create a branch for the modifications you wish to submit 2. Work on your branch (commits + run tests) 3. ``arc diff`` to send your code for review 4. Commit any requested changes 5. ``arc diff`` to send your modifications For reviewers: 1. Checkout a code differential using ``arc patch D???`` 2. Accept the code differential on `c4science `_. 3. ``arc land`` to merge the differential 4. Profit with ``arc anoid`` Bug reports ........... You can also contribute to Tamaas by reporting any bugs you find `here `_ if you have an account on `c4science `_. Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search`