various docsite updates & fixes

fooof-tools · May 10, 2021 · cf56d7c · cf56d7c
1 parent 32c0d2f
commit cf56d7c
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 22 deletions.
diff --git a/doc/api.rst b/doc/api.rst
@@ -297,14 +297,14 @@ Plot Model Objects
 Plots for visualizing from model objects.
 Note that these are the same plotting functions that can be called from the model objects directly.
 
-.. currentmodule:: specparam.plts.fm
+.. currentmodule:: specparam.plts.model
 
 .. autosummary::
     :toctree: generated/
 
     plot_model
 
-.. currentmodule:: specparam.plts.fg
+.. currentmodule:: specparam.plts.group
 
 .. autosummary::
     :toctree: generated/

diff --git a/examples/manage/plot_fit_fooof_3d.py → examples/manage/plot_fit_models_3d.py b/examples/manage/plot_fit_fooof_3d.py → examples/manage/plot_fit_models_3d.py
@@ -132,7 +132,7 @@
 
 ###################################################################################################
 # fit_models_3d
-# ~~~~~~~~~~~~
+# ~~~~~~~~~~~~~
 #
 # More specifically, :func:`~.fit_models_3d` takes in:
 #

diff --git a/examples/manage/plot_manipulating_fooofs.py → examples/manage/plot_manipulating_models.py b/examples/manage/plot_manipulating_fooofs.py → examples/manage/plot_manipulating_models.py
@@ -15,8 +15,8 @@
 # Using simulated data, in this example we will cover:
 #
 # - combining results across model objects
-# - sub-selecting fits from specparamGroup objects
-# - dropping specified model fits from specparamGroup objects
+# - sub-selecting fits from PSDGroup objects
+# - dropping specified model fits from PSDGroup objects
 # - average across groups of model fits
 #
 
@@ -107,8 +107,8 @@
 compare_model_objs([fm1, fg], 'settings')
 
 ###################################################################################################
-# Sub-Select from specparamGroup
-# --------------------------
+# Sub-Select from PSDGroup
+# ------------------------
 #
 # When you have a :class:`~specparam.PSDGroup` object, you may also want to sub-select
 # a group of models.
@@ -145,8 +145,8 @@
 #
 
 ###################################################################################################
-# Dropping Fits from specparamGroup
-# -----------------------------
+# Dropping Fits from PSDGroup
+# ---------------------------
 #
 # Another option is to 'drop' model fits from a PSDGroup object. You can do this with
 # the :meth:`~specparam.PSDGroup.drop` method from a :class:`~specparam.PSDGroup` object.
@@ -194,8 +194,8 @@
     print(fg[ind])
 
 ###################################################################################################
-# Note on Selecting from specparam Objects
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Note on Selecting from PSD Objects
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #
 # Both the :meth:`~specparam.PSDGroup.get_group` and :meth:`~specparam.PSDGroup.drop` methods
 # take an input of the indices of the model(s) to select or drop.

diff --git a/motivations/measurements/plot_BandRatios.py b/motivations/measurements/plot_BandRatios.py
@@ -30,7 +30,7 @@
 #
 # We have completed a full project investigating methodological properties of band
 # ratio measures, which is available as a
-# `published paper <https://doi.org/10.1523/ENEURO.0192-20.2020 >`_ and/or on
+# `published paper <https://doi.org/10.1523/ENEURO.0192-20.2020>`_ and/or on
 # `Github <https://github.com/voytekresearch/BandRatios>`_.
 #
 
@@ -290,7 +290,7 @@ def upd(data, index, value):
 # For more investigation into band ratios, their methodological issues, applications to real
 # data, and a comparison to parameterizing power spectra, you can read about a full project
 # on this topic in the
-# `published paper <https://doi.org/10.1523/ENEURO.0192-20.2020 >`_
+# `published paper <https://doi.org/10.1523/ENEURO.0192-20.2020>`_
 # and/or explore the code on
 # `Github <https://github.com/voytekresearch/BandRatios>`_.
 #
diff --git a/tutorials/plot_07-TroubleShooting.py b/tutorials/plot_07-TroubleShooting.py
@@ -377,7 +377,7 @@
 ###################################################################################################
 
 # Print out instructions to report bad fits
-#  Note you can also call this from specparamGroup, and from instances (ex: `fm.print_report_issue()`)
+#  Note you can also call this from PSDGroup, and from instances (ex: `fm.print_report_issue()`)
 PSD.print_report_issue()
 
 ###################################################################################################

diff --git a/tutorials/plot_08-FurtherAnalysis.py b/tutorials/plot_08-FurtherAnalysis.py
@@ -36,8 +36,8 @@
 from specparam.bands import Bands
 
 # Import simulation code and utilities
+from specparam.sim import sim_group_power_spectra
 from specparam.sim.params import param_sampler
-from specparam.sim.gen import gen_group_power_spectra
 from specparam.sim.utils import set_random_seed
 
 # Import some analysis functions
@@ -74,11 +74,11 @@
 
 ###################################################################################################
 
-# Set random seed, for consistency generating simulated data
+# Set random seed, for consistency creating simulated data
 set_random_seed(21)
 
-# Generate some simulated power spectra
-freqs, spectra = gen_group_power_spectra(n_spectra=10,
+# Create some simulated power spectra
+freqs, spectra = sim_group_power_spectra(n_spectra=10,
                                          freq_range=[3, 40],
                                          aperiodic_params=param_sampler([[20, 2], [35, 1.5]]),
                                          periodic_params=param_sampler([[], [10, 0.5, 2]]))
@@ -129,8 +129,8 @@
                'beta' : [15, 30]})
 
 ###################################################################################################
-# Extracting peaks from specparam Objects
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Extracting peaks from PSD Objects
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #
 # The :func:`~.get_band_peak` function takes in a
 # :class:`~.PSD` object and extracts peak(s) from a requested frequency range.
@@ -150,8 +150,8 @@
 print(alpha)
 
 ###################################################################################################
-# Extracting peaks from specparamGroup Objects
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Extracting peaks from PSDGroup Objects
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #
 # Similarly, the :func:`~.get_band_peak_group` function can be used
 # to select peaks from specified frequency ranges, from :class:`~specparam.PSDGroup` objects.