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?
@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 current
nest-extension-modulecode tries to do four things in one example:These approaches lead to conflicts and lack of clarity. I suggest to provide separately
CMakeLists.txtandmymodule.cppfile. 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.