From f5d2ff5791e7cf18f60f34268fbd39e6d1aea85c Mon Sep 17 00:00:00 2001 From: Dhruva Gowda Storz <dhruvastorz@gmail.com> Date: Sat, 20 Jan 2018 12:24:54 +0530 Subject: [PATCH] Added short hidden section at beginning of cookbook snippet sections explaining how to run the snippets --- .../user/py/cookbook/chem_load_save.rst | 29 +++++++++++++++++++ docs/source/user/py/cookbook/chem_sim_eg.rst | 27 +++++++++++++++++ docs/source/user/py/cookbook/chem_tut.rst | 28 ++++++++++++++++++ .../source/user/py/cookbook/elec_load_run.rst | 28 ++++++++++++++++++ docs/source/user/py/cookbook/elec_sim_eg.rst | 28 ++++++++++++++++++ docs/source/user/py/cookbook/multi_rdes.rst | 28 ++++++++++++++++++ docs/source/user/py/cookbook/multi_sim_eg.rst | 28 ++++++++++++++++++ docs/source/user/py/cookbook/net_sim_eg.rst | 28 ++++++++++++++++++ docs/source/user/py/cookbook/net_tut.rst | 28 ++++++++++++++++++ 9 files changed, 252 insertions(+) diff --git a/docs/source/user/py/cookbook/chem_load_save.rst b/docs/source/user/py/cookbook/chem_load_save.rst index b278dffd..d5dc9814 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 5eac01de..c06304a8 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 439b7542..d9e336f9 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 14879a7f..f3503c1b 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 224cf913..9f01aa65 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 baf5719b..2015743a 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 529ee4c3..104868c2 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 ef9f46e5..6b15acdb 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 ea98c2f9..b7841056 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 -------------------------------- -- GitLab