===================
arim Documentation
===================

.. toctree::
    :maxdepth: 2
    :hidden:

    installation/index
    user/index
    examples/index
    api

**Date**: |today| **Version**: |release|

**Links**:
`Install <user_install>`_ |
`Source <https://github.com/ndtatbristol/arim>`_ |
`Help & Support <https://github.com/ndtatbristol/arim/issues>`_

arim is a Python library for the modelling and imaging of ultrasonic inspections for nondestructive testing.

Features currently include:

- Ray-based forward modelling for contact and immersion inspections in 2D.
- Imaging via the total focusing method (TFM) and multi-view TFM for contact and immersion inspections.


.. grid:: 1 2 2 2
    :gutter: 4
    :padding: 2 2 0 0
    :class-container: sd-text-center

    .. grid-item-card:: Installation
        :link: user_install
        :link-type: ref

        Install arim
		
    .. grid-item-card:: User Guide
        :link: user_guide
        :link-type: ref

        In-depth information on key concepts in arim

    .. grid-item-card:: API reference
        :link: api
        :link-type: ref

        The reference guide for the arim API.
		
    .. grid-item-card:: Development
        :link: dev_install
        :link-type: ref

        Guide for development


Citation
--------

If arim has formed a significant part of your work and you would like to acknowledge us, please cite the following paper:

- N. Budyn, R. L. T. Bevan, J. Zhang, A. J. Croxford and P. D. Wilcox, "A Model for Multiview Ultrasonic Array Inspection of Small Two-Dimensional Defects," in IEEE Transactions on Ultrasonics, Ferroelectrics, and Frequency Control, vol. 66, no. 6, pp. 1129-1139, June 2019, doi: `10.1109/TUFFC.2019.2909988 <https://doi.org/10.1109/TUFFC.2019.2909988>`_.