sim/sims - sim/signals

neurodsp-tools · Aug 29, 2024 · 3a629da · 3a629da
1 parent 68a6a6f
commit 3a629da
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 4 deletions.
diff --git a/doc/api.rst b/doc/api.rst
@@ -357,6 +357,19 @@ The following functions can be used to update simulation parameters:
     create_updater
     create_sampler
 
+Simulated Signals
+~~~~~~~~~~~~~~~~~
+
+The following objects can be used to manage groups of simulated signals:
+
+.. currentmodule:: neurodsp.sim.signals
+.. autosummary::
+    :toctree: generated/
+
+    Simulations
+    SampledSimulations
+    MultiSimulations
+
 Utilities
 ~~~~~~~~~
 

diff --git a/neurodsp/sim/multi.py b/neurodsp/sim/multi.py
@@ -5,7 +5,7 @@
 import numpy as np
 
 from neurodsp.utils.core import counter
-from neurodsp.sim.sims import Simulations, SampledSimulations, MultiSimulations
+from neurodsp.sim.signals import Simulations, SampledSimulations, MultiSimulations
 
 ###################################################################################################
 ###################################################################################################

diff --git a/neurodsp/sim/sims.py → neurodsp/sim/signals.py b/neurodsp/sim/sims.py → neurodsp/sim/signals.py
diff --git a/neurodsp/tests/sim/test_multi.py b/neurodsp/tests/sim/test_multi.py
@@ -3,8 +3,8 @@
 import numpy as np
 
 from neurodsp.sim.aperiodic import sim_powerlaw
-from neurodsp.sim.sims import Simulations, SampledSimulations, MultiSimulations
 from neurodsp.sim.update import create_updater, create_sampler, ParamSampler
+from neurodsp.sim.signals import Simulations, SampledSimulations, MultiSimulations
 
 from neurodsp.sim.multi import *
 

diff --git a/neurodsp/tests/sim/test_sims.py → neurodsp/tests/sim/test_signals.py b/neurodsp/tests/sim/test_sims.py → neurodsp/tests/sim/test_signals.py
@@ -1,10 +1,10 @@
-"""Tests for neurodsp.sim.sims."""
+"""Tests for neurodsp.sim.signals."""
 
 from pytest import raises
 
 import numpy as np
 
-from neurodsp.sim.sims import *
+from neurodsp.sim.signals import *
 
 ###################################################################################################
 ###################################################################################################