Merge pull request #232 from dstansby/manual

Add numerical methods reference
dstansby · Oct 2, 2020 · dab412c · dab412c
2 parents b6cce65 + d9d2515
commit dab412c
Show file tree

Hide file tree

Showing 9 changed files with 360 additions and 2 deletions.
diff --git a/doc/source/changes.rst b/doc/source/changes.rst
@@ -10,6 +10,7 @@ New features
   loading and working with synoptic maps.
 - `pfsspy.Output` has a new `~pfsspy.Output.bunit` property, which returns the
   `~astropy.units.Unit` of the input map.
+- Added a guild to the numerical methods used by pfsspy.
 
 Breaking changes
 ~~~~~~~~~~~~~~~~

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -2,8 +2,6 @@
 
 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.
-For more information on the actually PFSS calculation see
-`this document <https://github.com/antyeates1983/pfss/blob/master/pfss-manual.pdf>`_.
 
 .. note::
 
@@ -41,7 +39,9 @@ Contents
 
    auto_examples/index
    pfsspy
+   performance
    changes
+   numerical_method
    synoptic_fits
 
 Indices and tables

diff --git a/doc/source/manual/numerical_methods.pdf b/doc/source/manual/numerical_methods.pdf
diff --git a/doc/source/manual/source/Q.png b/doc/source/manual/source/Q.png
diff --git a/doc/source/manual/source/grid.jpg b/doc/source/manual/source/grid.jpg
diff --git a/doc/source/manual/source/grid3d.png b/doc/source/manual/source/grid3d.png
diff --git a/doc/source/manual/source/numerical-methods.tex b/doc/source/manual/source/numerical-methods.tex
diff --git a/doc/source/manual/source/refs.bib b/doc/source/manual/source/refs.bib
@@ -0,0 +1,15 @@
+@ARTICLE{vanballe2000,
+   author = {{van Ballegooijen}, A.~A. and {Priest}, E.~R. and {Mackay}, D.~H.
+	},
+    title = "{Mean Field Model for the Formation of Filament Channels on the Sun}",
+  journal = {ApJ},
+ keywords = {Magnetohydrodynamics: MHD, Sun: Corona, Sun: Magnetic Fields},
+     year = 2000,
+    month = aug,
+   volume = 539,
+    pages = {983-994},
+      doi = {10.1086/309265},
+   adsurl = {http://adsabs.harvard.edu/abs/2000ApJ...539..983V},
+  adsnote = {Provided by the SAO/NASA Astrophysics Data System}
+}
+
diff --git a/doc/source/numerical_method.rst b/doc/source/numerical_method.rst
@@ -0,0 +1,5 @@
+Numerical methods
+-----------------
+
+For more information on the numerical methods used in the PFSS calculation see
+:download:`this document <manual/numerical_methods.pdf>`.