Skip to content

Commit 3c75bd3

Browse files
mqnifestkelvinmqnifestkelvin
authored
Merge pull request #3 from ModECI/test_xml3
Updates to neuroml example
2 parents aaf8bdf + a8e1b3e commit 3c75bd3

16 files changed

+683
-51
lines changed

‎examples/document.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ A model for documents.
3030
<table>
3131
<tr>
3232
<td><b>sections</b></td>
33-
<td><a href="#list">List</a></td>
33+
<td><a href="#section">Section</a></td>
3434
<td><i>The sections of the document</i></td>
3535
</tr>
3636

@@ -55,7 +55,7 @@ A model of a section of the <a href="#document">Document</a>. Will contain one <
5555
<table>
5656
<tr>
5757
<td><b>paragraphs</b></td>
58-
<td><a href="#list">List</a></td>
58+
<td><a href="#paragraph">Paragraph</a></td>
5959
<td><i>The paragraphs</i></td>
6060
</tr>
6161

‎examples/document.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ Allowed field Data Type Description
1515

1616
**Allowed children**
1717

18-
=============== ================ ============================
19-
Allowed child Data Type Description
20-
=============== ================ ============================
21-
**sections** `List <#list>`__ The sections of the document
22-
=============== ================ ============================
18+
=============== ====================== ============================
19+
Allowed child Data Type Description
20+
=============== ====================== ============================
21+
**sections** `Section <#section>`__ The sections of the document
22+
=============== ====================== ============================
2323

2424
=======
2525
Section
@@ -36,11 +36,11 @@ Allowed field Data Type Description
3636

3737
**Allowed children**
3838

39-
=============== ================ ==============
40-
Allowed child Data Type Description
41-
=============== ================ ==============
42-
**paragraphs** `List <#list>`__ The paragraphs
43-
=============== ================ ==============
39+
=============== ========================== ==============
40+
Allowed child Data Type Description
41+
=============== ========================== ==============
42+
**paragraphs** `Paragraph <#paragraph>`__ The paragraphs
43+
=============== ========================== ==============
4444

4545
=========
4646
Paragraph

‎examples/document.specification.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
},
1818
"allowed_children": {
1919
"sections": {
20-
"type": "List",
20+
"type": "Section",
2121
"description": "The sections of the document"
2222
}
2323
}
@@ -32,7 +32,7 @@
3232
},
3333
"allowed_children": {
3434
"paragraphs": {
35-
"type": "List",
35+
"type": "Paragraph",
3636
"description": "The paragraphs"
3737
}
3838
}

‎examples/document.specification.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0" ?>
2-
<root>
2+
<modelspec>
33
<Document>
44
<definition>A model for documents.</definition>
55
<allowed_parameters>
@@ -18,7 +18,7 @@
1818
</allowed_parameters>
1919
<allowed_children>
2020
<sections>
21-
<type>List</type>
21+
<type>Section</type>
2222
<description>The sections of the document</description>
2323
</sections>
2424
</allowed_children>
@@ -33,7 +33,7 @@
3333
</allowed_parameters>
3434
<allowed_children>
3535
<paragraphs>
36-
<type>List</type>
36+
<type>Paragraph</type>
3737
<description>The paragraphs</description>
3838
</paragraphs>
3939
</allowed_children>
@@ -47,4 +47,4 @@
4747
</contents>
4848
</allowed_parameters>
4949
</Paragraph>
50-
</root>
50+
</modelspec>

‎examples/document.specification.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Document:
1212
description: International Standard Book Number
1313
allowed_children:
1414
sections:
15-
type: List
15+
type: Section
1616
description: The sections of the document
1717
Section:
1818
definition: A model of a section of the :class:`Document`. Will contain one :class:`Paragraph`
@@ -24,7 +24,7 @@ Section:
2424
description: The id of the section
2525
allowed_children:
2626
paragraphs:
27-
type: List
27+
type: Paragraph
2828
description: The paragraphs
2929
Paragraph:
3030
definition: A model of a paragraph.

‎examples/neuroml2/NeuroML2.md

Lines changed: 163 additions & 2 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>
26-
<td><a href="#list">List</a></td>
40+
<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
@@ -48,11 +181,18 @@ Some description...
48181
<table>
49182
<tr>
50183
<td><b>populations</b></td>
51-
<td><a href="#list">List</a></td>
184+
<td><a href="#population">Population</a></td>
52185
<td><i>the pops in the net</i></td>
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>

0 commit comments

Comments
 (0)