From 0c3d9f5a3944928916b4b1ea139c52e14bfb5aad Mon Sep 17 00:00:00 2001 From: pgleeson Date: Tue, 24 Oct 2023 16:11:18 +0100 Subject: [PATCH] Add step-by-step guides to GettingStarted page --- source/Userdocs/GettingStarted.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/source/Userdocs/GettingStarted.md b/source/Userdocs/GettingStarted.md index 651b4e3b..dfb8c4e7 100644 --- a/source/Userdocs/GettingStarted.md +++ b/source/Userdocs/GettingStarted.md @@ -2,12 +2,28 @@ # Getting started with NeuroML The best way to understand NeuroML is to work through NeuroML examples to see how they are constructed and what they can do. -In this chapter, we will step through increasingly complex models to see how they are written and simulated using NeuroML. +We present below a set of step-by-step guides to illustrate how models are written and simulated using NeuroML. -To stress that **Python** is the suggested language for developing, simulating, and analysing NeuroML models, we will limit ourselves to the Python NeuroML tools only: {ref}`libNeuroML ` and {ref}`pyNeuroML `. -You can learn more about the different NeuroML tools in their {ref}`specific sections `. + + + + + + + +
        
-You do not need to install any software on your computers to run the example code included in this chapter. -Each example is followed by a [Jupyter notebook](https://jupyter.org/index.html) for you to experiment with. -These can be run using the "launch" button in the top right hand corner. -Please proceed to the first example section using the navigation button on the right below. + +| Link to guide | Description | Model life cycle stages | +| :------ | ----------- | ----------------------- | +| [Guide 1](https://docs.neuroml.org/Userdocs/SingleNeuronExample.html) | Create and simulate a simple regular spiking Izhikevich neuron in NeuroML | Create, Validate, Simulate | +| [Guide 2](https://docs.neuroml.org/Userdocs/IzhikevichNetworkExample.html) | Create a network of two synaptically connected populations of Izhikevich neurons | Create, Validate, Visualise, Simulate | +| [Guide 3](https://docs.neuroml.org/Userdocs/SingleCompartmentHHExample.html) | Build and simulate a single compartment Hodgkin-Huxley neuron | Create, Validate, Visualise, Simulate | +| [Guide 4](https://docs.neuroml.org/Userdocs/MultiCompartmentOLMexample.html) | Create and simulate a multi compartment hippocampal OLM neuron | Create, Validate, Visualise, Simulate | +| [Guide 5](https://docs.neuroml.org/Userdocs/OptimisingNeuroMLModels) | Optimise/fit NeuroML models to experimental data | Create, Validate, Simulate, Fit | +| [Guide 6](https://docs.neuroml.org/Userdocs/CreatingNeuroMLModels.html\#converting-cell-models-to-neuroml-and-sharing-them-on-open-source-brain) | Guide to converting cell models to NeuroML and sharing them on Open Source Brain | Create, Validate, Simulate, Share | +| [Guide 7](https://docs.neuroml.org/Userdocs/NML2_examples/NeuroML-DB.html) | Create novel NeuroML models from components on NeuroML-DB | Reuse, Create, Validate, Simulate | +| [Guide 8](https://docs.neuroml.org/Userdocs/ExtendingNeuroMLv2.html\#example-lorenz-model-for-cellular-convection) | Extend NeuroML by creating a novel model type in LEMS | Create, Simulate | + + +You do not need to install any software on your computers to run many of the examples above. These examples are followed by a [Jupyter notebook](https://jupyter.org/index.html) for you to experiment with inside your browser ({ref}`more info `).