added BatchSimulate on api.rst

samadpls · Jul 5, 2024 · 7ba6e2a · 7ba6e2a
1 parent b776702
commit 7ba6e2a
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/doc/api.rst b/doc/api.rst
@@ -94,6 +94,14 @@ Parallel backends (:py:mod:`hnn_core.parallel_backends`):
    MPIBackend
    JoblibBackend
 
+Batch Simulation (:py:mod:`hnn_core.batch_simulate`):
+---------------------------------------------------------
+.. currentmodule:: hnn_core.batch_simulate
+
+.. autosummary::
+   :toctree: generated/
+
+   BatchSimulate
 
 Input and Output:
 -----------------

diff --git a/examples/howto/batch_simulate.py → examples/howto/plot_batch_simulate.py b/examples/howto/batch_simulate.py → examples/howto/plot_batch_simulate.py
@@ -22,7 +22,7 @@
 from hnn_core import jones_2009_model
 
 # The number of cores may need modifying depending on your current machine.
-n_jobs = 3
+n_jobs = 10
 ###########################################################################