Adds feature "plot current sheet"

[wzq215]

PR Description

Adds feature 'plot_current_sheet.' (#53)
Extracts the current sheet (isosurface where Br=0) from pfsspy output by pyvista.

current_sheet.py is an example script that plots the current sheet, gong map, and field lines together.

[TrestanSimon]

pre-commit.ci autofix

[TrestanSimon]

pre-commit.ci autofix

@wzq215 I do not have write access to your fork so I do not think I can request an autofix; but if you comment pre-commit.ci autofix on this PR, it should automatically fix the issues causing the pre-commit.ci check to fail. (Or you can run pre-commit locally and commit the fixes.)

[wzq215]

pre-commit.ci autofix

[TrestanSimon]

We might also want to add some tests for plot_current_sheet. Maybe something like test_field_lines_figure.

[wzq215]

Hi, I wrote a test (test current sheet) but fail to run any tests in the script... The error message is:

ERROR: usage: _jb_pytest_runner.py [options] [file_or_dir] [file_or_dir] [...]
_jb_pytest_runner.py: error: unrecognized arguments: --doctest-rst
 inifile: /Users/ephe/codes/sunkit-pyvista/setup.cfg
 rootdir: /Users/ephe/codes/sunkit-pyvista

[wzq215]

pre-commit.ci autofix

[wzq215]

pre-commit.ci autofix

[TrestanSimon]

Hi, I wrote a test (test current sheet) but fail to run any tests in the script... The error message is:

ERROR: usage: _jb_pytest_runner.py [options] [file_or_dir] [file_or_dir] [...]
_jb_pytest_runner.py: error: unrecognized arguments: --doctest-rst
 inifile: /Users/ephe/codes/sunkit-pyvista/setup.cfg
 rootdir: /Users/ephe/codes/sunkit-pyvista

@wzq215 To run tests locally you may need to download some or all of the extra dependencies in setup.cfg:

[options.extras_require]
tests =
  pytest
  pytest-cov
  pytest-doctestplus
  scikit-image
docs =
  ipython
  sphinx
  sphinx-automodapi
  sphinx-changelog
  sphinx-gallery
  streamtracer
  sunpy-sphinx-theme

[nabobalis]

I pushed an update that fixes the main CI failure and tweaks the image generation flags needed for pytest. You will have to either merge in upstream/main or press the update branch button at the bottom of the pull request (I assume anyone with write access can see it).

[nabobalis]

Is this the definition of a current sheet in a PFSS model?

[Cadair]

Hi @wzq215

We have recently forked pfsspy and made sunkit-magex so I am looking over related things again. Is this PR something you are interested in coming back to, or would you like me to adopt it?

[Cadair]

Is the way we are loading the output here the same as in #72?

[nabobalis]

Not sure but it should be looked at. I would hope we can that code instead.

If we can expand the code in 72 to work for all frames and return all the surfaces, we can then change this to plot a surface based on user input.

[nabobalis]

Sorry this took so long @wzq215