pin sunpy (#154)

Author: nabobalis

CHANGELOG.rst

@@ -1,3 +1,12 @@
+0.2.1 (2023-11-27)
+==================
+
+Breaking Changes
+----------------
+
+- Due to an incompatibility between ``pffspy`` and ``sunpy`` 5.1.0, `sunkit-pyvista` is not compatible with ``sunpy`` 5.1.0.
+  The ``sunpy`` version is pinned for the time being.
+
 0.2.0 (2023-11-17)
 ==================
 
@@ -12,7 +21,6 @@ Breaking Changes
   * Minimum ``pfsspy`` version is now 1.1.2. (`#116 <https://github.com/sunpy/sunkit-pyvista/pull/116>`__)
 - Default ``line_width`` for :meth:`~sunkit_pyvista.plotter.SunpyPlotter.plot_field_lines` has been reduced to 2, from 5. (`#117 <https://github.com/sunpy/sunkit-pyvista/pull/117>`__)
 
-
 Internal Changes
 ----------------
 

docs/index.rst

@@ -5,6 +5,11 @@ sunkit-pyvista Documentation
 `sunkit-pyvista` is a python package for visualizing solar physics data in 3D.
 It is built on top of the `pyvista` package, which itself is built as a Python interface to VTK.
 
+.. warning::
+
+   Due to an incompatibility between ``pffspy`` and ``sunpy`` 5.1.0, `sunkit-pyvista` is not compatible with ``sunpy`` 5.1.0.
+   The ``sunpy`` version is pinned for the time being.
+
 .. toctree::
    :maxdepth: 2
 

setup.cfg

@@ -36,7 +36,7 @@ setup_requires =
 install_requires =
   pfsspy>=1.1.2
   pyvista[all]>= 0.38.4
-  sunpy[map]>=5.0.0
+  sunpy[map]>=5.0.0,<5.1.0
 
 [options.extras_require]
 tests =