Add pylint

.github/workflows/pylint.yml

@@ -0,0 +1,30 @@
+name: Pylint
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.8
+    - name: Install dependencies
+      run: |
+        sudo apt-get -y install libbz2-dev
+        python -m pip install --upgrade pip
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        pip install pylint
+    - name: This path
+      run: |
+        ls
+        realpath .
+    - name: Install picca
+      run: pip install -e .
+    - name: Analysing the code with pylint
+      run: |
+        pylint py/picca/delta_extraction/**/*py

README.md

@@ -118,3 +118,15 @@ picca_export.py
 
 The tags name follow the names of the king of France:<br/>
 https://fr.wikipedia.org/wiki/Liste_des_monarques_de_France#Liste_des_monarques_de_France
+
+### For Developers
+Before submitting a PR please make sure to:
+1. Check the tutorials. Update them if necessary (typically the tutorial `picca_delta_extraction_configuration_tutorial` will need to be updated.
+2. Update the data model
+3. For every file you have modified run
+```yapf --style google file.py > aux
+mv aux file.py
+```
+to ensure the coding styles are maintained.
+4. Consider using pylint to help in the debug process. From the repo folder run
+```pylint py/picca/delta_extraction/**/*py```

py/picca/delta_extraction/astronomical_objects/desi_forest.py

@@ -7,12 +7,7 @@ class DesiForest(Forest):
 
     Methods
     -------
-    __gt__ (from AstronomicalObject)
-    __eq__ (from AstronomicalObject)
-    class_variable_check (from Forest)
-    consistency_check (from Forest)
-    get_data (from Forest)
-    rebin (from Forest)
+    (see Forest in py/picca/delta_extraction/astronomical_objects/forest.py)
     __init__
     coadd
     get_header

py/picca/delta_extraction/astronomical_objects/desi_pk1d_forest.py

@@ -14,15 +14,13 @@ class DesiPk1dForest(DesiForest, Pk1dForest):
 
     Methods
     -------
-    __gt__ (from AstronomicalObject)
-    __eq__ (from AstronomicalObject)
-    class_variable_check (from Forest, Pk1dForest)
-    consistency_check (from Forest, Pk1dForest)
-    get_data (from Forest, Pk1dForest)
-    rebin (from Forest)
-    coadd (from DesiForest, Pk1dForest)
-    get_header (from DesiForest, Pk1dForest)
+    (see DesiForest in py/picca/delta_extraction/astronomical_objects/desi_forest.py)
+    (see Pk1dForest in py/picca/delta_extraction/astronomical_objects/pk1d_forest.py)
     __init__
+    consistency_check
+    coadd
+    get_data
+    rebin
 
     Class Attributes
     ----------------
@@ -37,6 +35,7 @@ class DesiPk1dForest(DesiForest, Pk1dForest):
     resolution_matrix: 2d-array of floats or None
     Resolution matrix of the forests
     """
+
     def __init__(self, **kwargs):
         """Initialize instance
 
@@ -57,14 +56,12 @@ def __init__(self, **kwargs):
             raise AstronomicalObjectError(
                 "Error constructing DesiPk1dForest. "
                 "Missing variable 'resolution_matrix'")
-        else:
-            del kwargs["resolution_matrix"]
+        del kwargs["resolution_matrix"]
 
         # call parent constructors
         super().__init__(**kwargs)
         self.consistency_check()
 
-
     def consistency_check(self):
         """Consistency checks after __init__"""
         super().consistency_check()
@@ -98,16 +95,37 @@ def coadd(self, other):
                 f"{type(other).__name__}")
 
         if other.resolution_matrix.size > 0 and self.resolution_matrix.size > 0:
-            if self.resolution_matrix.shape[0]!=other.resolution_matrix.shape[0]:
-                largershape = np.max([self.resolution_matrix.shape[0],other.resolution_matrix.shape[0]])
-                smallershape = np.min([self.resolution_matrix.shape[0],other.resolution_matrix.shape[0]])
+            if self.resolution_matrix.shape[0] != other.resolution_matrix.shape[
+                    0]:
+                largershape = np.max([
+                    self.resolution_matrix.shape[0],
+                    other.resolution_matrix.shape[0]
+                ])
+                smallershape = np.min([
+                    self.resolution_matrix.shape[0],
+                    other.resolution_matrix.shape[0]
+                ])
                 shapediff = largershape - smallershape
-                if self.resolution_matrix.shape[0]==smallershape:
-                    self.resolution_matrix = np.append(np.zeros([shapediff//2,self.resolution_matrix.shape[1]]),self.resolution_matrix,axis=0)
-                    self.resolution_matrix = np.append(self.resolution_matrix,np.zeros([shapediff//2,self.resolution_matrix.shape[1]]),axis=0)
-                if other.resolution_matrix.shape[0]==smallershape:
-                    other.resolution_matrix = np.append(np.zeros([shapediff//2,other.resolution_matrix.shape[1]]),other.resolution_matrix,axis=0)
-                    other.resolution_matrix = np.append(other.resolution_matrix,np.zeros([shapediff//2,other.resolution_matrix.shape[1]]),axis=0)
+                if self.resolution_matrix.shape[0] == smallershape:
+                    self.resolution_matrix = np.append(np.zeros(
+                        [shapediff // 2, self.resolution_matrix.shape[1]]),
+                                                       self.resolution_matrix,
+                                                       axis=0)
+                    self.resolution_matrix = np.append(
+                        self.resolution_matrix,
+                        np.zeros(
+                            [shapediff // 2, self.resolution_matrix.shape[1]]),
+                        axis=0)
+                if other.resolution_matrix.shape[0] == smallershape:
+                    other.resolution_matrix = np.append(np.zeros(
+                        [shapediff // 2, other.resolution_matrix.shape[1]]),
+                                                        other.resolution_matrix,
+                                                        axis=0)
+                    other.resolution_matrix = np.append(
+                        other.resolution_matrix,
+                        np.zeros(
+                            [shapediff // 2, other.resolution_matrix.shape[1]]),
+                        axis=0)
 
             self.resolution_matrix = np.append(self.resolution_matrix,
                                                other.resolution_matrix,