Merge pull request #193 from Ablinne/ab/doc

kspace_epoch_like: add documentation regarding a future change in epoch
skuschel · Jan 11, 2019 · 50fbf4e · 50fbf4e
2 parents 7db6c38 + e35d12a
commit 50fbf4e
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/postpic/helper.py b/postpic/helper.py
@@ -554,6 +554,11 @@ def kspace_epoch_like(component, fields, dt, extent=None, omega_func=omega_free,
 
     For the current version of EPOCH, v4.9, use the following:
     align_to == 'B' for intermediate dumps, align_to == "E" for final dumps
+
+    As of Jan 2019 the devel branch contains a change, that will modify the behaviour of final
+    dumps to be the same as intermediate dumps. This change is supposed to be released with
+    Epoch v5.0. See https://cfsa-pmw.warwick.ac.uk/EPOCH/epoch/issues/1896 for details. From
+    Epoch v5.0 onwards, align_to should always be set to 'B'.
     '''
     polfield = component[0]
     polaxis = axesidentify[component[1]]