Cirsim Circuit Simulator
npm install cirsim html
`
$3
npm: npm install cirsim --save
Initialize
Please keep in mind that Cirsim is currently under development. I'm hoping
to have a release soon and there will be a full documentation web site,
but if you just want to play with it, the most basic way to get Cirsim up
and running would be this:
` html
Cirsim Circuit Simulator
`
Note that this will only worked if served from a server. Attempts to run
Cirsim from a local HTML file will throw cross-site scripting errors in
your browser.
A version of this
page is currently available online.
Options
Pending...
Building
You must install node.js to build Cirsim. To build Cirsim locally, after downloading, do:
`
npm install
`
To build a development build (not optimized):
`
npm run build:dev
`
To build a production build (optimized):
`
npm run build:prod
`
To build both:
`
npm run build:all
`
To run in the webpack development server:
`
npm run serve
`
When running as a server, the URL is http://cirsim.localhost:8080. That version
will have all available components (other than deprecated components). Othere
valid URLs are http://cirsim.localhost:8080/inline.html, which demonstates
using Cirsim as an inline demonstrator, and http://cirsim.localhost:8080/full.html,
which demonstrates Cirsim running full screen.
To run tests:
`
npm test
`
To build the documentation in the doc folder:
`
npm run build:docs
``