Skip to content

TinyTapeout/xschem-viewer

Repository files navigation

xschem-viewer

Build and Lint License

Explore and visualize XSchem schematics in your browser.

Online version

To use the online version, simply go to https://xschem-viewer.com/.

You can add the URL of your .sch file to the end of the URL to load it directly, e.g. https://xschem-viewer.com/?file=https://github.com/RTimothyEdwards/sky130_ef_ip__rc_osc_500k/blob/main/xschem/sky130_ef_ip__rc_osc_500k.sch

VS Code Extension

Barak Hoffer maintains a VS Code extension of xschem viewer. You can get it at the VS Code Marketplace.

Local Development

Prerequisites

  • Node.js (v20 or later) and NPM (usually comes with Node.js)

Instructions

  1. Clone the repository
  2. Run npm install to install dependencies
  3. Run npm run dev to start the development server
  4. Open http://localhost:5173 in your browser

Enjoy!

Running the tests

npm test will run the tests once. npm run test:watch will run the tests in watch mode.

Rebuilding the .sch parser

When making changes to the sch file parser, you will need to rebuild the parser by running npm run build:parser. This will generate a new xschem-parser.ts file in the src directory.

License

xschem-viewer is licensed under the Apache License, Version 2.0. See LICENSE for more details.