# mpytest

Run functionality tests for OpenFOAM Foundation software with automated
validation within an CI environment. This tool executes tests on simulation
data and adds a code-specific success or error messages to the log file.

## Usage

```bash
mpytest <function> [options] actual desired
```

## Functions

### almostequal - Numerical Comparison

Tests if two objects are equal up to desired precision.

```bash
mpytest almostequal [options] actual desired
```

The tool utilizes the
[numpy.almostequal](https://numpy.org/doc/stable/reference/generated/numpy.testing.assert_array_almost_equal.html)
function.

## Examples

### Basic Comparison

Compare simulation output with reference:

```bash
mpytest almostequal result.csv reference.csv
```

### Custom Precision

Test with 6 decimal places:

```bash
mpytest almostequal --decimal 6 simulation.dat validation.dat
```