Skip to content

sunpy/sunkit-pyvista

Repository files navigation

sunkit-pyvista

3D visualisation of solar physics data with pyvista.

Latest Version Documentation Status codecov matrix Powered by NumFOCUS

Installation

See the installation instructions for more information.

Developing

If you want to develop sunkit-pyvista you will need to install it from GitHub. For detailed installation instructions, see Development installation in the sunpy docs. These are for "sunpy" but the same works for sunkt-pyvista with a quick name substitution.

Running Figure tests

You need to use your local environment and make sure its up to date. This does not with tox for now.

2 command line arguments can be passed to pytest:

  • update_image_cache : Resets the image_cache directory with new figures generated from your local environment.
  • ignore_image_cache : Ignores the image cache and will not perform any image comparison.

Example usage:

pytest -s -vvv --update_image_cache sunkit_pyvista/

Using tox for this does not work for now.

Getting Help

For more information or to ask questions about sunkit-pyvista, check out:

Usage of Generative AI

We expect authentic engagement in our community. Do not post the output from Large Language Models or similar generative AI as code, issues or comments on GitHub or any other platform. If you use generative AI tools as an aid in developing code or documentation changes, ensure that you fully understand the proposed changes and can explain why they are the correct approach and an improvement to the current state. For more information see our documentation on fair and appropriate AI usage.

Contributing

We love contributions! sunkit-pyvista is open source, built on open source, and we'd love to have you hang out in our community.

If you would like to get involved, check out the Developers Guide section of the SunPy docs. Stop by our chat room #sunpy:openastronomy.org if you have any questions. Help is always welcome so let us know what you like to work on, or check out the issues page for the list of known outstanding items.

For more information on contributing to SunPy, please read our Newcomers' guide.

When you are interacting with the SunPy community you are asked at to follow our code of conduct.

About

3D visualisation of solar phsyics data with pyvista.

Topics

Resources

Code of conduct

Contributing

Stars

Watchers

Forks

Sponsor this project

  •  

Contributors