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

naming convention #36

Open
hwillemen opened this issue Dec 27, 2023 · 0 comments
Open

naming convention #36

hwillemen opened this issue Dec 27, 2023 · 0 comments

Comments

@hwillemen
Copy link

So regarding your statement "In this folder there are all the modules and libraries, I tried to organize them with a minimum of logic but better approaches then mine are really welcome"

Right now, you probably took models and libraries from a lot of different sources and put them together in this repo.
That is a good first step but to me everything feels a bit unorganized /hard to use.
(already better than Kicad by default though since that has only basic models)

I would like to give the following suggestion:

  • create a naming convention and keep this consistent for all libraries
  • strongly look at the naming conventions for the KiCad Libraries (KLC)
  • example1: no spaces in files or folders
  • example2: top level directories as main "libraries" like diode-zener, transistor-FET, etc.
    level below that should contain lib files, not to much nesting of folders.
    (a diode-zener-ST.lib would belong under "diode-zener" obviously)
  • make (a) converter script(s) to convert from other formats to the ngspice/Kicad format.
    (LTSpice format is also fine since that is widely used and compatible)
  • On https://forum.kicad.info/t/where-do-i-find-models-for-ngspice/29485 I read something about encrypted models so maybe we need to allow for LTSpice models as well?
  • since models are shown in Kicad in the order they are defined, keep these lib's in alphabetical order.
    (and/or make a script to enforce this on pull requests)

Maybe a nice topic to have some brainstorm on...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant