QUICKSTART

A wavefront simulator for simulating wavefronts in a circuit context.

requirements

you will require a Python installation (3.9 was used here)

download python

Jupyter notebook is required for interactive elements

pip install jupyter

VScode is recommended, it has builtin notebook functionality

download VScode

jupyter for VScode

For the verification module to work it is also required that LTspice is installed and confiugred

download LTspice

refer to docs

quick install

Next download the contents of this repositry, and unzip:

ROOT
├─── docs
├─── example.ipynb
├─── test.py
├─── requirements.txt
└─── wavefronts <– this is where modules are stored

The ROOT level is where test.py and example.ipynb is.

Open a terminal at this folder.

install the requirements (a venv is always good):

pip install -r requirements.txt

Now run test.py or examples.ipynb in VScode.

For more information refer to the docs