Metadata-Version: 2.1
Name: circuitsim_janq0
Version: 0.0.3
Summary: A small example package
Author-email: janq0 <janq0@tuta.io>
License-File: LICENSE.md
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Requires-Dist: bidict
Requires-Dist: numpy
Requires-Dist: si-prefix
Requires-Dist: tabulate
Description-Content-Type: text/markdown

# circuitsim

A simple CLI electronic circuit simulator for AC and DC linear circuits.

## Installation

```shell
pip install circuitsim_janq0
```

## Usage

Run circuitsim using the `python -m circuitsim_janq0` command.
Read about all the command line options using the `-h` flag.

The netlist file should contain a newline-separated list of components.
Each line should contain a space-separated list of keywords.
The first keyword always denotes the type of component and the remaining keywords are the arguments to that component.
Below are all the supported components with their arguments.
If an argument is enclosed in parenthesis, it means that it's optional.

```
U voltage pos_node neg_node branch
I current pos_node neg_node (branch)
R resistance pos_node neg_node (branch)
L inductance pos_node neg_node (branch)
C capacitance pos_node neg_node (branch)
```

For example, here's the netlist of a series RLC circuit `ustlc.txt` with a voltage source

```
U 10    A 0 I
R 200   A B
L 100   B C
C 10n   C 0
```