Skip to content

Commit 78735ed

Browse files
pgleesonpgleeson
committed
Updated nml example
1 parent cd27217 commit 78735ed

File tree

8 files changed

+527
-17
lines changed

8 files changed

+527
-17
lines changed

‎examples/neuroml2/NeuroML2.md

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,146 @@ Some description...
2121

2222
### Allowed children
2323
<table>
24+
<tr>
25+
<td><b>izhikevich2007Cells</b></td>
26+
<td><a href="#izhikevich2007cell">Izhikevich2007Cell</a></td>
27+
<td><i></i></td>
28+
</tr>
29+
30+
31+
<tr>
32+
<td><b>pulseGenerators</b></td>
33+
<td><a href="#pulsegenerator">PulseGenerator</a></td>
34+
<td><i></i></td>
35+
</tr>
36+
37+
2438
<tr>
2539
<td><b>networks</b></td>
2640
<td><a href="#network">Network</a></td>
2741
<td><i>The networks present</i></td>
2842
</tr>
2943

3044

45+
</table>
46+
47+
## Izhikevich2007Cell
48+
Some description...
49+
50+
### Allowed parameters
51+
<table>
52+
<tr>
53+
<td><b>id</b></td>
54+
<td>str</td>
55+
<td><i>The id of the cell...</i></td>
56+
</tr>
57+
58+
59+
<tr>
60+
<td><b>C</b></td>
61+
<td>str</td>
62+
<td><i></i></td>
63+
</tr>
64+
65+
66+
<tr>
67+
<td><b>v0</b></td>
68+
<td>str</td>
69+
<td><i></i></td>
70+
</tr>
71+
72+
73+
<tr>
74+
<td><b>k</b></td>
75+
<td>str</td>
76+
<td><i></i></td>
77+
</tr>
78+
79+
80+
<tr>
81+
<td><b>vr</b></td>
82+
<td>str</td>
83+
<td><i></i></td>
84+
</tr>
85+
86+
87+
<tr>
88+
<td><b>vt</b></td>
89+
<td>str</td>
90+
<td><i></i></td>
91+
</tr>
92+
93+
94+
<tr>
95+
<td><b>vpeak</b></td>
96+
<td>str</td>
97+
<td><i></i></td>
98+
</tr>
99+
100+
101+
<tr>
102+
<td><b>a</b></td>
103+
<td>str</td>
104+
<td><i></i></td>
105+
</tr>
106+
107+
108+
<tr>
109+
<td><b>b</b></td>
110+
<td>str</td>
111+
<td><i></i></td>
112+
</tr>
113+
114+
115+
<tr>
116+
<td><b>c</b></td>
117+
<td>str</td>
118+
<td><i></i></td>
119+
</tr>
120+
121+
122+
<tr>
123+
<td><b>d</b></td>
124+
<td>str</td>
125+
<td><i></i></td>
126+
</tr>
127+
128+
129+
</table>
130+
131+
## PulseGenerator
132+
Some description...
133+
134+
### Allowed parameters
135+
<table>
136+
<tr>
137+
<td><b>id</b></td>
138+
<td>str</td>
139+
<td><i>The id of the pulseGenerator</i></td>
140+
</tr>
141+
142+
143+
<tr>
144+
<td><b>delay</b></td>
145+
<td>str</td>
146+
<td><i>the delay</i></td>
147+
</tr>
148+
149+
150+
<tr>
151+
<td><b>duration</b></td>
152+
<td>str</td>
153+
<td><i>the duration</i></td>
154+
</tr>
155+
156+
157+
<tr>
158+
<td><b>amplitude</b></td>
159+
<td>str</td>
160+
<td><i>the amplitude</i></td>
161+
</tr>
162+
163+
31164
</table>
32165

33166
## Network
@@ -53,6 +186,13 @@ Some description...
53186
</tr>
54187

55188

189+
<tr>
190+
<td><b>explicitInputs</b></td>
191+
<td><a href="#explicitinput">ExplicitInput</a></td>
192+
<td><i></i></td>
193+
</tr>
194+
195+
56196
</table>
57197

58198
## Population
@@ -82,3 +222,24 @@ Some description...
82222

83223

84224
</table>
225+
226+
## ExplicitInput
227+
Some description...
228+
229+
### Allowed parameters
230+
<table>
231+
<tr>
232+
<td><b>target</b></td>
233+
<td>str</td>
234+
<td><i>the target of the input</i></td>
235+
</tr>
236+
237+
238+
<tr>
239+
<td><b>input</b></td>
240+
<td>str</td>
241+
<td><i>the input, e.g. pulseGenerator</i></td>
242+
</tr>
243+
244+
245+
</table>

‎examples/neuroml2/NeuroML2.rst

Lines changed: 66 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,52 @@ Allowed field Data Type Description
1414

1515
**Allowed children**
1616

17-
=============== ====================== ====================
18-
Allowed child Data Type Description
19-
=============== ====================== ====================
20-
**networks** `Network <#network>`__ The networks present
21-
=============== ====================== ====================
17+
======================= ============================================ ====================
18+
Allowed child Data Type Description
19+
======================= ============================================ ====================
20+
**izhikevich2007Cells** `Izhikevich2007Cell <#izhikevich2007cell>`__
21+
**pulseGenerators** `PulseGenerator <#pulsegenerator>`__
22+
**networks** `Network <#network>`__ The networks present
23+
======================= ============================================ ====================
24+
25+
==================
26+
Izhikevich2007Cell
27+
==================
28+
Some description...
29+
30+
**Allowed parameters**
31+
32+
=============== =========== =====================
33+
Allowed field Data Type Description
34+
=============== =========== =====================
35+
**id** str The id of the cell...
36+
**C** str
37+
**v0** str
38+
**k** str
39+
**vr** str
40+
**vt** str
41+
**vpeak** str
42+
**a** str
43+
**b** str
44+
**c** str
45+
**d** str
46+
=============== =========== =====================
47+
48+
==============
49+
PulseGenerator
50+
==============
51+
Some description...
52+
53+
**Allowed parameters**
54+
55+
=============== =========== ============================
56+
Allowed field Data Type Description
57+
=============== =========== ============================
58+
**id** str The id of the pulseGenerator
59+
**delay** str the delay
60+
**duration** str the duration
61+
**amplitude** str the amplitude
62+
=============== =========== ============================
2263

2364
=======
2465
Network
@@ -35,11 +76,12 @@ Allowed field Data Type Description
3576

3677
**Allowed children**
3778

38-
=============== ============================ ===================
39-
Allowed child Data Type Description
40-
=============== ============================ ===================
41-
**populations** `Population <#population>`__ the pops in the net
42-
=============== ============================ ===================
79+
================== ================================== ===================
80+
Allowed child Data Type Description
81+
================== ================================== ===================
82+
**populations** `Population <#population>`__ the pops in the net
83+
**explicitInputs** `ExplicitInput <#explicitinput>`__
84+
================== ================================== ===================
4385

4486
==========
4587
Population
@@ -55,3 +97,17 @@ Allowed field Data Type Description
5597
**component** str the component to use in the population
5698
**size** int the size of the population
5799
=============== =========== ======================================
100+
101+
=============
102+
ExplicitInput
103+
=============
104+
Some description...
105+
106+
**Allowed parameters**
107+
108+
=============== =========== ==============================
109+
Allowed field Data Type Description
110+
=============== =========== ==============================
111+
**target** str the target of the input
112+
**input** str the input, e.g. pulseGenerator
113+
=============== =========== ==============================

0 commit comments

Comments
 (0)