Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document when one should use NeuroML for creating new ComponentTypes, and when one should use LEMS #165

Open
sanjayankur31 opened this issue Apr 27, 2023 · 0 comments
Labels
C: content Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed P: medium Priority: medium T: enhancement Type: enhancement

Comments

@sanjayankur31
Copy link
Member

  • When creating new channel ComponentTypes, one generally uses HH etc components which are defined in the NeuroML standard. So, new channels can be extended using NeuroML itself. i.e., they use <NeuroML> and will be valid against the NeuroML schema. The NeuroML schema includes a subset of LEMS elements to allow this: https://github.com/NeuroML/NeuroML2/blob/development/Schemas/NeuroML2/NeuroML_v2.3.xsd#L312
  • When creating new synapse ComponentTypes, the LEMS bits included in NeuroML may not be sufficient. One often needs OnStart and other elements that are not included in the NeuroML schema. So, one has to use LEMS to define these. I.e., these files will use <LEMS> as the root element, and they will validate against the LEMS schema (use something like xmllint to validate the file).

This needs to be documented, with examples, so that it's clear to users when they should use what.

@sanjayankur31 sanjayankur31 added C: content Improvements or additions to documentation T: enhancement Type: enhancement good first issue Good for newcomers help wanted Extra attention is needed P: medium Priority: medium labels Apr 27, 2023
@github-project-automation github-project-automation bot moved this to 🆕 New in NeuroML backlog Oct 2, 2023
@sanjayankur31 sanjayankur31 moved this from 🆕 New to 🔖 Ready in NeuroML backlog Oct 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: content Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed P: medium Priority: medium T: enhancement Type: enhancement
Projects
Status: 🔖 Ready
Development

No branches or pull requests

1 participant