Create a synthetic data generator function

[leouieda]

Description of the desired feature:

We'll need to test the method and provide examples using synthetic data. It would be great to have a function that can generate these synthetic data using randomly placed dipoles. The data would look something like this:

This is based on code from this notebook: https://github.com/compgeolab/micromag-euler-dipole/blob/main/code/02_complex_synthetic.ipynb

Requirements:

• The dipoles should be distributed somewhat randomly (uniform distribution).
• The dipole moments should be random (gaussian around a specified direction and intensity).

The function can be called multiple times to generate synthetics with 2 or more grain populations.

Possible function design:

def synthetic_random_dipoles(region, spacing, inclination, declination, angular_std, intensity, intensity_std):
    ...
    return data, dipole_coordinates, dipole_moments

Here region = [xmin, xmax, ymin, ymax, zmin, zmax], spacing is the grid spacing of the data, inclination and declination are the mean direction, intensity is the dipole moment intensity, and the _std are the standard deviations for the gaussian distributions.

Are you willing to help implement and maintain this feature?

I'll let @YagoMCastro do it 😉