Code commenting and cleanup

Author: hadrienmichel

MASW_paper.py

@@ -166,7 +166,7 @@ def funcSurf96(model):
         TrueModel, Periods, Dataset, NoiseEstimate, ModelSynthetic = buildMODELSET()
         nbModelsBase = 1000
         def MixingFunc(iter:int) -> float:
-            return 1# Always keeping the same proportion of models as the initial prior
+            return 1# Always keeping the same proportion of models as the initial prior (see paper for argumentation).
         if stats:
             Prebel, Postbel, PrebelInit, stats = BEL1D.IPR(MODEL=ModelSynthetic,Dataset=Dataset,NoiseEstimate=NoiseEstimate,Parallelization=ppComp,
                                                            nbModelsBase=nbModelsBase,nbModelsSample=nbModelsBase,stats=True, Mixing=MixingFunc,
@@ -243,6 +243,7 @@ def MixingFunc(iter:int) -> float:
                 ax.set_title('Last iteration')
                 pyplot.show(block=False)
 
+            if True: # Compare to DREAM?
                 # Compare the results to McMC results:
                 McMC = np.load("./Data/DC/SyntheticBenchmark/DREAM_MASW.npy")
                 # We consider a burn-in period of 75%:

pyBEL1D/BEL1D.py

@@ -53,7 +53,7 @@
 def ForwardParallelFun(Model, function, nbVal):
     '''This function enables the use of any function to be parralelized.
 
-    ATTENTION: The function MUST be pickable by dill.
+    WARNING: The function MUST be pickable by dill.
 
     Inputs: - Model (np.ndarray): the model for which the forward must be run
             - function (lambda function): the function that, when given a model,