Merge pull request #336 from sjoset/vectorial_model_rewrite

Vectorial model rewrite and update associated tests and documentation

Author: mkelley

CHANGES.rst

@@ -10,6 +10,17 @@
 New Features
 ------------
 
+sbpy.activity
+^^^^^^^^^^^^^
+
+- Added ``VectorialModel.binned_production`` constructor for compatibility with
+  time-dependent production implemented in the original FORTRAN vectorial model
+  code by Festou. [#336]
+
+- Added ``VMResult``, ``VMFragmentSputterPolar``, ``VMParams``,
+  ``VMGridParams``, ``VMFragment``, and ``VMParent`` dataclasses to expose
+  details of ``VectorialModel`` results that may be of interest. [#336]
+
 sbpy.data
 ^^^^^^^^^
 
@@ -21,11 +32,10 @@ sbpy.data
 
 - Added ``DataClass.__contains__`` to enable `in` operator for ``DataClass``
   objects. [#357]
-
+  
 - Added ``DataClass.add_row``, ``DataClass.vstack``
   methods. [#367]
 
-
 sbpy.photometry
 ^^^^^^^^^^^^^^^
 
@@ -50,6 +60,15 @@ sbpy.data
   designations: they do not parse as cometary or asteroidal. [#334, #340]
 
 
+API Changes
+-----------
+
+sbpy.activity
+^^^^^^^^^^^^^
+
+- ``VectorialModel`` now no longer takes an ``angular_substeps`` parameter. [#336]
+
+
 0.3.0 (2022-04-28)
 ==================
 

docs/sbpy/activity/gas.rst

@@ -103,12 +103,6 @@ The gas coma models work with sbpy's apertures:
 Vectorial Model
 ^^^^^^^^^^^^^^^
 
-.. warning::
-
-  Literature tests with the Vectorial model are generally in agreement at the
-  20% level or better.  The cause for the differences with the Festou FORTRAN
-  code are not yet precisely known.  Help testing this feature is appreciated.
-
 The Vectorial model (`Festou 1981
 <https://ui.adsabs.harvard.edu/abs/1981A%26A....95...69F/abstract>`_) describes
 the spatial distribution of coma photolysis products.  Unlike the Haser model,
@@ -146,9 +140,9 @@ number of molecules in an aperture.  Parent and daughter data is provided via
   >>> Q = 1e28 / u.s        # water production rate
   >>> coma = gas.VectorialModel(Q, water, hydroxyl)
   >>> print(coma.column_density(10 * u.km))    # doctest: +FLOAT_CMP
-  2.951278139718558e+17 1 / m2
+  2.8976722840952486e+17 1 / m2
   >>> print(coma.total_number(1000 * u.km))    # doctest: +FLOAT_CMP
-  6.96687966256294e+29
+  6.995158827300034e+29
 
 Production Rate calculations
 ----------------------------