Skip to content

Revise example extension module #27

@heplesser

Description

@heplesser

The current nest-extension-module code tries to do four things in one example:

  1. Provide a complete, worked example of an extension module with its own documentation.
  2. Provide an example of how to create a minimal extension module.
  3. Provide code to build on as starting point for an extension module.
  4. Document how to create an extension module.

These approaches lead to conflicts and lack of clarity. I suggest to provide separately

  1. 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.
  2. A minimal worked example containing only module and model code, with CMakeLists.txt.
  3. A fully worked module example including documentation for the module.
  4. 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.

Metadata

Metadata

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions