Merge pull request #62 from WEgeophysics/develop

 revised docs

pycsamt/bases.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #       created on Fri Oct 29 12:31:01 2021
 #       Author: Kouadio K.Laurent<etanoyau@gmail.com>
-#       Licence: LGPL
+#       Licence: GPL
 import os
 import json 
 import yaml
@@ -577,7 +577,7 @@ def get_config_fname_from_varname(data: Union[T, list, tuple],
                 raise # and go to except  
         except: 
             #using fstring 
-            config_fname= f'{data=}'.split('=')[0]
+            config_fname= f'{data}'.split('=')[0]
 
     elif config_fname is not None: 
         config_fname= config_fname.replace(

pycsamt/processing/corr.py

@@ -852,8 +852,8 @@ def compute_fixed_and_adaptative_moving_average(self, filterfunc,
         set the param `filterfunc` to the filter we need. Avoid repetition 
         in the code Later.
         
-        .. _filter-AMA::`pycsamt.core.processing.zcalculator.compute_AMA`
-        .. _filter-AMA::`pycsamt.core.processing.zcalculator.compute_FLMA`
+        * :meth:`pycsamt.core.processing.zcalculator.compute_AMA`
+        * :meth:`pycsamt.core.processing.zcalculator.compute_FLMA`
         
         :param filterfunc: filter fonction , can be :ref:`filter-AMA` or 
                             :ref:`filter-FLMA`

pycsamt/processing/ctools.py

@@ -4,10 +4,12 @@
 #       Licence: GPL
 
 """
-Processing correction tools 
-Created on Mon Aug 15 13:46:33 2022
+Processing tools
+================= 
+Fast process EMAP and AMT data. Tools are used for data sanitizing, removing 
+noises and filtering. 
 
-@author: Daniel
+Created on Mon Aug 15 13:46:33 2022
 
 .. _pyCSAMT: https://github.com/WEgeophysics/pycsamt
 .. _MTpy: https://github.com/MTgeophysics/mtpy
@@ -19,6 +21,7 @@
 .. |EMAP| replace:: |EM| array profiling
 
 """
+from __future__ import annotations 
 import os 
 import re 
 import warnings 
@@ -996,7 +999,7 @@ def flma (ediObjs=None, res2d=None, phs2d=None, freqs= None, c=None, window_size
     return zjc if out =='z' else rc 
 
 
-def moving_average (y, /, window_size = 3 , method ='sma',
+def moving_average (y, *, window_size = 3 , method ='sma',
                     mode ='same', alpha =.5 ): 
     """ A moving average is  used with time series data to smooth out
     short-term fluctuations and highlight longer-term trends or cycles.

requirements.txt

@@ -14,4 +14,5 @@ pandas
 python-coveralls
 tqdm
 mtpy
+geopandas