Index: trunk/doc/user/06_features/simulation/index.html =================================================================== --- trunk/doc/user/06_features/simulation/index.html (revision 8839) +++ trunk/doc/user/06_features/simulation/index.html (revision 8840) @@ -83,8 +83,12 @@
  • 0 or more output configurations
  • simulation setup #2 @@ -115,19 +119,73 @@ you can keep the window open, make changes to your production circuit and run the simulation instantly to see the result. - +

    Properties, addressing

    +

    +In the list of properties for presentation and in the positive and negative +connection of an add modification, node addresses are used. A node +address is either the name of an abstract network or apair of +abstract component and port name, e.g. CN2-4 means "port 4 +of component CN2". +

    config subtree in project.lht

    +

    +All high level simulation config data is stored in the plugins/sim/setups +subtree on the project role (in project.lht). In theory the config system +allows storing the setups subtree in any config source; in practice the +GUI depends on it is stored in the project file. An advanced user may +choose to store sim setup config elsewhere and do the configuration manually, +not using the simulation setup dialog. +

    +The setups subtree structure documented in the appendix. + +

    Actions: high level sim automation

    +

    +It is possible to run the high level simulation without GUI, using actions. +The system works the same, using the same simulation setups, running the +simulator in the background, but instead of presenting the results on the screen, +saving them in self-contained files. The user then should run 3rd party scripts +and software to parse this file and present the results. +

    +Action SimActivate(setup_name, view_name) performs the same as +the 'activate' button on the GUI: it sets up the configuration and view to +match the named simulation setup. Setup_name is the name of one of the +sim setups from the plugins/sim/setups config subtree and view_name is +the name of a view that has a sim_* plugin in it, e.g. sim_ngpsice. +View_name is used to select the simulation backend (simulation software). +

    +Action SimRun(setup_name, view_name, [output_filename]) +performs the same as the 'run' button on the GUI, saving the output in +a contained plain text file. +Output is saved in sim.txt if no file name is specified in the 3rd argument. + +

    Old sheet files, missing views

    +

    +As of sch-rnd 1.0.2, the default config contains a view called sim_ngspice which +is set up as a target for the high level sim to work with ngspice-30 or newer. +Sheets and project created before 1.0.2 will typically lack this view. Adding +the view is trivial either in the view GUI and in the project file. The +most important aspects is to include target_sim_ngspice at the end of the +engline list ad include std_forge before that. +

    +As of 1.0.2, the ordered engine list for the sim_ngspice view is: +

      +
    1. std_forge +
    2. std_cschem +
    3. std_devmap +
    4. target_sim_ngspice +
    +

    +Std_forge is used to operate the test benching mechanism and target_sim_ngspice +is the engine that generates the spice export and runs ngspice in the background. +The other engines are just standard functionality the user would generally +expect to work (std_cschem for things like the connect attribute, std_devmap +for the devmap and portmap mechanisms). +

    Low level simulation

    TODO -

    Test benching

    The test bench mechanism is responsible for selecting parts of the circuit