Look at adding https://github.com/RobertJaro/NF2

[nabobalis]

Describe the feature

We should see if we can add support for https://github.com/RobertJaro/NF2

[mgjeon]

Has there been any progress on this? If not, may I attempt this?

[nabobalis]

There has been no progress on it.

You are free to try and work on this but there are major unanswered questions on how this would be integrated and how we would store the outputs via sunkit-magex.

[mgjeon]

I see. Also, I think there are other issues to consider.

Since sunkit-magex originates from pfsspy, it currently only supports global magnetic field extrapolation. However, the main focus of NF2 is the active region NLFFF extrapolation (although the author of NF2 seems to be implementing global extrapolation as well). Therefore, the direction of sunkit-magex needs to be clarified. I have the following questions:

1. Will sunkit-magex only support global extrapolation in the future, or will it also implement AR-scale magnetic field extrapolation?
2. NF2 requires significant GPU computation. If NF2 is implemented, a read option may be needed. However, I'm unsure if the read/visualization part is also implemented in sunkit-magex, as sunkit-pyvista exists for visualization.

[nabobalis]

1. Will sunkit-magex only support global extrapolation in the future, or will it also implement AR-scale magnetic field extrapolation?

The goal of this package is to eventually expand it to cover all types of extrapolations.

2. NF2 requires significant GPU computation. If NF2 is implemented, a read option may be needed. However, I'm unsure if the read/visualization part is also implemented in sunkit-magex, as sunkit-pyvista exists for visualization.

Ideally a combination of using sunkit-pyvista here would allow us to do the visualization as well.

[mgjeon]

The goal of this package is to eventually expand it to cover all types of extrapolations.

I think then the API will need to be adjusted accordingly, something like sunkit-magex.global and sunkit-magex.local, or sunkit-magex.pfss and sunkit-magex.nf2. Extrapolation methods, like DEM methods, involve various approaches (e.g., Wiegelmann's optimization method), so we will need to figure out how to handle these different methods effectively.

Ideally a combination of using sunkit-pyvista here would allow us to do the visualization as well.

Should the first step then be to upgrade sunkit-pyvista to accept NF2 files and visualize AR magnetic fields? The NF2 author provides extrapolation files (https://github.com/RobertJaro/NF2/wiki/AR-13664), which could serve as a useful reference.

I have little experience in software development, so any suggestions would be appreciated.

[nabobalis]

It would be cool to see more features added to sunkit-pyvista tho I have no idea how complex that will be for loading NF2 data.

When it comes to the API within sunkit-magex, the two maintainers can be asked for their thoughts. I assume that will undergo changes as the code is written.