rtds-circuit-analysis 0.0.1

Solve electrical circuits

RTDS Circuit Analysis

RTDS Circuit Analysis is a Python software for solving electrical circuits, when given their netlist.

Installation

If you plan on using the command line interface for this software, you can use pipx for this:

pipx install rtds-circuit-analysis

If you want to use the library, however, you might prefer using pip for the installation:

pip install rtds-circuit-analysis

Netlist

Before actually using this program, you will need to write the circuit you want to analise as a netlist. This software uses a netlist style similar to SPICE programs, where each line corresponds to each component in the circuit. They will be formatted like Vin in 0 V, where:

• The the first letter in the first word, V is the component type (V for voltage source, R for resistors, etc), and together with the rest, Vin, make up the component name.
• The second and third words are the nodes the component is connected to. Their names are arbitrary, except for the node 0, which will always be ground. It is also always necessary.
• The final word will be the value for the circuit. It can be a literal (such as in this case, V), a numeric value (like 10k), or a combination of both (like 10V).

For example, here is a basic RLC circuit...

... and its netlist representation:

V1 1 0 10
R1 1 2 1k
L1 2 3 100m
C1 3 0 10u

Usage

Command Line Interface

The basic usage for the CLI software is in the form:

rtds-circuit-analysis netlist.cir

netlist.cir being the path for the file containing the netlist. This will print all the solutions for the circuit (node voltages, currents, states, etc). You can use flags to filter the output. For example, to show only the currents for each component, you can run:

rtds-circuit-analysis netlist.cir -i

You can filter it even more, by giving the components/node names to the flags as parameters. So, if you want the voltage and current for the resistor R1 only, you can run:

rtds-circuit-analysis netlist.cir -v R1 -i R1

Library

To solve the circuit, you need to import the Circuit class, and pass the netlist as a parameter, creating a circuit object.

from rtds_circuit_analysis import Circuit

circuit = Circuit("netlist.cir")

This Circuit object will have all circuit solutions stored as attributes. So, for example, to find the voltage at node "2", you can use:

circuit.node_voltages["2"]

You can also use the print methods to print the solutions for the circuit in a formatted manner, similar to the CLI. For example, to print the voltages for the components R1 and R2, you can run:

circuit.print_component_voltages("R1", "R2")

License

This project is licensed under the MIT License. See the LICENSE file for details.