Skip to content

update docs and fix link bugs #259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 7, 2022
Merged

update docs and fix link bugs #259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions docs/tutorial_building/build_conductance_neurons.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@
"# Building Conductance-based Neuron Models"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"@[Xiaoyu Chen](mailto:c-xy17@tsinghua.org.cn) "
]
},
{
"cell_type": "markdown",
"metadata": {
Expand All @@ -34,7 +41,7 @@
"source": [
"On the other hand, simplified models do not care about the physiological features of neurons but mainly focus on how to reproduce the exact spike timing. Therefore, they are more simplified and maybe not biologically explicable.\n",
"\n",
"BrainPy provides a large volume of [predefined neuron models](../apis/auto/dyn/neurons.html) including conductance-based and simplified models for ease of use. In this section, we will only talk about how to build conductance-based models by ion channels. Users please refer to [Customizing Your Neuron Models](customize_neuron_models.ipynb) for more information."
"BrainPy provides a large volume of [predefined neuron models](../apis/auto/dyn/neurons.rst) including conductance-based and simplified models for ease of use. In this section, we will only talk about how to build conductance-based models by ion channels. Users please refer to [Customizing Your Neuron Models](customize_neuron_models.ipynb) for more information."
]
},
{
Expand Down Expand Up @@ -333,7 +340,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"By combining different ion channels, we can get different types of conductance-based neuron models easily and straightforwardly. To see all predifined channel models in BrainPy, please click [here](../apis/dyn.html)."
"By combining different ion channels, we can get different types of conductance-based neuron models easily and straightforwardly. To see all predifined channel models in BrainPy, please click [here](../apis/dyn.rst)."
]
},
{
Expand Down
579 changes: 286 additions & 293 deletions docs/tutorial_building/overview_of_dynamic_model.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 5 additions & 7 deletions docs/tutorial_toolbox/synaptic_connections.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@
"metadata": {},
"source": [
"There are two classes inheriting from the base class `bp.conn.Connector`:\n",
"- [bp.conn.TwoEndConnector](../apis/auto/building/generated/brainpy.building.connect.TwoEndConnector.rst): a connector to build synaptic connections **between two neuron groups**.\n",
"- [bp.conn.OneEndConnector](../apis/auto/building/generated/brainpy.building.connect.OneEndConnector.rst): a connector to build synaptic connections **within a population of neurons**.\n",
"- [bp.conn.TwoEndConnector](../apis/auto/generated/brainpy.building.connect.TwoEndConnector.rst): a connector to build synaptic connections **between two neuron groups**.\n",
"- [bp.conn.OneEndConnector](../apis/auto/generated/brainpy.building.connect.OneEndConnector.rst): a connector to build synaptic connections **within a population of neurons**.\n",
"\n",
"Users can click the link of each class above to look through the API documentation."
]
Expand Down Expand Up @@ -114,6 +114,7 @@
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Connector.build_conn()\n",
"Users can customize the connection in `build_conn()` function. Notice there are three connection types users can provide:\n",
Expand Down Expand Up @@ -144,10 +145,7 @@
"```\n",
"\n",
"After creating the synaptic connection, users can use the `require()` method to access some useful properties of the connection."
],
"metadata": {
"collapsed": false
}
]
},
{
"cell_type": "markdown",
Expand Down Expand Up @@ -2218,4 +2216,4 @@
},
"nbformat": 4,
"nbformat_minor": 4
}
}