New class docs (#553)

* added new classes to api * added spaces after jupyter execute * added doc strings for pandas_method and from_pandas; fixed spacing --------- Co-authored-by: Alexander James <[email protected]>
LinkedEarth · May 31, 2024 · dccf4c1 · dccf4c1
1 parent f0ab58f
commit dccf4c1
Show file tree

Hide file tree

Showing 4 changed files with 79 additions and 38 deletions.
diff --git a/doc_build/core/api.rst b/doc_build/core/api.rst
@@ -48,6 +48,18 @@ EnsembleSeries (pyleoclim.EnsembleSeries)
 .. autoclass:: pyleoclim.core.ensembleseries.EnsembleSeries
    :members:
 
+EnsembleGeoSeries (pyleoclim.EnsembleGeoSeries)
+"""""""""""""""""""""""""""""""""""""""""""""""
+
+.. autoclass:: pyleoclim.core.ensemblegeoseries.EnsembleGeoSeries
+   :members:
+
+MulEnsGeoSeries (pyleoclim.MulEnsGeoSeries)
+"""""""""""""""""""""""""""""""""""""""""""
+
+.. autoclass:: pyleoclim.core.mulensgeoseries.MulEnsGeoSeries
+   :members:
+
 SurrogateSeries (pyleoclim.SurrogateSeries)
 """""""""""""""""""""""""""""""""""""""""""
 
@@ -101,6 +113,12 @@ MultivarDecomp (pyleoclim.MultivariateDecomp)
 .. autoclass:: pyleoclim.core.multivardecomp.MultivariateDecomp
   :members:
 
+EnsMultivarDecomp (pyleoclim.EnsMultivarDecomp)
+"""""""""""""""""""""""""""""""""""""""""""""""
+
+.. autoclass:: pyleoclim.core.ensmultivardecomp.EnsMultivarDecomp
+  :members:
+
 SsaRes (pyleoclim.SsaRes)
 """""""""""""""""""""""""
 

diff --git a/pyleoclim/core/ensmultivardecomp.py b/pyleoclim/core/ensmultivardecomp.py
@@ -132,6 +132,7 @@ def modeplot(self,index=0,flip=False,plot_envelope_kwargs = None, psd_envelope_k
         --------
         
         .. jupyter-execute::
+
             n = 3 # number of ensembles
             nn = 30 # number of noise realizations
             nt = 500
@@ -330,6 +331,7 @@ def screeplot(self,clr_eig='C0', linewidth=.3, title='Screeplot', violin_kwargs
         --------
         
         .. jupyter-execute::
+        
             n = 3 # number of ensembles
             nn = 30 # number of noise realizations
             nt = 500

diff --git a/pyleoclim/core/mulensgeoseries.py b/pyleoclim/core/mulensgeoseries.py
@@ -58,6 +58,7 @@ def mcpca(self,nsim=1000, seed=None, common_time_kwargs=None, pca_kwargs=None,al
         --------
         
         .. jupyter-execute::
+        
             n = 3 # number of ensembles
             nn = 30 # number of noise realizations
             nt = 500