Ngspice: Software design documentation

Anonymous
2012-10-02
2013-06-12
  • Anonymous - 2012-10-02

    Hi all,
           Where can I get the Ngspice software design documentation?? ( which defines the source package is organised and working)

    Thanks

     
  • Anonymous - 2012-10-03

    Hi Hoger,
         Thanks for the reply..
         Why its not available?? (or its still it is in development??)
         Thinking, then how one can understand/edit/improve the source code without documentation??

     
  • Holger Vogt

    Holger Vogt - 2012-10-03

    Dear unknown,

    the question often arises in Open Source projects: Why is this or that feature not available?

    The first answer is then: because you did not engage in the project and did not contribute this feature.

    Other answers may be:
    - because ngspice is inherited from spice3, the first thing to do is look at existing documentation, e.g. http://www.eecs.berkeley.edu/Pubs/TechRpts/1989/ERL-89-43.pdf, http://www.eecs.berkeley.edu/Pubs/TechRpts/1989/ERL-89-44.pdf, http://www.eecs.berkeley.edu/Pubs/TechRpts/1989/ERL-89-45.pdf, which are still valid for most of their parts.
    - because there are so many other interesting features to improve, that nobody spent his time to provide it.

    I hope that your first question stems from your interest to contribute to the ngspice project. Such a documentation might be an interesting feature (of course there are others). So why not make a suggestion on how such a document should look like and can be structured (best having examples available for discussion), and then, when we have agreed upon it, start writing it. We would be happy to answer any questions ( I am sure there will be many).

    To your second question: Well, do it the hard way, as all of us maintainers did: Firstly learn about using ngspice. Then take a simple test case, run it thhrough ngspice in a suitable debugger, starting with main.c, and then have a look at the source code and see what is happening, step by step. And have a look at the documents cited above, and at the book by Tuma, Burmen (see http://ngspice.sourceforge.net/books.html). Again we would be happy to answer any questions, especially when you intend to contribute to ngspice.

    Holger

     

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks