tinytapeout / xschem-viewer Goto Github PK

I think it would be cool to do a vscode extension xschem-viewer version, where you can use vscode preview to quickly move and browse schematics.
I can also take part in the development.

See https://xschem-viewer.com/?file=https%3A%2F%2Fgithub.com%2Fengrvip123%2Ftt_um_vks_pll%2Fblob%2Fmain%2Fxschem%2Fcp%2Fcp.sch

versus how xschem renders it

That element has the spice_ignore=true attribute on it.

Example to reproduce:

1. open https://www.xschem-viewer.com/?file=https://github.com/RTimothyEdwards/sky130_ef_ip__xtal_osc_16M/blob/main/xschem/sky130_ef_ip__xtal_osc_16M.sch
2. click on the "level_shifter" subcircuit label
3. url is rewritten to https://www.xschem-viewer.com/?file=level_shifter.sch

Relevant code:
https://github.com/TinyTapeout/xschem-viewer/blob/main/src/index.ts#L90-L92

Suggested fix (untested):
currentPath = new URLSearchParams(window.location.search).get('file') ?? defaultFile;
newPath = (new URL(path, currentPath)).href;

A lot of xschem users use vs code as their ide. It would be awesome if we could open a xschem schematic in vscode using a vscode extension.

Do you think xcshem-viewer could serve as the basis of a vscode extension?

Example file:

https://www.xschem-viewer.com/?file=https://github.com/RTimothyEdwards/sky130_ef_ip__rc_osc_500k/blob/main/xschem/sky130_ef_ip__rc_osc_500k.sch

It should be obvious which devices are flipped; apparently the viewer is not capturing the component transforms?

Thanks for the great work!

How do I include schematic and symbol libraries?
Could the web viewer understand the directory hierarchy when providing a schematic from GitHub using the ?file selection in the URL? i.e. Add directories above the schematic to XSCHEM_LIBRARY_PATH for it.

Example: https://xschem-viewer.com/?file=https://github.com/cascode-labs/bandgaps/blob/main/bandgaps/bandgap_sky130_v1/bandgap_1v_v01/bandgap_1v_v01.sch

Problem

You can see in the screenshot below from the web viewer that I am missing the amplifier symbol that is shown in the second screenshot using the desktop executable version of xschem.

Desktop Implementation

In the desktop version I just have to make sure the XSCHEM_LIBRARY_PATH is set in the xschemrc according to how I organize my design library files as explained in the xschem docs.

In order to define this more portably across projects without having seperate xschemrc file for each project, I add the following Tcl code to the end of my xschemrc. This then allows me to define an environment variable using one of the file structures in the xschem docs. In my case option 3 makes the most sense.

# allow a user-specific path add-on (https://github.com/iic-jku/iic-osic-tools/issues/7)
if { [info exists ::env(XSCHEM_USER_LIBRARY_PATH) ] } {
    append XSCHEM_LIBRARY_PATH :$env(XSCHEM_USER_LIBRARY_PATH)
}

A Possible Solution

Could we have the web viewer understand the file structure from github so that it can capture the schematics and symbols up to 2 levels above the provided schematic. This would allow us to include the library from the same repo assuming you folllow a similar library structure.

Here's the library file structure in my example:

Issue in the web viewer

Here is the schematic from one of my github projects:
https://xschem-viewer.com/?file=https://github.com/cascode-labs/bandgaps/blob/main/bandgaps/bandgap_sky130_v1/bandgap_1v_v01/bandgap_1v_v01.sch

Expected Result

Here is the same schematic in the desktop app:

@urish, @StefanSchippers, @barakhoffer

if I try to load this:
https://xschem-viewer.com/?file=https://github.com/StefanSchippers/xschem/blob/master/xschem_library/examples/mos_power_ampli.sch
get the following error:
Error loading https://github.com/StefanSchippers/xschem/blob/master/xschem_library/examples/mos_power_ampli.sch: SyntaxError: Expected "\"" or "\\\\" but "[" found.

expected is this:

Currently when you just go to the default xschem-viewer.com, you do get a pretty example design but 👍

1. It takes forever to load
2. You don't really get a clue how to view your own design

if there is data present (or becomes present during an action?) then it would be cool if the viewer loaded the data in the graphs