# SpiTran Troubleshooting Guide

### Diagnostics

If you have trouble it may be helpful to run SpiTran with a "-debug" option to turn on debugging. SpiTran will then print additional information to the command window as it runs. You can modify your startup script (spitran.bat or spitran.csh) to enable debugging. The startup command would look like:

>     java -cp java s2iMain -debug

SpiTran copies it's printed output into SpiTran.log as it runs. Each time SpiTran creates the log file it renames existing log files to preserve them. So you will find older logs saved as SpiTran.log,1, SpiTran.log,2, etc. The log file is always created in the working directory as SpiTran starts up.

### Debugging

The Java 2 SDK includes a simple non-graphical debugger. See the Java documentation for using this. If you have a Java 2 IDE (Integrated Development Environment) you can debug SpiTran graphically. The java source directory contain a project file spitran.jpr for the JBuilder3 IDE from Inprise (Borland).

### Known Issues

This list may help you to solve troubles you are having with SpiTran:

1. Why are Java, s2ibis2, and Spice not included with SpiTran?
The SpiTran distribution contains only platform independent items, to keep it as small as possible. It is expected that users of SpiTran are already using Spice and s2ibis2 today. The Java 2 JRE kits for a few common platforms could be included, but these would add greatly to the distribution size.
2. My company makes it difficult for me to install the required Java 2
Some companies have strict policies about installing software. Others may require you to have an older version of Java will will not run SpiTran, to run some other application. This might be solved by having a separate system for installing non-standard software, possibly not connected to the local network. Maybe someone can find a way to make SpiTran run with other Java versions, or as an applet in a browser?
3. SpiTran runs only when started from the SpiTran installation directory
SpiTran has to locate the Java class files in the java directory. The startup scripts use a relative path so that the software can be installed anywhere. Also, SpiTran runs it's own startup script to show help and to run s2ibis2. It expects the startup script to reside in the working directory. The reason for all of this is that Java programs can query the working directory, but they can not change it.
4. I can't figure out how to import process libraries
One point to bear in mind is that only the 2nd level nodes in the Libraries list can be selected for adding to the Models list. But SpiTran includes no example project with libraries, and it really needs one.
5. There is no message to indicate the completion of SPICE file auditing
If 5 seconds have passed, it is probably done, in most cases.
6. Clicking OK in the Edit Setup dialog should not re-audit the SPICE file
At least not much time is wasted.
7. It is too difficult to change node names in the instantiated subcircuits table
A triple click (with no mouse motion) selects the entire text of a table cell. Then you can type the new node name.
8. The tab key does not select the next cell in the instantiated subcircuits table
You have to click each cell to select it.
9. After I have changed all the instantiated subcircuit names, the Configure Nodes dialog lists and old node name
After changing the last node name cell, click any other cell to accept the node name change, before going to Configure Nodes.
10. There is no way to delete instantiated subcircuits
As a workaround you can delete the instance from the project .spp file using a text editor, then reopen the project.
11. Some parameters of SUBCKT definitions are mistaken for terminals in the instance tables
SpiTran will recognize parameters such as "z0=52" but not if there are embedded spaces as in "z0 = 52". These may appear as additional terminals in the instance tables.
12. A Java exception occurs when some file browsers are canceled
At least Java recovers gracefully from exceptions.
13. My circuit has only one instance with the "right" terminals; why do I still have to Configure Nodes?
Any volunteers to fix the code?
14. Why do I have to setup nodes both in Configure Nodes and in Translation Command Options?
The Translation Command Options dialog should be initialized with node setup information from Configure Nodes, if only one power node, one ground node, etc. is found. This is not implemented.
15. The Translation Command Settings dialog takes a long time to open
The dialog has a lot of Java components to initialize. Initializing them only as each tab is exposed would be an improvement.
16. ECL Handling
SpiTran should set default values differently for ECL technology.
17. For input and input_ecl buffers some Translation Command Options fields should be disabled
It will cause no harm if they are accidentally set.
18. I can't find the SpiTran.log file
SpiTran creates this in the working directory, which should be the SpiTran installation directory..
19. I closed the Execution Messages window before s2ibis2 was finished
This may cause the printed output of the command to be lost. But s2ibis2 still will run to completion and the IBIS file will open in a viewer. The startp.csh script for Unix does record the command output in the file s2ibis.log in the project directory.
20. Sometimes a menu will get stuck opened
This is a leftover image of the menu. Clicking it does nothing and a refresh will eliminate it. This seems to happen mostly with the Translate menu, and may have something to do with how long the menu remains opened.