# arim

**Repository Path**: lou_wei_yao/arim

## Basic Information

- **Project Name**: arim
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-12-27
- **Last Updated**: 2020-12-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

arim
=====

A Python 3 library for modelling and imaging in ultrasonic testing.

## Features

- 2D forward model for ultrasonic array immersion inspection of small defects,
- multi-view Total Focusing Method imaging for contact and immersion inspections.

## Getting started

Download the latest release and documentation of arim at https://github.com/ndtatbristol/arim/releases

arim includes [example scripts](https://github.com/ndtatbristol/arim/tree/master/examples).

## Installation

The recommended Python distribution is [Anaconda 3](https://www.anaconda.com/distribution/).
arim can be installed from a wheel file downloaded in the [release page](https://github.com/ndtatbristol/arim/releases) (``documentation.zip``) using

    pip install arim-X.X-py3-none-any.whl

Alternatively, if git is installed:
    
    pip install git+https://github.com/ndtatbristol/arim.git

See the Installation section of the documentation for full instructions.

## See also

Companion package [arimtoolkit](https://github.com/nbud/arimtoolkit) to analyse datasets

## Citing arim

Budyn, Nicolas, Rhodri L. T. Bevan, Jie Zhang, Anthony J. Croxford, and Paul D. Wilcox. 2019. ‘A Model for Multiview Ultrasonic Array Inspection of Small Two-Dimensional Defects’. IEEE Transactions on Ultrasonics, Ferroelectrics, and Frequency Control, April. https://doi.org/10.1109/TUFFC.2019.2909988.