Merge pull request #24 from nicrie/develop

Develop
xarray-contrib · Aug 22, 2022 · b79b1cd · b79b1cd
2 parents b03704c + 0f9c32e
commit b79b1cd
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 7 deletions.
diff --git a/README.rst b/README.rst
@@ -2,6 +2,7 @@
   :align: center
   :width: 800
   :alt: Comparison of standard, Varimax-rotated and Proxmax-rotated EOF analysis for temperature field over North America.
+
 Example_ showing North American surface temperature decomposed via EOF analysis, Varimax rotation and Promax rotation.
 
 .. _Example: https://xeofs.readthedocs.io/en/stable/auto_examples/1eof/plot_rotated_eof.html#sphx-glr-auto-examples-1eof-plot-rotated-eof-py

diff --git a/docs/api.rst b/docs/api.rst
@@ -6,14 +6,13 @@ API
 
 
 **********************
-Numpy ``np.ndarray``
+Numpy | ``np.ndarray``
 **********************
 .. autosummary::
    :toctree: _autosummary
    :template: custom-class-template.rst
    :recursive:
 
-
    xeofs.models.EOF
    xeofs.models.Rotator
    xeofs.models.Bootstrapper
@@ -29,7 +28,6 @@ pandas | ``pd.DataFrame``
    :template: custom-class-template.rst
    :recursive:
 
-
    xeofs.pandas.EOF
    xeofs.pandas.Rotator
    xeofs.pandas.Bootstrapper
@@ -44,7 +42,6 @@ xarray | ``xr.DataArray``
    :template: custom-class-template.rst
    :recursive:
 
-
    xeofs.xarray.EOF
    xeofs.xarray.Rotator
    xeofs.xarray.Bootstrapper

diff --git a/docs/auto_examples/auto_examples_jupyter.zip b/docs/auto_examples/auto_examples_jupyter.zip
diff --git a/docs/auto_examples/auto_examples_python.zip b/docs/auto_examples/auto_examples_python.zip
diff --git a/docs/conf.py b/docs/conf.py
@@ -19,7 +19,7 @@
 
 sys.path.insert(0, os.path.abspath('..'))
 
-#
+
 # # prevent circular imports...
 # import sphinx.builders.html
 # import sphinx.builders.latex
@@ -79,7 +79,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

diff --git a/docs/index.rst b/docs/index.rst
@@ -40,8 +40,9 @@ Documentation
 ******************
 
  .. toctree::
-    :maxdepth: 2
+    :maxdepth: 3
 
+    why
     installation
     auto_examples/index
     api

diff --git a/docs/why.rst b/docs/why.rst
@@ -0,0 +1,30 @@
+##################
+Why ``xeofs``?
+##################
+
+EOF analysis and related variants are typically based on a decomposition of a 2D matrix.
+When working with Earth observation data, however, the underlying structure
+of the data is often multi-dimensional, e.g. they can be described by spatial (longitude, latitude, height etc.),
+temporal (time, steps, lead times in forecasts etc.) and/or other (variable, sensor etc.)
+dimensions. ``xarray`` provides a great tool to handle these multi-dimensional
+data sets in Python. Performing EOF analysis and similar techniques using ``xarray``
+could therefore speed up analysis by automatically taking care of dimension labels.
+
+Although there exist already numerous Python packages for EOF analysis in ``xarray``,
+none did satify my personal needs which is why I tried to merge existing implementations and extend their funcionalities.
+
+
+************************************
+What can ``xeofs`` do for me?
+************************************
+* perform your analysis ``xarray`` (support for ``pandas`` and ``numpy`` is also provided)
+* analyze multi-dimensional data sets without having to keep track of all dimensions yourself
+* investigate the significance of your results
+* *planned, but not implemented yet*: work with large data sets with the help of ``dask``
+
+*******************
+Supported methods
+*******************
+* EOF analysis / PCA
+* Varimax/Promax rotation for better interpretability
+* Maximum Covariance Analysis