diff --git a/docs/source/user/py/cookbook/chem_load_save.rst b/docs/source/user/py/cookbook/chem_load_save.rst index b278dffd4bfb94f9d51a7e65eb77aae382e344b7..d5dc9814d4fed255ac5371d5825cebb78be48206 100644 --- a/docs/source/user/py/cookbook/chem_load_save.rst +++ b/docs/source/user/py/cookbook/chem_load_save.rst @@ -2,6 +2,35 @@ Load - Run - Save models ************************ +.. hidden-code-block:: reStructuredText + :label: How to run these examples + + Each of the following examples can be run by clicking on the green source button + on the right side of each example, and running from within a ``.py`` python file + on a computer where moose is installed. + + Alternatively, all the files mentioned on this page can be found in the main + moose directory. They can be found under + + (...)/moose/moose-examples/snippets + + They can be run by typing + + $ python filename.py + + in your command line, where filename.py is the python file you want to run. + + All of the following examples show one or more methods within each python file. + For example, in the ``cubeMeshSigNeur`` section, there are two blue tabs + describing the ``cubeMeshSigNeur.createSquid()`` and ``cubeMeshSigNeur.main()`` + methods. + + The filename is the bit that comes before the ``.`` in the blue boxes, with + ``.py`` added at the end of it. In this case, the file name would be + ``cubeMeshSigNeur.py``. +| + + Load a Kinetic Model -------------------- diff --git a/docs/source/user/py/cookbook/chem_sim_eg.rst b/docs/source/user/py/cookbook/chem_sim_eg.rst index 5eac01de87afc208e0aa2d65d4d60b9357c13fbb..c06304a8f33fb6d0e1fb32eef1cf98d199518d1c 100644 --- a/docs/source/user/py/cookbook/chem_sim_eg.rst +++ b/docs/source/user/py/cookbook/chem_sim_eg.rst @@ -1,6 +1,33 @@ *************** Simple Examples *************** +.. hidden-code-block:: reStructuredText + :label: How to run these examples + + Each of the following examples can be run by clicking on the green source button + on the right side of each example, and running from within a ``.py`` python file + on a computer where moose is installed. + + Alternatively, all the files mentioned on this page can be found in the main + moose directory. They can be found under + + (...)/moose/moose-examples/snippets + + They can be run by typing + + $ python filename.py + + in your command line, where filename.py is the python file you want to run. + + All of the following examples show one or more methods within each python file. + For example, in the ``cubeMeshSigNeur`` section, there are two blue tabs + describing the ``cubeMeshSigNeur.createSquid()`` and ``cubeMeshSigNeur.main()`` + methods. + + The filename is the bit that comes before the ``.`` in the blue boxes, with + ``.py`` added at the end of it. In this case, the file name would be + ``cubeMeshSigNeur.py``. +| Set-up a kinetic solver and model --------------------------------- diff --git a/docs/source/user/py/cookbook/chem_tut.rst b/docs/source/user/py/cookbook/chem_tut.rst index 439b75420013d7707602e03e8c6d70866d0d8cd4..d9e336f9a26d664e94fb5421a0121f4c625f408a 100644 --- a/docs/source/user/py/cookbook/chem_tut.rst +++ b/docs/source/user/py/cookbook/chem_tut.rst @@ -2,6 +2,34 @@ Tutorials ********* +.. hidden-code-block:: reStructuredText + :label: How to run these examples + + Each of the following examples can be run by clicking on the green source button + on the right side of each example, and running from within a ``.py`` python file + on a computer where moose is installed. + + Alternatively, all the files mentioned on this page can be found in the main + moose directory. They can be found under + + (...)/moose/moose-examples/snippets + + They can be run by typing + + $ python filename.py + + in your command line, where filename.py is the python file you want to run. + + All of the following examples show one or more methods within each python file. + For example, in the ``cubeMeshSigNeur`` section, there are two blue tabs + describing the ``cubeMeshSigNeur.createSquid()`` and ``cubeMeshSigNeur.main()`` + methods. + + The filename is the bit that comes before the ``.`` in the blue boxes, with + ``.py`` added at the end of it. In this case, the file name would be + ``cubeMeshSigNeur.py``. +| + Finding Steady State (CSpace) ----------------------------- diff --git a/docs/source/user/py/cookbook/elec_load_run.rst b/docs/source/user/py/cookbook/elec_load_run.rst index 14879a7fbf181184659557ff3653d019a1aa3ed1..f3503c1b088eb0313aabd0522c78be3d86ed7c17 100644 --- a/docs/source/user/py/cookbook/elec_load_run.rst +++ b/docs/source/user/py/cookbook/elec_load_run.rst @@ -2,6 +2,34 @@ Load and Run simple models ************************** +.. hidden-code-block:: reStructuredText + :label: How to run these examples + + Each of the following examples can be run by clicking on the green source button + on the right side of each example, and running from within a ``.py`` python file + on a computer where moose is installed. + + Alternatively, all the files mentioned on this page can be found in the main + moose directory. They can be found under + + (...)/moose/moose-examples/snippets + + They can be run by typing + + $ python filename.py + + in your command line, where filename.py is the python file you want to run. + + All of the following examples show one or more methods within each python file. + For example, in the ``cubeMeshSigNeur`` section, there are two blue tabs + describing the ``cubeMeshSigNeur.createSquid()`` and ``cubeMeshSigNeur.main()`` + methods. + + The filename is the bit that comes before the ``.`` in the blue boxes, with + ``.py`` added at the end of it. In this case, the file name would be + ``cubeMeshSigNeur.py``. +| + Single Cubicle Compartmental Neuron ----------------------------------- diff --git a/docs/source/user/py/cookbook/elec_sim_eg.rst b/docs/source/user/py/cookbook/elec_sim_eg.rst index 224cf913e7c5429701ef78692b5a0fd31ab08862..9f01aa650a67587ef8cce85b4c45c965f6a2bcd4 100644 --- a/docs/source/user/py/cookbook/elec_sim_eg.rst +++ b/docs/source/user/py/cookbook/elec_sim_eg.rst @@ -2,6 +2,34 @@ Simple Examples *************** +.. hidden-code-block:: reStructuredText + :label: How to run these examples + + Each of the following examples can be run by clicking on the green source button + on the right side of each example, and running from within a ``.py`` python file + on a computer where moose is installed. + + Alternatively, all the files mentioned on this page can be found in the main + moose directory. They can be found under + + (...)/moose/moose-examples/snippets + + They can be run by typing + + $ python filename.py + + in your command line, where filename.py is the python file you want to run. + + All of the following examples show one or more methods within each python file. + For example, in the ``cubeMeshSigNeur`` section, there are two blue tabs + describing the ``cubeMeshSigNeur.createSquid()`` and ``cubeMeshSigNeur.main()`` + methods. + + The filename is the bit that comes before the ``.`` in the blue boxes, with + ``.py`` added at the end of it. In this case, the file name would be + ``cubeMeshSigNeur.py``. +| + Create a Leaky Neuron --------------------- diff --git a/docs/source/user/py/cookbook/multi_rdes.rst b/docs/source/user/py/cookbook/multi_rdes.rst index baf5719bd85b42dec18aac48e1e1a8d7fb06f091..2015743a75e5e827cd0b40b1a46f40c9a4024f9b 100644 --- a/docs/source/user/py/cookbook/multi_rdes.rst +++ b/docs/source/user/py/cookbook/multi_rdes.rst @@ -2,6 +2,34 @@ More Rdesigneur Examples ************************ +.. hidden-code-block:: reStructuredText + :label: How to run these examples + + Each of the following examples can be run by clicking on the green source button + on the right side of each example, and running from within a ``.py`` python file + on a computer where moose is installed. + + Alternatively, all the files mentioned on this page can be found in the main + moose directory. They can be found under + + (...)/moose/moose-examples/snippets + + They can be run by typing + + $ python filename.py + + in your command line, where filename.py is the python file you want to run. + + All of the following examples show one or more methods within each python file. + For example, in the ``cubeMeshSigNeur`` section, there are two blue tabs + describing the ``cubeMeshSigNeur.createSquid()`` and ``cubeMeshSigNeur.main()`` + methods. + + The filename is the bit that comes before the ``.`` in the blue boxes, with + ``.py`` added at the end of it. In this case, the file name would be + ``cubeMeshSigNeur.py``. +| + Building Chemical-Electrical Signalling Models ---------------------------------------------- diff --git a/docs/source/user/py/cookbook/multi_sim_eg.rst b/docs/source/user/py/cookbook/multi_sim_eg.rst index 529ee4c3911a9729ba3db76dfe404330b6823cec..104868c2fa17d1b3cb23ac755105a4ce1173f3bf 100644 --- a/docs/source/user/py/cookbook/multi_sim_eg.rst +++ b/docs/source/user/py/cookbook/multi_sim_eg.rst @@ -2,6 +2,34 @@ Simple Examples *************** +.. hidden-code-block:: reStructuredText + :label: How to run these examples + + Each of the following examples can be run by clicking on the green source button + on the right side of each example, and running from within a ``.py`` python file + on a computer where moose is installed. + + Alternatively, all the files mentioned on this page can be found in the main + moose directory. They can be found under + + (...)/moose/moose-examples/snippets + + They can be run by typing + + $ python filename.py + + in your command line, where filename.py is the python file you want to run. + + All of the following examples show one or more methods within each python file. + For example, in the ``cubeMeshSigNeur`` section, there are two blue tabs + describing the ``cubeMeshSigNeur.createSquid()`` and ``cubeMeshSigNeur.main()`` + methods. + + The filename is the bit that comes before the ``.`` in the blue boxes, with + ``.py`` added at the end of it. In this case, the file name would be + ``cubeMeshSigNeur.py``. +| + Single-compartment multiscale model ----------------------------------- diff --git a/docs/source/user/py/cookbook/net_sim_eg.rst b/docs/source/user/py/cookbook/net_sim_eg.rst index ef9f46e5be1f225cfaeed05787c6ffd3d15997e9..6b15acdb7d0c7dc8d554693ad05343774110b17a 100644 --- a/docs/source/user/py/cookbook/net_sim_eg.rst +++ b/docs/source/user/py/cookbook/net_sim_eg.rst @@ -2,6 +2,34 @@ Simple Examples *************** +.. hidden-code-block:: reStructuredText + :label: How to run these examples + + Each of the following examples can be run by clicking on the green source button + on the right side of each example, and running from within a ``.py`` python file + on a computer where moose is installed. + + Alternatively, all the files mentioned on this page can be found in the main + moose directory. They can be found under + + (...)/moose/moose-examples/snippets + + They can be run by typing + + $ python filename.py + + in your command line, where filename.py is the python file you want to run. + + All of the following examples show one or more methods within each python file. + For example, in the ``cubeMeshSigNeur`` section, there are two blue tabs + describing the ``cubeMeshSigNeur.createSquid()`` and ``cubeMeshSigNeur.main()`` + methods. + + The filename is the bit that comes before the ``.`` in the blue boxes, with + ``.py`` added at the end of it. In this case, the file name would be + ``cubeMeshSigNeur.py``. +| + Connecting two cells via a synapse ---------------------------------- diff --git a/docs/source/user/py/cookbook/net_tut.rst b/docs/source/user/py/cookbook/net_tut.rst index ea98c2f96f799938a8cf1630ea853e7a4ae0040d..b784105698ee7f02fac4e823f2aa8d9cd4caaf9b 100644 --- a/docs/source/user/py/cookbook/net_tut.rst +++ b/docs/source/user/py/cookbook/net_tut.rst @@ -2,6 +2,34 @@ Tutorials ********* +.. hidden-code-block:: reStructuredText + :label: How to run these examples + + Each of the following examples can be run by clicking on the green source button + on the right side of each example, and running from within a ``.py`` python file + on a computer where moose is installed. + + Alternatively, all the files mentioned on this page can be found in the main + moose directory. They can be found under + + (...)/moose/moose-examples/snippets + + They can be run by typing + + $ python filename.py + + in your command line, where filename.py is the python file you want to run. + + All of the following examples show one or more methods within each python file. + For example, in the ``cubeMeshSigNeur`` section, there are two blue tabs + describing the ``cubeMeshSigNeur.createSquid()`` and ``cubeMeshSigNeur.main()`` + methods. + + The filename is the bit that comes before the ``.`` in the blue boxes, with + ``.py`` added at the end of it. In this case, the file name would be + ``cubeMeshSigNeur.py``. +| + Network with Ca-based plasticity --------------------------------