You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The current nest-extension-module code tries to do four things in one example:
Provide a complete, worked example of an extension module with its own documentation.
Provide an example of how to create a minimal extension module.
Provide code to build on as starting point for an extension module.
Document how to create an extension module.
These approaches lead to conflicts and lack of clarity. I suggest to provide separately
An empty template for a minimal module containing a minimal CMakeLists.txt and mymodule.cpp file. I am not sure if I would want to include empty templates for neuron, synapse and possibly other models, but that would probably be a good idea.
A minimal worked example containing only module and model code, with CMakeLists.txt.
A fully worked module example including documentation for the module.
Documentation on how to write a module, which can possibly be integrated with the fully worked module.
I am not sure how to then present these three/four things, if they should be subdirectories with this repo or even separate repos (so users could fork from the template, or the minimal/fully worked examples). @terhorstd Any thoughts on this?
That is not completely true. For the minimal example to fork by users, there is a branch minimal, which should be used as the starting point for creating an own model. iirc this is also mentioned in the documentation, but it seems I can't find where, so it's definitely not documented well enough... There are reasons why this is a separate branch instead of another subfolder, but I'd be happy to discuss this again.
Another aspect of the minimal example is the testing in CI, for which we should have one definition that always builds against defined versions of NEST.
@terhorstd I had not been aware of the minimal branch, that seems to be a good idea—and it is not adapted at all yet. That will have to come as part of the work on this issue here. We clearly need to mention the branch-approach in the documentation.
The current
nest-extension-module
code tries to do four things in one example:These approaches lead to conflicts and lack of clarity. I suggest to provide separately
CMakeLists.txt
andmymodule.cpp
file. I am not sure if I would want to include empty templates for neuron, synapse and possibly other models, but that would probably be a good idea.CMakeLists.txt
.I am not sure how to then present these three/four things, if they should be subdirectories with this repo or even separate repos (so users could fork from the template, or the minimal/fully worked examples). @terhorstd Any thoughts on this?
@jessica-mitchell We should discuss documentation around this.
@pnbabu Can you bring in the NESTML perspective on this?
We should all have a meeting to discuss this.
The text was updated successfully, but these errors were encountered: