**************
sunkit-pyvista
**************
|Latest Version| |Latest Documentation| |codecov| |matrix| |Powered by NumFOCUS|
.. |Latest Documentation| image:: https://readthedocs.org/projects/sunkit-pyvista/badge/?version=latest
:target: https://docs.sunpy.org/projects/sunkit-pyvista/en/latest/?badge=latest
:alt: Documentation Status
.. |Latest Version| image:: https://img.shields.io/pypi/v/sunkit-pyvista.svg
:target: https://pypi.python.org/pypi/sunkit-pyvista/
.. |matrix| image:: https://img.shields.io/matrix/sunpy:openastronomy.org.svg?colorB=%23FE7900&label=Chat&logo=matrix&server_fqdn=openastronomy.modular.im
:target: https://openastronomy.element.io/#/room/#sunpy:openastronomy.org
.. |codecov| image:: https://codecov.io/gh/sunpy/sunkit-pyvista/branch/main/graph/badge.svg
:target: https://codecov.io/gh/sunpy/sunkit-pyvista
.. |Powered by NumFOCUS| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
:target: https://numfocus.org
The goal of sunkit-pyvista is to allow 3D visualization of solar physics data with pyvista.
Installation
============
See the `installation instructions <https://docs.sunpy.org/projects/sunkit-pyvista/en/latest/installing.html>`__ 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.
.. _Development installation: https://docs.sunpy.org/en/latest/dev_guide/contents/newcomers.html#setting-up-a-development-environment
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:
.. code-block:: bash
pytest -s -vvv --update_image_cache sunkit_pyvista/
Getting Help
============
For more information or to ask questions about sunkit-pyvista, check out:
- `sunkit-pyvista Documentation`_
- `SunPy Element Channel`_
.. _sunkit-pyvista Documentation: https://docs.sunpy.org/projects/sunkit-pyvista/en/latest/
.. _SunPy Element Channel: https://app.element.io/#/room/#sunpy:openastronomy.org
Contributing
============
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`_.
.. _Developers Guide: https://docs.sunpy.org/en/latest/dev_guide/index.html
.. _`#sunpy:openastronomy.org`: https://app.element.io/#/room/#sunpy:openastronomy.org
.. _issues page: https://github.com/sunpy/sunkit-pyvista/issues
.. _Newcomers' guide: https://docs.sunpy.org/en/latest/dev_guide/contents/newcomers.html
Code of Conduct
===============
When you are interacting with the SunPy community you are asked to follow our `Code of Conduct`_.
.. _Code of Conduct: https://sunpy.org/coc
Raw data
{
"_id": null,
"home_page": "https://github.com/sunpy/sunkit-pyvista",
"name": "sunkit-pyvista",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "solar physics,solar,science,sun,3d,plotting,visualisation",
"author": "The SunPy Community",
"author_email": "sunpy@googlegroups.com",
"download_url": "https://files.pythonhosted.org/packages/c2/2b/f3853a911eb7782b49e8878c55ef51c6fc65be681d140d90e67e686a4317/sunkit_pyvista-0.2.1.tar.gz",
"platform": "any",
"description": "**************\nsunkit-pyvista\n**************\n\n|Latest Version| |Latest Documentation| |codecov| |matrix| |Powered by NumFOCUS|\n\n.. |Latest Documentation| image:: https://readthedocs.org/projects/sunkit-pyvista/badge/?version=latest\n :target: https://docs.sunpy.org/projects/sunkit-pyvista/en/latest/?badge=latest\n :alt: Documentation Status\n.. |Latest Version| image:: https://img.shields.io/pypi/v/sunkit-pyvista.svg\n :target: https://pypi.python.org/pypi/sunkit-pyvista/\n.. |matrix| image:: https://img.shields.io/matrix/sunpy:openastronomy.org.svg?colorB=%23FE7900&label=Chat&logo=matrix&server_fqdn=openastronomy.modular.im\n :target: https://openastronomy.element.io/#/room/#sunpy:openastronomy.org\n.. |codecov| image:: https://codecov.io/gh/sunpy/sunkit-pyvista/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/sunpy/sunkit-pyvista\n.. |Powered by NumFOCUS| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A\n :target: https://numfocus.org\n\nThe goal of sunkit-pyvista is to allow 3D visualization of solar physics data with pyvista.\n\nInstallation\n============\n\nSee the `installation instructions <https://docs.sunpy.org/projects/sunkit-pyvista/en/latest/installing.html>`__ for more information.\n\nDeveloping\n==========\n\nIf you want to develop sunkit-pyvista you will need to install it from GitHub.\nFor detailed installation instructions, see `Development installation`_ in the sunpy docs.\nThese are for \"sunpy\" but the same works for sunkt-pyvista with a quick name substitution.\n\n.. _Development installation: https://docs.sunpy.org/en/latest/dev_guide/contents/newcomers.html#setting-up-a-development-environment\n\nRunning Figure tests\n--------------------\n\nYou need to use your local environment and make sure its up to date.\nThis does not with tox for now.\n\n2 command line arguments can be passed to pytest:\n\n* ``update_image_cache`` : Resets the ``image_cache`` directory with new figures generated from your local environment.\n* ``ignore_image_cache`` : Ignores the image cache and will not perform any image comparison.\n\nExample usage:\n\n.. code-block:: bash\n\n pytest -s -vvv --update_image_cache sunkit_pyvista/\n\nGetting Help\n============\n\nFor more information or to ask questions about sunkit-pyvista, check out:\n\n- `sunkit-pyvista Documentation`_\n- `SunPy Element Channel`_\n\n.. _sunkit-pyvista Documentation: https://docs.sunpy.org/projects/sunkit-pyvista/en/latest/\n.. _SunPy Element Channel: https://app.element.io/#/room/#sunpy:openastronomy.org\n\nContributing\n============\n\nIf you would like to get involved, check out the `Developers Guide`_ section of the SunPy docs.\nStop by our chat room `#sunpy:openastronomy.org`_ if you have any questions.\nHelp 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.\n\nFor more information on contributing to SunPy, please read our `Newcomers' guide`_.\n\n.. _Developers Guide: https://docs.sunpy.org/en/latest/dev_guide/index.html\n.. _`#sunpy:openastronomy.org`: https://app.element.io/#/room/#sunpy:openastronomy.org\n.. _issues page: https://github.com/sunpy/sunkit-pyvista/issues\n.. _Newcomers' guide: https://docs.sunpy.org/en/latest/dev_guide/contents/newcomers.html\n\nCode of Conduct\n===============\n\nWhen you are interacting with the SunPy community you are asked to follow our `Code of Conduct`_.\n\n.. _Code of Conduct: https://sunpy.org/coc\n",
"bugtrack_url": null,
"license": "BSD 3-Clause",
"summary": "3D visualisation of solar physics data with pyvista",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/sunpy/sunkit-pyvista"
},
"split_keywords": [
"solar physics",
"solar",
"science",
"sun",
"3d",
"plotting",
"visualisation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "82cf91e3e42586baad7b1d4cf343ff9565bfd84416e2fd47cf24234ba219c127",
"md5": "372175fd419a93862fae25da4702a807",
"sha256": "0db2a6843f180cea4d414c22df3988902337cf72aa0f5845391f9a097c1883a5"
},
"downloads": -1,
"filename": "sunkit_pyvista-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "372175fd419a93862fae25da4702a807",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 214125,
"upload_time": "2023-11-27T23:30:40",
"upload_time_iso_8601": "2023-11-27T23:30:40.094211Z",
"url": "https://files.pythonhosted.org/packages/82/cf/91e3e42586baad7b1d4cf343ff9565bfd84416e2fd47cf24234ba219c127/sunkit_pyvista-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c22bf3853a911eb7782b49e8878c55ef51c6fc65be681d140d90e67e686a4317",
"md5": "68d24d1bb7e9af91e89beffead386140",
"sha256": "5049fc85ed3055a75c989a5cba26f6084bfad96536979032a6810c74043cc7d2"
},
"downloads": -1,
"filename": "sunkit_pyvista-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "68d24d1bb7e9af91e89beffead386140",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 229496,
"upload_time": "2023-11-27T23:30:42",
"upload_time_iso_8601": "2023-11-27T23:30:42.317547Z",
"url": "https://files.pythonhosted.org/packages/c2/2b/f3853a911eb7782b49e8878c55ef51c6fc65be681d140d90e67e686a4317/sunkit_pyvista-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-27 23:30:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sunpy",
"github_project": "sunkit-pyvista",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "sunkit-pyvista"
}
JSON
