ElectricPy

Electrical-Engineering-for-Python

Python functions and constants related to electrical engineering.

The functions and constants that make up these modules represent a library of material compiled with the intent of being used primarily for research, development, education, and exploration in the realm of electrical engineering.

The base module for the electricpy package, electricpy.py may be leveraged in any Python script or program by using the import command similar to that shown below.

>>> import electricpy as ep

Filled with calculators, evaluators, and plotting functions, this package will provide a wide array of capabilities to any electrical engineer.

Built to support operations similar to Numpy and Scipy, this package is designed to aid in scientific calculations.

Contents:

logo

ElectricPy

Electrical-Engineering-for-Python

sphinx Documentation Status Tox Import Test

pytest pydocstyle Coverage

"Buy Me A Coffee"

Python Libraries with functions and constants related to electrical engineering.

The functions and constants that make up these modules represent a library of material compiled with the intent of being used primarily for research, development, education, and exploration in the realm of electrical engineering.

Check out our full documentation: https://electricpy.readthedocs.io/en/latest/

https://external-content.duckduckgo.com/iu/?u=https%3A%2F%2Fupload.wikimedia.org%2Fwikipedia%2Fcommons%2Fthumb%2Ff%2Ff7%2FAntu_dialog-warning.svg%2F1200px-Antu_dialog-warning.svg.png Documentation has recently been updated to use ReadTheDocs

GitHub Pages are still active, and will continue to be for the forseeable future, but they’re intended for developmental updates rather than primary documentation.

Special thanks to:

  • Stephen Weeks | Student - University of Idaho

  • Jeremy Perhac | Student - University of Idaho

  • Daniel Allen | Student - Universtiy of Idaho

  • Dr. Dennis Sullivan | Proffessor - University of Idaho

  • Dr. Brian Johnson | Proffessor - University of Idaho

  • Dr. Joe Law | Proffessor - University of Idaho

  • StackOverflow user gg349

  • Shaurya Uppal | Online Code Contributor

  • Paul Ortman | Power Quality Engineer - Idaho Power | Instructor - University of Idaho

and

contributors

Dependencies:

INSTALLATION:

1) (option a) Install ElectricPy with Python’s Own pip

Install electricpy

  • pip install electricpy

1) (option b) Install ElectricPy from Source

Python Documentation

Collect Repository and Install

  1. Clone/Download Source Code from GitHub Repository

  2. Open Terminal and Navigate to Folder with cd Commands:

  • cd <path\to\containing\folder>\electricpy

  1. Use Python to Install Module from setup.py:

  • python setup.py install

2) Verify Installation

Check installation success in Python environment

import electricpy
electricpy._version_

To Do List

  • Add Heat Sink Solver

  • DC/DC Converters

  • DC/AC Converters

  • Stationary and Synchronous Reference Frame conversion Matrices/Constants

  • Add arc-flash calculators suggested

  • Develop Testing for All Functions

Get Involved / Contribute

If you’re interested in contributing, we’d love to see your support in a number of ways!

  1. Write Tests - We’re really lacking in this area. We’ve recently added simple GitHub actions to test installation, but that’s about it. We hope that someday we can test all functions in this module for verification.

  2. Contribute New Electrical Engineering Functions - If you’ve got a new function related to electrical engineering that you’d like to see added, we’d love to throw it into this module. Our goal is that this module can become the comprehensive electrical engineering toolkit in Python. Drop us a note, or create a pull request!

  3. Report Issues - We don’t want issues to go unnoticed. Please help us track bugs and resolve them!

  4. Get the Word Out - This project is still in its infancy, so please share it with your friends and colleagues. We want to make sure that everyone has the opportunity to take advantage of this project.

Check out the contribution guide

Contact

For more information regarding this resource, please contact Joe Stanley

License and Usage

ElectricPy is licensed under the standard MIT license, and as such, you are permitted to use this resource as you see fit. Please feel free to ask questions, suggest edits and report bugs or other issues.