From cddc9728b87fba87c1e5a7df52f8809edba9f890 Mon Sep 17 00:00:00 2001 From: nikhilmishra145 Date: Mon, 1 Jun 2026 18:32:45 -0400 Subject: [PATCH] small change --- docs/guide/how_to_get_started_with_neuron.rst | 154 ++++++++++++++---- 1 file changed, 126 insertions(+), 28 deletions(-) diff --git a/docs/guide/how_to_get_started_with_neuron.rst b/docs/guide/how_to_get_started_with_neuron.rst index e04f299347..305c9990ad 100644 --- a/docs/guide/how_to_get_started_with_neuron.rst +++ b/docs/guide/how_to_get_started_with_neuron.rst @@ -1,50 +1,148 @@ .. _how_to_get_started_with_neuron: How to get started with NEURON -============= +============================== -To learn the basics about using NEURON: -------------- +What is NEURON? +--------------- -You'll likely have questions. Ask and answer questions at the `NEURON Discussion Board `_ +NEURON is a simulator for neurons and networks of neurons that runs on your local machine, +in the cloud, or on an HPC cluster. -Then +It is built on biophysical models. NEURON simulates neurons using conductance-based equations +introduced by :ref:`Hodgkin and Huxley `, whose work +establishes the mathematical foundation for how ion channels drive electrical activity in +model cells. -1. - Read `"The NEURON Simulation Environment." `_ +You can build and simulate models using Python, HOC, and/or NEURON's graphical interface. -2. - Use the Programmer's Reference early and often. If you are running NEURON under MSWindows and accepted the default installation, the Programmer's Reference is already in the NEURON program group--put a shortcut to it on your desktop. If you are using MacOS or UNIX, you will have to download it separately from the `Documentation page `_. +Download NEURON +--------------- -3. - Work through the tutorials on the `Documentation `_ and `Courses `_ pages. +There are two ways to get NEURON running on your system: -4. - Use the GUI tools as much as possible. You'll get more done, faster, and you won't have to write any code. Some of the GUI tools are described in the tutorials, and others are demonstrated in more detail in John Moore's User's Manual (see the `Documentation `_ page). +:doc:`Download and run ` — the standard option for most users. Pre-built +installers are available for Mac, Windows, and Linux. -5. - The GUI tools can also help you learn how to use hoc, NEURON's programming language. The CellBuilder and Network Builder can export hoc code that you can examine and reuse to do new things. You can also save the smaller GUI tools to session files, which contain reusable hoc statements. +:doc:`Build from source ` — for users who need a custom build, want to +contribute to development, or need to integrate NEURON into a larger software environment. -6. - Examine `ModelDB `_ and the list of `publications about NEURON `_ to find models of interest. Many authors have deposited their model code in ModelDB, posted it somewhere else on the WWW, or will provide code upon request. +What can NEURON do? +------------------- -To learn how to use NMODL to add new mechanisms to NEURON: ------------------------- +NEURON has been used in hundreds of published studies across computational and experimental +neuroscience. A few examples of what it can do: -1. - First, consider using the ChannelBuilder instead (see the `Documentation page `_ for a tutorial). This is an extremely powerful GUI tool for specifying voltage- and ligand-gated ionic conductances. It's much easier to use than NMODL. Mechanisms specified with the ChannelBuilder actually execute *faster* than if they were specified with NMODL. Also, you can use it to make stochastic channel models. +- `Mainen and Sejnowski (1996) `_ demonstrated that the complex + firing patterns seen in cortical neurons can be reproduced by varying the morphology of a + single cell model built in NEURON. -2. - If you absolutely must use NMODL (e.g. for ion accumulation mechanisms or to add new kinds of artificial spiking cells), read chapters 9 and 10 of The NEURON Book, or at least the articles "Expanding NEURON's Repertoire of Mechanisms with NMODL" and "Discrete event simulation in the NEURON environment" (downloadable from the `publications about NEURON `_ page). +- `Migliore et al. (2014) `_ used NEURON to simulate + large-scale networks of olfactory neurons, linking network-level activity to perceptual + phenomena. -3. - NEURON comes with a bunch of mod files that can serve as starting points for "programming by example." Under MSWin the default mechanisms (hh, pas, expsyn etc.) are in ``c:\nrn\src\nrnoc`` (on my Linux box this is ``/usr/local/src/nrn-x.x/src/nrnoc``). A large collection of mod files is in ``c:\nrn\examples\nrniv\nmodl`` (Linux ``/usr/local/src/nrn-x.x/share/examples/nrniv/nmodl``). +- NEURON has also been used to simulate detailed single cell models. + `Morse et al. (2010) `_ investigated how early Alzheimer's + disease affects the electrical excitability of oblique dendrites in hippocampal pyramidal + neurons. Using a single, anatomically detailed compartmental model of one CA1 pyramidal + cell, NEURON was used to simulate how amyloid beta blocking A-type potassium channels + changes the way electrical signals propagate through that cell's dendritic branches. -4. - You may also find useful examples in `ModelDB `_. +A full list of publications using NEURON is available on the +:doc:`Publications page `. -For courses about NEURON, see the :ref:`Course Exercises ` page and the :ref:`Training Videos ` page. +Learning resources +------------------ +The resources below are organized by experience level. Within each level, two starting points +are offered depending on your background — choose the one that fits how you think. +Beginner +~~~~~~~~ +**New to computational modeling?** +If you want to understand NEURON through a biological lens, before the programming bit kicks +in, use the following resources. These introduce NEURON through its graphical interface and +biological concepts first. + +- :doc:`What is NEURON ` — guide +- :ref:`Basic Concepts and GUI` — 2021 course video +- :ref:`Using NEURON's GUI to build and simulate cells` — CNS 2022 video +- :doc:`Squid axon model ` — exercise +- :doc:`Introduction to the GUI ` — exercise + +**Comfortable with Python?** + +Start here if you have a programming background and want to get something running in code first. + +- :doc:`What is NEURON ` — guide +- :doc:`Scripting NEURON basics ` — CNS 2022 video +- :doc:`NEURON scripting exercises ` — exercise +- :doc:`Single compartment model with Hodgkin-Huxley mechanism ` — exercise + +Intermediate +~~~~~~~~~~~~ + +**New to computational modeling?** + +These resources introduce more complex cell models, morphology, and ion channel specification +through guided examples and GUI tools. + +- :ref:`Branched cells` — 2021 course video +- :ref:`Adding ion channels` — 2021 course video +- :ref:`Using NMODL to add new biophysical mechanisms` — CNS 2022 video +- :doc:`Working with morphometric data and Import3D ` — exercise +- :ref:`How do I work with neuron morphologies?` — guide +- :doc:`Using the CellBuilder GUI ` — guide + +**Comfortable with Python?** + +These resources cover networks, numerical methods, morphology in code, and scripting more +complex models. + +- :doc:`Using NMODL files ` — exercise +- :ref:`Networks and numerical methods` — 2021 course video +- :ref:`Numerical Methods: accuracy, stability, speed` — CNS 2022 video +- :doc:`Numerical methods exercises ` — exercise +- :doc:`HOC exercises ` — exercise +- :doc:`Ball and Stick 1: Basic cell ` — Python tutorial +- :doc:`Ball and Stick 2: Build a ring network ` — Python tutorial + +Advanced +~~~~~~~~ + +These resources assume familiarity with both the biological concepts and the scripting +environment. + +- :ref:`Reaction-diffusion simulations` — CNS 2022 video +- :doc:`Python RXD tutorials ` — tutorial series +- :doc:`MPI and multithreaded parallelization ` — exercise +- :doc:`Using the Neuroscience Gateway for HPC ` — exercise +- :doc:`Ball and Stick 3: Extensible network ` — Python tutorial +- :doc:`Ball and Stick 4: Parallel vs serial mode ` — Python tutorial + +Going further +~~~~~~~~~~~~~ + +The above list covers some of the structured courses, videos, and exercises available in this +documentation. There are additional resources worth knowing about as you go further. You can +work through all materials on the :doc:`Documentation ` and +:doc:`Courses ` pages. + +`ModelDB `_ is a publicly accessible database of published +computational neuroscience models, many of which were built with NEURON. Once you are +comfortable running your own simulations, ModelDB is a great resource for finding, +downloading, and studying real models from the literature. This helps you see how others have +approached modeling problems similar to your own. + +What's next? +------------ + +In this guide we have covered what NEURON is and what it is built on, and how to download it +and get it running. Whether you are approaching NEURON from a biological background or a +programming one, the learning resources above will take you from a single compartment cell all +the way to large-scale multiscale networks. The tools are well documented, the exercises are +hands-on, and the concepts build on each other naturally the further you go. + +Welcome to NEURON. Happy simulating. \ No newline at end of file