Skip to content

Commit 3ace511

Browse files
authored
Add FAQ links (#16)
* Add more info on threshold * Update np_usage.ipynb * Add links to FAQ * Add more FAQ links
1 parent 1fba51d commit 3ace511

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

neuroplatform-docs/np_core/db_usage.ipynb

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
"```{seealso}\n",
2121
":class: dropdown\n",
2222
"- [Spike sorting](../np_utils/spikesorting) : Utility to perform basic spike sorting on the data.\n",
23+
"- [Database FAQ](faq:stimulation) : Frequently asked questions about the database.\n",
2324
"```\n",
2425
"\n",
2526
"\n",
@@ -95,8 +96,8 @@
9596
"To avoid returning large amounts of data, keep the time window small.<br>\n",
9697
"We recommed starting with 5 minutes, and increasing/decreasing the window as needed.\n",
9798
"\n",
98-
"```{caution}\n",
99-
"The database WILL record stimulation events. Any event with an amplitude above 200 uV is very likely to be a stimulation artifact.\n",
99+
"```{note}\n",
100+
"The database will record stimulation events. See the [relevant question in FAQ](faq:stim-artifacts) for more information.\n",
100101
"```"
101102
]
102103
},

neuroplatform-docs/np_core/faq.ipynb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,7 @@
157157
"See the [relevant API section](np-core:variance-threshold).\n",
158158
"```\n",
159159
"\n",
160+
"(faq:stimulation)=\n",
160161
"### Stimulation and parameters\n",
161162
"\n",
162163
"#### I am unsure about triggers/parameters, and how I can parallelize my experiments or dynamically change parameters\n",
@@ -230,6 +231,7 @@
230231
"- Neurons require resources to fire, so fatigue may eventually occur after repeated stimulations. Use a higher delay between stimulations (1-10s) to avoid this issue.\n",
231232
"- If all else is ineffective, please contact us so we can change the organoids.\n",
232233
"\n",
234+
"(faq:database)=\n",
233235
"### Database and experiment tokens\n",
234236
"\n",
235237
"(faq:spike-events)=\n",

neuroplatform-docs/np_core/np_usage.ipynb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
"```{seealso}\n",
1919
":class: dropdown\n",
2020
"- [StimParamLoader](../np_utils/stimparamloader) : Utility to help you manage, preview and load stimulation parameters.\n",
21+
"- [Stimulation FAQ](faq:stimulation) : Frequently asked questions and troubleshooting tips for stimulation.\n",
2122
"```\n"
2223
]
2324
},

0 commit comments

Comments
 (0)