doc

Author: JoschD

chroma_gui/__init__.py

@@ -1 +1,18 @@
+"""
+The Chroma GUI
+~~~~~~~~~~~~~~
+
+``chroma_gui`` is a tool to compute non-linear chromaticity via
+measurements done in the CCC.
+
+:copyright: pyLHC/OMC-Team working group.
+"""
+
+__title__ = "omc3-gui"
+__description__ = "A tool to compute non-linear chromaticity via measurements done in the CCC."
+__url__ = "https://github.com/pylhc/chroma_gui"
 __version__ = "0.0.26"
+__author__ = "pylhc"
+__author_email__ = "[email protected]"
+
+__all__ = [__version__]

chroma_gui/chromaticity/__init__.py

@@ -1,6 +1,6 @@
 """ 
-Chromaticity
-------------
+Chromaticity Module
+-------------------
 
 This module contains functions related to the chromaticity.
 """

chroma_gui/chromaticity/chroma_fct.py

@@ -1,6 +1,6 @@
 """ 
 Chromaticity Functions
----------------------
+----------------------
 
 Functions to compute the chromaticity.
 """
@@ -18,11 +18,16 @@
 def chromaticity_func(x, *args):
     """
     Returns the taylor expansion of the chromaticity
-    q0
-      + q1 * x
-      + q2 * x**2 * 1/2!
-      + q3 * x**3 * 1/3!
-      ...
+    
+    
+    .. code-block::
+    
+        q0
+        + q1 * x
+        + q2 * x**2 * 1/2!
+        + q3 * x**3 * 1/3!
+        ...
+    
     """
     res = 0
     for order, val in enumerate(args):

chroma_gui/cleaning/__init__.py

@@ -1,6 +1,6 @@
 """ 
-Cleaning
---------
+Cleaning Module
+---------------
 
 Functions to clean the chromaticity data.
 """

chroma_gui/corrections/__init__.py

@@ -1,6 +1,6 @@
 """ 
-Corrections
------------
+Corrections Module
+------------------
 
 This module contains the functions to correct chromaticity via the response matrix.    
 """

chroma_gui/corrections/response_matrix.py

@@ -703,7 +703,7 @@ def scatter_plot(series, label):
             scatter_plot(a, label="Removed BPM")
 
         # Get the unit of the y axis
-        j, k, l, m = [int(e) for e in rdt[1:-2]]
+        j, k, l, m = [int(e) for e in rdt[1:-2]]  # noqa: E741
         unit_magnet = -(j + k + l + m)  # unit is m^(-order)
         unit = unit_magnet + 1
         unit += (j + k) / 2 + (l + m) / 2

chroma_gui/main.py

@@ -1120,8 +1120,9 @@ def startThread(self, main_function, finish_function, *args):
         Arguments:
             - main_function: method of the class `ExternalProgram` to be started as main function of the thread
             - finish_function: method of the class  `MainWindow` to be called when the thread has finished
-            - *args: arguments to be passed to the instantiation of the `ExternalProgram` class, those are the
-            `main_function` arguments
+            - args: arguments to be passed to the instantiation of the `ExternalProgram` class, 
+            those are the `main_function` arguments
+            
         """
         # Check if we've got a thread already running
         try:

chroma_gui/plotting/__init__.py

@@ -1,6 +1,6 @@
 """ 
-Plotting
---------
+Plotting Module
+---------------
 
 This module contains functions to plot chromaticity data.
 """

chroma_gui/timber/__init__.py

@@ -1,6 +1,6 @@
 """ 
-Timber
-------
+Timber Module
+-------------
 
 This module contains all the functions to extract data from Timber.
 """

doc/bibliography.rst

@@ -1,4 +1,4 @@
 Bibliography
 ************
 
-This bibliography is inentionally left blank.
+This bibliography is intentionally left blank.