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]

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

should be fixed

[lucas-wilkins]

TODO: set the icon

[rozyczko]

Import data doesn't show which extensions can be used for import. I can't actually find a file in our examples, which I can load :(
Not even magtool own CSV files from Utilities\MuMag\SANSData

[lucas-wilkins]

There should be a whole bunch of example files. Currently you need to load a folder, there's three example datasets in qtgui/Utilities/MuMag/SANSData - final location TDB.

…

On Mon, Oct 28, 2024 at 10:33 AM Piotr Rozyczko ***@***.***> wrote: Import data doesn't show which extensions can be used for import. I can't actually find a file in our examples, which I can load :( — Reply to this email directly, view it on GitHub <#2825 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACKU4SWWBBMQ6YTVRS3EEBTZ5YAE5AVCNFSM6AAAAABEYCYSQ2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINBRGE4TSOJXGI> . You are receiving this because your review was requested.Message ID: ***@***.***>

[krzywon]

I've tested and reviewed the code. Overall, things look good from a functionality and code standpoint, but I do have a number of suggestions. The documentation, file loading, and MuMagLib class suggestions are probably necessary. The others would be good to have.

[krzywon]

Please either treat MuMagLib as a class, or remove the class entirely. Another option is to have these three methods inside simple_fit()

[lucas-wilkins]

I think I just disagree with this one. I think static classes are neater.

[krzywon]

typo - (1) A brute for search. Also, I don't understand the last sentence. What three connected values? Only two are described here. Do you mean the other three values? Should the last sentence be separate from the scan range?

[lucas-wilkins]

You misread it - but the fact you misread it is evidence that it was unclear. Have tried to make it clearer.

[krzywon]

Any error thrown from any file, regardless the number of successful data loads, will throw away all loaded data. If the try/catch was around the data loading loop, the filename and error could be stored until the data loading is complete and then log the issue.