Skip to main content

Library for analysing and calculating electric networks.

Project description

CircuitCalculator

CircuitCalculator is a Python library for symbolic and numeric analysis of electrical circuits. It supports DC and AC analysis, nodal analysis, state-space modeling, and works with both numeric and symbolic component values. The library is designed for engineers, students, and researchers who want to analyze, simulate, or teach circuit theory using Python.

Features

  • Symbolic and numeric circuit analysis
  • Support for resistors, capacitors, inductors, voltage sources, and current sources
  • Nodal analysis and state-space modeling
  • Easy-to-use API for building and solving circuits
  • Integration with Jupyter/IPython notebooks for interactive exploration

Installation

You can install CircuitCalculator and its dependencies using pip (e.g. in a virtual environment):

python -m venv ./venv
source ./venv/bin activate
pip install CircuitCalculator

Usage

The most convenient interface is the Circuit class, which allows you to define a circuit as a list of components and then solve it. Below is a minimal example for DC analysis:

Example

from CircuitCalculator.Circuit.circuit import Circuit
import CircuitCalculator.Circuit.Components.components as ccp
from CircuitCalculator.Circuit.solution import dc_solution

# Define the circuit
circuit = Circuit([
    ccp.dc_voltage_source(V=1, id='Vs', nodes=('1', '0')),
    ccp.resistor(R=1, id='R', nodes=('1', '0'))
])

# Solve the circuit
solution = dc_solution(circuit)
print(f'I(R)={solution.get_current("R"):2.2f}A')
print(f'V(R)={solution.get_voltage("R"):2.2f}V')

Output:

I(R)=1.00A
V(R)=1.00V

Examples

Several Jupyter/IPython notebook examples can be found in the examples directory.

Contribution

This project is open-source and contributions are welcome. If you would like to contribute, please fork the repository and make a pull request.

License

This project is licensed under the MIT License.

Contact

If you have any questions or issues, please open an issue on the GitHub repository.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

circuitcalculator-0.4.20.tar.gz (52.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

circuitcalculator-0.4.20-py3-none-any.whl (71.3 kB view details)

Uploaded Python 3

File details

Details for the file circuitcalculator-0.4.20.tar.gz.

File metadata

  • Download URL: circuitcalculator-0.4.20.tar.gz
  • Upload date:
  • Size: 52.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for circuitcalculator-0.4.20.tar.gz
Algorithm Hash digest
SHA256 34ae6c86dd8091546962ae29fedcbf44456298290d6a5b06fd9e415f2da31a37
MD5 dc36339755ba06bdb3c7512b1c2d0a56
BLAKE2b-256 7eb4604714b962429767cffbef5392c9a46b69197c80c9a7a5518836b071aedf

See more details on using hashes here.

File details

Details for the file circuitcalculator-0.4.20-py3-none-any.whl.

File metadata

File hashes

Hashes for circuitcalculator-0.4.20-py3-none-any.whl
Algorithm Hash digest
SHA256 bea08d89272c87a6a68ff151b1a2b1a7f0ab93d1b8b9a54cc1f067dbd19c1c55
MD5 87dbdf19627f8d053d4e9b5f3c21a993
BLAKE2b-256 4c9d7158876d39eb7fdaa66643cfa6865d367345f81e4e25bff70c744151ac43

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page