Merge pull request #369 from dstansby/archive-note

Add an archive note
dstansby · Aug 24, 2023 · f493e2c · f493e2c
2 parents c26f251 + d283a99
commit f493e2c
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,20 @@
+From David Stansby, the lead author of *pfsspy*:
+
+*pfsspy* has been archived, and is no longer developed -
+I no longer work in Solar Physics,
+and do not have time to maintain or support the package.
+*pfsspy* will probably continue working in the short term, but
+incompatibilities with dependencies will appear some point.
+The beauty of open source is that someone (maybe you!) can fork the code,
+and maintain, update, and improve it. If you do, I'd be greatful if you
+chose a new name for it and acknowledged the heritage of *pfsspy* in
+the new package.
+
+Thanks to everyone who has contributed, whether through code or otherwise -
+this was a large part of my professional identity at the time, and I'm
+proud of the science it helped enable 😊
+
+
 ![pfsspy](logo/logo_rectangle.png "pfsspy")
 
 [![DOI](https://zenodo.org/badge/163663713.svg)](https://zenodo.org/badge/latestdoi/163663713)

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -5,7 +5,22 @@ 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.
 
 .. note::
-  If you find any bugs or have any suggestions for improvement, please raise an issue here: https://github.com/dstansby/pfsspy/issues
+  From David Stansby, the lead author of *pfsspy*:
+
+  *pfsspy* has been archived, and is no longer developed -
+  I no longer work in Solar Physics,
+  and do not have time to maintain or support the package.
+  *pfsspy* will probably continue working in the short term, but
+  incompatibilities with dependencies will appear some point.
+  The beauty of open source is that someone (maybe you!) can fork the code,
+  and maintain, update, and improve it. If you do, I'd be greatful if you
+  chose a new name for it and acknowledged the heritage of *pfsspy* in
+  the new package.
+
+  Thanks to everyone who has contributed, whether through code or otherwise -
+  this was a large part of my professional identity at the time, and I'm
+  proud of the science it helped enable 😊
+
 
 Contents
 --------

diff --git a/setup.cfg b/setup.cfg
@@ -43,7 +43,7 @@ docs =
   importlib_metadata
   pillow
   reproject
-  sphinx>2
+  sphinx>2,<7
   sphinx-automodapi>=0.10
   sphinx-gallery
   sphinx_rtd_theme