nest / nest-simulator

The NEST simulator
http://www.nest-simulator.org
GNU General Public License v2.0
520 stars 358 forks source link

Clarify difference between compartmental models and multi-compartment model #2461

Open jessica-mitchell opened 1 year ago

jessica-mitchell commented 1 year ago

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

github-actions[bot] commented 1 year ago

Issue automatically marked stale!

terhorstd commented 10 months ago

@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?

heplesser commented 10 months ago

@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?

github-actions[bot] commented 8 months ago

Issue automatically marked stale!