nest-simulator icon indicating copy to clipboard operation
nest-simulator copied to clipboard

Clarify difference between compartmental models and multi-compartment model

Open jessica-mitchell opened this issue 2 years ago • 4 comments

Describe the flaw

There are two types of models that use compartments in very different ways. It is difficult to distinguish based on names.

https://nest-simulator.readthedocs.io/en/latest/models/iaf_cond_alpha_mc.html and associated example: https://nest-simulator.readthedocs.io/en/latest/auto_examples/mc_neuron.html

And

https://nest-simulator.readthedocs.io/en/latest/models/cm_default.html and associated examples: https://nest-simulator.readthedocs.io/en/latest/auto_examples/compartmental_model/receptors_and_current.html https://nest-simulator.readthedocs.io/en/latest/auto_examples/compartmental_model/two_comps.html

Suggest an improvement

Is the multi_compartment model still useful in light of the new compartmental models from @WillemWybo

Or can we rename and describe the older multi-compartment model to something more distinct?

@JoshuaBoettcher

jessica-mitchell avatar Sep 07 '22 08:09 jessica-mitchell

Issue automatically marked stale!

github-actions[bot] avatar Nov 07 '22 08:11 github-actions[bot]

@heplesser, could you have a look at this? Do we still need the mc if we have the cm? Also with respect to NESTML the code and docs maybe need a look-over, right?

terhorstd avatar Aug 22 '23 12:08 terhorstd

@terhorstd I agree that we can drop the mc example and deprecate the mc models since we have cm now. I will create a PR.

What do you mean with looking over code and documentation with respect to NESTML?

heplesser avatar Aug 25 '23 11:08 heplesser

Issue automatically marked stale!

github-actions[bot] avatar Oct 27 '23 08:10 github-actions[bot]