From b76807e1f8d74dcafddce0b049f3788ffb032eef Mon Sep 17 00:00:00 2001 From: "Ankur Sinha (Ankur Sinha Gmail)" Date: Wed, 19 Jun 2024 15:52:56 +0100 Subject: [PATCH] feat: document external morphologies Ref: https://github.com/NeuroML/NeuroML2/issues/150 --- source/Userdocs/ImportingMorphologyFiles.md | 60 +++++++++++++++++++++ 1 file changed, 60 insertions(+) diff --git a/source/Userdocs/ImportingMorphologyFiles.md b/source/Userdocs/ImportingMorphologyFiles.md index ac21e131..f307b22f 100644 --- a/source/Userdocs/ImportingMorphologyFiles.md +++ b/source/Userdocs/ImportingMorphologyFiles.md @@ -66,6 +66,66 @@ The NeuroML validation tools will check for some of these and report errors wher (userdocs:importing_morphology_files:formats)= ## Formats +(userdocs:importing_morphology_files:formats:neuroml)= +### NeuroML2 + +In NeuroML, morphologies are encapsulated in the {ref}`morphology ` modelling element. +A morphology includes {ref}`segments ` and {ref}`segments groups `, and these can be used to refer to parts of the cell's morphology, for example, when placing ionic conductances. +A number of conventions for use in morphologies are listed {ref}`here `. + +(userdocs:importing_morphology_files:formats:neuroml:external)= +#### Morphologies can be stored in external files + +```{admonition} Requires jNeuroML v0.13.2, pyNeuroML v1.3.2 +:class: note +The functionality to store morphology information in external files was implemented in jNeuroML v0.13.2, and pyNeuroML v1.3.2. Please ensure you are using these or newer versions to use this feature. +``` + +Usually, morphologies are embedded in NeuroML cell definition files, {ref}`for example `: + +```{code-block} xml + + + + + + + + + + + + + + + + +``` + +However, morphologies (and {ref}`biophysical properties `) can also be stored as "standalone" entities outside the cell definition and referred to. +Further, they can also be stored in external files that may be "included" in the cell definition file (using the [IncludeType](https://libneuroml.readthedocs.io/en/latest/userdocs/coreclasses.html#includetype) model element). +This allows the re-use of morphology and biophysical properties in multiple cell models: + +```{code-block} xml + + + + + + + + + + + + + + + + + +``` + (userdocs:importing_morphology_files:formats:neuron)= ### NEURON