Homec4science
Diffusion tamaas (ci-fix-static-checks) Browse

tamaas/doc/sphinx/source/overview.rst
769e213d4b4cci-fix-static-checks

Last Change
Raw File

overview.rst
View Options

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 <tamaas._tamaas.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`).
.. _sect-tutorials:
Tutorials
---------
The following tutorial notebooks can also be used to learn about Tamaas:
- Elastic Contact (`live notebook
<https://mybinder.org/v2/git/https%3A%2F%2Fc4science.ch%2Fsource%2Ftamaas_tutorials.git/HEAD?filepath=elastic_contact.ipynb>`_,
`notebook viewer
<https://nbviewer.jupyter.org/urls/c4science.ch/source/tamaas_tutorials/browse/master/elastic_contact.ipynb/%3Fview%3Draw>`_,
`source <https://c4science.ch/source/tamaas_tutorials/>`_)
- Rough Surfaces (`live notebook
<https://mybinder.org/v2/git/https%3A%2F%2Fc4science.ch%2Fsource%2Ftamaas_tutorials.git/HEAD?filepath=rough_surfaces.ipynb>`_,
`notebook viewer
<https://nbviewer.jupyter.org/urls/c4science.ch/source/tamaas_tutorials/browse/master/rough_surfaces.ipynb/%3Fview%3Draw>`_,
`source <https://c4science.ch/source/tamaas_tutorials/>`_)
Changelog
---------
The changelog can be consulted `here <https://c4science.ch/source/tamaas/browse/master/CHANGELOG.md?as=remarkup>`_.
Seeking help
------------
You can ask your questions on `c4science <https://c4science.ch>`_ using this
`form
<https://c4science.ch/maniphest/task/edit/?owner=frerot&projectPHIDs=tamaas&view=public>`_.
If you do not have an account, you can create one `on this page <https://c4science.ch/auth/start/?next=%2F>`_.
Contribution
------------
Contributions to Tamaas are welcome, whether they are code, bug, or
documentation related.
Code
....
To contribute code to Tamaas, you can use `Arcanist
<https://secure.phabricator.com/book/phabricator/article/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 <https://c4science.ch>`_.
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
<https://c4science.ch/maniphest/task/edit/?owner=frerot&projectPHIDs=tamaas&view=public>`_
if you have an account on `c4science <https://c4science.ch>`_.
c4science · Help