Merge pull request #354 from dstansby/project-status

Add project status to docs

Author: dstansby

.github/workflows/python-test.yml

@@ -19,7 +19,7 @@ jobs:
           - name: linux py38-mindeps
             os: ubuntu-20.04
             python-version: '3.8'
-            pip-extras: '"sunpy<3.1" "astropy<4.2"'
+            pip-extras: '"sunpy<3.1" "astropy<5.1"'
           - name: linux py39
             os: ubuntu-20.04
             python-version: '3.9'

doc/source/changes.rst

@@ -3,6 +3,12 @@
 Changelog
 =========
 
+1.1.2
+-----
+- Added project status documentation.
+- Bumped the minimum version of astropy to 5.0.
+- Fixed ADAPT map reading with sunpy >= 4.0.
+
 1.1.1
 -----
 Fixed imports so pfsspy does not depend on ``sympy`` as a runtime dependency.

doc/source/conf.py

@@ -199,7 +199,7 @@
 # A list of files that should not be packed into the epub file.
 epub_exclude_files = ['search.html']
 
-os.environ["JSOC_EMAIL"] = 'jsoc@cadair.com'
+os.environ["JSOC_EMAIL"] = 'jsoc@sunpy.org'
 
 
 # -- Extension configuration -------------------------------------------------

doc/source/contributing.rst

@@ -2,14 +2,10 @@
 
 pfsspy documentation
 ====================
-pfsspy is a python package for carrying out Potential Field Source Surface
-modelling, a commonly used magnetic field model of the Sun and other stars.
+pfsspy is a python package for carrying out Potential Field Source Surface modelling, a commonly used magnetic field model of the Sun and other stars.
 
 .. note::
-  If you find any bugs or have any suggestions for improvement, please raise
-  an issue here: https://github.com/dstansby/pfsspy/issues
-
-
+  If you find any bugs or have any suggestions for improvement, please raise an issue here: https://github.com/dstansby/pfsspy/issues
 
 Contents
 --------
@@ -22,7 +18,7 @@ Contents
    pfsspy
    performance
    changes
-   contributing
+   project_status
    numerical_method
    synoptic_fits
 

doc/source/index.rst

@@ -1,12 +1,6 @@
 Installing
 ----------
-
-pfsspy requires
-
-- python >= 3.8
-- sunpy >= 3.0
-
-and can be installed from PyPi using
+pfsspy can be installed from PyPi using
 
 .. code::
 

doc/source/installing.rst

@@ -0,0 +1,23 @@
+History, status, and future
+===========================
+The `original PFSS implementation in Python <https://doi.org/10.5281/zenodo.1472183>`__ was written by `Anthony Yeates <https://www.maths.dur.ac.uk/users/anthony.yeates/>`__.
+I (David Stansby) then took this and added tests, documentation, and integrated it with the SunPy project ecosystem to create the pfsspy package.
+Most of the package was written by myself, with some community contributions.
+
+I am the sole maintainer of the package, which is currently feature complete (providing a spherical PFSS solver in Python that integrates well with the SunPy package ecosystem).
+
+Going forward the only changes to the package will be:
+- Fixing `identified bugs <https://github.com/dstansby/pfsspy/issues?q=is%3Aopen+is%3Aissue+label%3ABug>`__
+- Adding tightly scoped `new features <https://github.com/dstansby/pfsspy/issues?q=is%3Aopen+is%3Aissue+label%3AEnhancement>`__ to improve usability or integrate better with other SunPy packages.
+- Improving the documentation.
+- Retaining compatibility with future versions of the package dependencies (e.g. sunpy, Matplotlib...)
+I intend to remain the sole maintainer of the package, but since I'm not currently active in solar physics research don't have lots of time to work on pfsspy.
+As a priority I will maintain the issue list with well scoped pieces of work that others can contribute to fixing.
+
+Community contributions
+-----------------------
+The `pfsspy issue tracker <https://github.com/dstansby/pfsspy/issues>`__ maintains a list of items that need working on.
+Please open a new issue if you find a problem or want to see a new feature added!
+If you want to fix any of the issues yourself, please open a pull request.
+I will try my best to review and merge pull requests, but **please keep them as small as possible** to make my life easier!
+General guidelines for contributing to open source can be found in the `sunpy developers guide <https://docs.sunpy.org/en/latest/dev_guide/index.html>`__

doc/source/project_status.rst

@@ -24,8 +24,8 @@ def test_gong_source(gong_map):
 
 
 def test_adapt_map(adapt_map):
-    import sunpy.io
-    adapt_fits = sunpy.io.fits.read(adapt_map)
+    import astropy.io
+    adapt_fits = astropy.io.fits.open(adapt_map)
     for map_slice in adapt_fits[0].data:
         m = sunpy.map.Map((map_slice, adapt_fits[0].header))
         assert isinstance(m, pfsspy.map.ADAPTMap)

pfsspy/tests/test_map.py

@@ -2,9 +2,9 @@
 
 import astropy.constants as const
 import astropy.coordinates as coord
+import astropy.io
 import astropy.time
 import numpy as np
-import sunpy.io
 import sunpy.map
 import sunpy.time
 from astropy import units as u
@@ -76,7 +76,7 @@ def load_adapt(adapt_path):
     -------
     adaptMapSequence : `sunpy.map.MapSequence`
     """
-    adapt_fits = sunpy.io.fits.read(adapt_path)
+    adapt_fits = astropy.io.fits.open(adapt_path)
     header = adapt_fits[0].header
     if header['MODEL'] != 'ADAPT':
         raise ValueError(f"{os.path.basename(adapt_path)} header['MODEL'] "

pfsspy/utils.py

@@ -32,7 +32,7 @@ python_requires = >=3.8
 packages = pfsspy
 include_package_data = True
 install_requires =
-  astropy>=4.1
+  astropy>=5.0
   numpy
   scikit-image
   scipy
@@ -54,6 +54,7 @@ docs =
 
 test =
   numpy
+  parfive<2
   pytest
   pytest-cov
   reproject