Skip to content
Snippets Groups Projects
Commit f5d2ff57 authored by Dhruva Gowda Storz's avatar Dhruva Gowda Storz
Browse files

Added short hidden section at beginning of cookbook snippet sections...

Added short hidden section at beginning of cookbook snippet sections explaining how to run the snippets
parent a3f3ae62
No related branches found
No related tags found
1 merge request!233Documentation update 2
......@@ -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
--------------------
......
***************
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
---------------------------------
......
......@@ -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)
-----------------------------
......
......@@ -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
-----------------------------------
......
......@@ -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
---------------------
......
......@@ -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
----------------------------------------------
......
......@@ -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
-----------------------------------
......
......@@ -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
----------------------------------
......
......@@ -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
--------------------------------
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment