2531 add mumag to tools

[Funkmich008]

Description

The following issue is fixed:
Issue: Add MuMag to tools #2531

Reference DOI to the Paper:
https://doi.org/10.1107/S1600576722005349

Reference Link to the MATLAB interface:
https://files.uni.lu/mumag/

Fixes # (issue/issues)

How Has This Been Tested?

Test run in the developer environment with experimental and synthetic test data.

• import data from the test data
• press the buttons

Review Checklist:

[if using the editor, use [x] in place of [ ] to check a box]

Documentation (check at least one)

• There is nothing that needs documenting
• Documentation changes are in this PR
• There is an issue open for the documentation (link?)

Installers

• There is a chance this will affect the installers, if so
  • Windows installer (GH artifact) has been tested (installed and worked)
  • MacOSX installer (GH artifact) has been tested (installed and worked)

Licencing (untick if necessary)

• The introduced changes comply with SasView license (BSD 3-Clause)

[krzywon]

Hello, @Funkmich008. Thank you for your submission. We appreciate the time you put into this and think the tool will be a great addition to SasView.

As far as acceptance goes, there are a few organizational items I think we will need taken care of before this can be approved:

• We try to keep a clean separation between the calculation elements and gui elements (though we aren't perfect in that matter). Ideally, all calculation elements, which includes the majority of MuMagLib.py, MuMagParallelGeo.py, and MuMagPerpendicularGeo.py, should live in a subdirectory of sas/sascalc Any plotting, visualization, and GUI elements should remain within sas/qtgui.
• All data sets used by this package should live in sas/example_data, again in their own sub-directory. All data sets in the example_data subpackage are included in the SasView distributables. I'm not certain the files you included here will be bundled with the release, and if they are, will not be in an obvious location.
• The Utilities/MuMagTool and Utilities/MuMagTool/UI directories should have an __init__.py file. Our build process expects directories to have this file, otherwise the directory is not bundled in the distributable.

Other suggestions that would greatly help, but could be handled at a later date:

• Documentation: Documentation should include in-code documentation for developrs, and a help file, ideally in the ReST format. You already have a PDF for your MatLab based tool. Updating it for SasView would be a great first step in this.
• Many of your calculation functions use the same subset of arguments. Create a class or series of classes to hold those values and convert the functions to class methods. This could minimize the number of arguments you need to pass.
• Unit tests: Any tests that prove the calculations and GUI intercation behave as expected would be useful. Adding a comment in each calculation function with an expected result for a known set of arguments would be a good first step in this process.
• Any of my inline comments.

[butlerpd]

Unfortunately, trying to run the installer on windows fails with the following "unhandled exception in script"

Traceback (most recent call last):
  File "sasview.py", line 15, in <module>
  File "sas\cli.py", line 161, in main
  File "sas\qtgui\MainWindow\MainWindow.py", line 106, in run_sasview
  File "sas\qtgui\MainWindow\MainWindow.py", line 42, in __init__
  File "PyInstaller\loader\pyimod02_importers.py", line 385, in exec_module
  File "sas\qtgui\MainWindow\GuiManager.py", line 38, in <module>
ModuleNotFoundError: No module named 'sas.qtgui.Utilities.MuMagTool'

This will clearly need to be fixed. I did not test on macOS but suspect a similar error?

[lucas-wilkins]

Unfortunately, trying to run the installer on windows fails with the following "unhandled exception in script"

Think we need some init.py's in the mumag directories

[lucas-wilkins]

@Funkmich008 Think everything is done. We still need to sort out the docs.

should be fixed

[lucas-wilkins]

TODO: set the icon