Skip to content
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.

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

feat: document external morphologies #204

Merged
merged 1 commit into from
Jun 19, 2024
Merged
Changes from all commits
Commits
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
60 changes: 60 additions & 0 deletions source/Userdocs/ImportingMorphologyFiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <schema:morphology>` modelling element.
A morphology includes {ref}`segments <schema:segment>` and {ref}`segments groups <schema:segmentgroup>`, 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:conventions:segments>`.

(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 <userdocs:getting_started:multi_compartment_example>`:

```{code-block} xml

<cell id="pyr_soma_m_in_b_in">
<!-- ... -->

<morphology id="morph0">

<segment >
<!-- more segments and segment groups -->

</morphology>

<biophysicalProperties id="biophys1">
<!-- biophysical properties contents -->
</biophysicalProperties>

</cell>
```

However, morphologies (and {ref}`biophysical properties <schema:biophysicalproperties>`) 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
<cell id="pyr_soma_m_out_b_out" morphology="morph0" biophysicalProperties="biophys1">
<!-- cell contents without morphology and biophysical properties -->
</cell>

<!-- Potentially in other files... -->

<morphology id="morph0">

<segment >
<!-- more segments and segment groups -->

</morphology>

<biophysicalProperties id="biophys1">
<!-- biophysical properties contents -->
</biophysicalProperties>

```

(userdocs:importing_morphology_files:formats:neuron)=
### NEURON

Expand Down
Loading