set detrend to false and fix documentation to be more specific

Author: joshuabmoore

pyspi/calculator.py

@@ -37,16 +37,15 @@ class Calculator:
         configfile (str, optional):
             The location of the YAML configuration file for a user-defined subset. See :ref:`Using a reduced SPI set`, defaults to :code:`'</path/to/pyspi>/pyspi/config.yaml'`
         detrend (bool, optional):
-            If True, detrend the dataset along the time axis before normalising (if enabled), defaults to True.
+            If True, detrend each time series individually along the time axis before normalising (if enabled), defaults to False.
         normalise (bool, optional):
-            If True, z-score normalise the dataset along the time axis before computing SPIs, defaults to True.
-            Detrending (if enabled) is always applied before normalisation.
+            If True, z-score normalise each time series in the MTS dataset individually along the time axis before computing SPIs, defaults to True.
     """
     _optional_dependencies = None
 
     def __init__(
         self, dataset=None, name=None, labels=None, subset="all", configfile=None,
-        detrend=True, normalise=True
+        detrend=False, normalise=True
     ):
         self._spis = {}
         self._excluded_spis = list()
@@ -511,7 +510,7 @@ def init_from_list(self, datasets, names, labels, **kwargs):
             self.add_calculator(calc)
 
     def init_from_yaml(
-        self, document, detrend=True, normalise=True, n_processes=None, n_observations=None, **kwargs
+        self, document, detrend=False, normalise=True, n_processes=None, n_observations=None, **kwargs
     ):
         datasets = []
         names = []

pyspi/data.py

@@ -42,10 +42,9 @@ class Data:
         dim_order (str, optional):
             Order of dimensions, accepts two combinations of the characters 'p', and 's' for processes and observations, defaults to 'ps'.
         detrend (bool, optional):
-            If True, detrend the dataset along the time axis before normalising (if enabled), defaults to True.
+            If True, detrend each time series individually along the time axis before normalising (if enabled), defaults to False.
         normalise (bool, optional):
-            If True, z-score normalise the dataset along the time axis before computing SPIs, defaults to True.
-            Detrending (if enabled) is always applied before normalisation.
+            If True, z-score normalise each time series in the MTS dataset individually along the time axis before computing SPIs, defaults to True.
         name (str, optional):
             Name of the dataset
         procnames (list, optional):
@@ -61,7 +60,7 @@ def __init__(
         self,
         data=None,
         dim_order="ps",
-        detrend=True,
+        detrend=False,
         normalise=True,
         name=None,
         procnames=None,