{"id":20688004,"url":"https://github.com/engineerjoe440/electricpy","last_synced_at":"2025-04-10T01:08:30.726Z","repository":{"id":39865011,"uuid":"200880526","full_name":"engineerjoe440/ElectricPy","owner":"engineerjoe440","description":"Electrical Engineering Formulas in Python","archived":false,"fork":false,"pushed_at":"2023-12-17T06:24:31.000Z","size":97126,"stargazers_count":95,"open_issues_count":12,"forks_count":19,"subscribers_count":5,"default_branch":"develop","last_synced_at":"2025-04-10T01:08:22.950Z","etag":null,"topics":["bode-plot","calculations","calculators","digital-filter","digital-filters","digital-signal-processing","electrical","electrical-circuits","electrical-engineering","electrical-grid","electrical-motors","electrical-system","electricity","formulas","impedance","plotting","python","research","university"],"latest_commit_sha":null,"homepage":"https://electricpy.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/engineerjoe440.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-08-06T15:42:32.000Z","updated_at":"2025-04-06T21:00:23.000Z","dependencies_parsed_at":"2023-09-24T05:23:26.386Z","dependency_job_id":"2531d031-7bd9-4035-ae8e-072e6f993971","html_url":"https://github.com/engineerjoe440/ElectricPy","commit_stats":{"total_commits":540,"total_committers":15,"mean_commits":36.0,"dds":0.6351851851851852,"last_synced_commit":"68a69725c9c7a12c3f707729eee6842566b0e14b"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineerjoe440%2FElectricPy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineerjoe440%2FElectricPy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineerjoe440%2FElectricPy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/engineerjoe440%2FElectricPy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/engineerjoe440","download_url":"https://codeload.github.com/engineerjoe440/ElectricPy/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248137887,"owners_count":21053775,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bode-plot","calculations","calculators","digital-filter","digital-filters","digital-signal-processing","electrical","electrical-circuits","electrical-engineering","electrical-grid","electrical-motors","electrical-system","electricity","formulas","impedance","plotting","python","research","university"],"created_at":"2024-11-16T22:58:51.314Z","updated_at":"2025-04-10T01:08:30.709Z","avatar_url":"https://github.com/engineerjoe440.png","language":"Python","funding_links":["https://www.buymeacoffee.com/engineerjoe440"],"categories":[],"sub_categories":[],"readme":"\u003ca href=\"https://electricpy.readthedocs.io/en/latest/\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/engineerjoe440/ElectricPy/master/logo/ElectricpyLogo.svg\" width=\"200\" alt=\"logo\" align=\"right\"\u003e\n\u003c/a\u003e\n\n# ElectricPy\n\n*Electrical-Engineering-for-Python*\n\n[![sphinx](https://github.com/engineerjoe440/ElectricPy/actions/workflows/sphinx-build.yml/badge.svg?branch=master)](https://github.com/engineerjoe440/ElectricPy/actions/workflows/sphinx-build.yml)\n[![Documentation Status](https://readthedocs.org/projects/electricpy/badge/?version=latest)](https://electricpy.readthedocs.io/en/latest/?badge=latest)\n![Tox Import Test](https://github.com/engineerjoe440/ElectricPy/workflows/Tox%20Tests/badge.svg)\n\n[![pytest](https://github.com/engineerjoe440/ElectricPy/actions/workflows/pytest.yml/badge.svg?branch=master)](https://github.com/engineerjoe440/ElectricPy/actions/workflows/pytest.yml)\n[![pydocstyle](https://github.com/engineerjoe440/ElectricPy/actions/workflows/pydocstyle.yml/badge.svg?branch=master)](https://github.com/engineerjoe440/ElectricPy/actions/workflows/pydocstyle.yml)\n![Coverage](https://raw.githubusercontent.com/engineerjoe440/ElectricPy/gh-pages/coverage.svg)\n\n[![](https://img.shields.io/pypi/v/electricpy.svg?color=blue\u0026logo=pypi\u0026logoColor=white)](https://pypi.org/project/electricpy/)\n[![](https://pepy.tech/badge/electricpy)](https://pepy.tech/project/electricpy)\n[![](https://img.shields.io/github/stars/engineerjoe440/electricpy?logo=github)](https://github.com/engineerjoe440/electricpy/)\n[![](https://img.shields.io/pypi/l/electricpy.svg?color=blue)](https://github.com/engineerjoe440/electricpy/blob/master/LICENSE.txt)\n\n[![Matrix](https://img.shields.io/matrix/electricpy:stanleysolutionsn.com?label=%23electricpy:stanleysolutionsnw.com\u0026logo=matrix\u0026server_fqdn=matrix.stanleysolutionsnw.com\u0026style=for-the-badge)](https://matrix.to/#/#electricpy:stanleysolutionsnw.com)\n\n[![\"Buy Me A Coffee\"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/engineerjoe440)\n\n\nPython Libraries with functions and constants related to electrical engineering.\n\nThe functions and constants that make up these modules represent a library of\nmaterial compiled with the intent of being used primarily for research,\ndevelopment, education, and exploration in the realm of electrical engineering.\n\nCheck out our full documentation: https://electricpy.readthedocs.io/en/latest/\n\n\u003ca title=\"Fabián Alexis, CC BY-SA 3.0 \u0026lt;https://creativecommons.org/licenses/by-sa/3.0\u0026gt;, via Wikimedia Commons\" href=\"https://commons.wikimedia.org/wiki/File:Antu_dialog-warning.svg\"\u003e\u003cimg width=\"25px\" alt=\"Antu dialog-warning\" src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/f/f7/Antu_dialog-warning.svg/512px-Antu_dialog-warning.svg.png\"\u003e\u003c/a\u003e **Documentation has recently been updated to use [ReadTheDocs](https://readthedocs.org/)**\n\nGitHub Pages are still active, and will continue to be for the forseeable\nfuture, but they're intended for developmental updates rather than primary\ndocumentation.\n\n## Features\n\n* Extensive set of common functions and formulas for electrical engineering and\nelectronics.\n* Support for LaTeX math generation (use this in conjunction with your Jupyter\nnotebooks!)\n* Generate focussed and simple plots, diagrams, and figures.\n\n### Samples Generated with ElectricPy\n\n| Phasor Plot | Power Triangle | Induction Motor Circle |\n|-------------|----------------|------------------------|\n| ![](https://raw.githubusercontent.com/engineerjoe440/ElectricPy/gh-pages/_images/PhasorPlot.png) | ![](https://raw.githubusercontent.com/engineerjoe440/ElectricPy/gh-pages/_images/PowerTriangle.png) | ![](https://raw.githubusercontent.com/engineerjoe440/ElectricPy/gh-pages/_images/InductionMotorCircleExample.png) |\n\n\n| RLC Frequency Response |                | Receiving Power Circle |\n|------------------------|----------------|------------------------|\n| ![](https://raw.githubusercontent.com/engineerjoe440/ElectricPy/gh-pages/_images/series-rlc-r5-l0.4.png) |  | ![](https://raw.githubusercontent.com/engineerjoe440/ElectricPy/gh-pages/_images/ReceivingPowerCircleExample.png) |\n\n## Installing / Getting Started\n\n1. ElectricPy has a few basic installation options for use with `pip`. For most\ncommon users, use the following command to install ElectricPy with `pip`\n\n```\npip install electricpy[full]\n```\n  \n2. Check installation success in Python environment:\n\n```python\nimport electricpy\nelectricpy._version_\n```\n\n3. Start using the electrical engineering formulas\n\n```python\n\u003e\u003e\u003e import electricpy as ep\n\u003e\u003e\u003e voltage = ep.phasor(67, 120) # 67 volts at angle 120 degrees\n\u003e\u003e\u003e voltage\n(-33.499999999999986+58.02370205355739j)\n\u003e\u003e\u003e ep.cprint(voltage)\n67.0 ∠ 120.0°\n```\n\n### Installing from Source\n\nIf you're looking to get the \"latest and greatest\" from electricpy, you'll want\nto install directly from GitHub, you can do that one of two ways, the easiest of\nwhich is to simply issue the following command for `pip`\n\n```\npip install git+https://github.com/engineerjoe440/ElectricPy.git\n```\n\nAlternatively, you can do it the \"old fashioned way\" by cloning the repository\nand installing locally.\n\n1. Clone/Download Source Code from [GitHub Repository](https://github.com/engineerjoe440/ElectricPy)\n2. Open Terminal and Navigate to Folder with `cd` Commands:\n  - `cd \u003cpath\\to\\containing\\folder\u003e\\electricpy`\n3. Use Python to Install Module from `setup.py`:\n  - `pip install .`\n\n### Dependencies\n\n- [NumPy](https://numpy.org/)\n- [matplotlib](https://matplotlib.org/)\n- [SciPy](https://scipy.org/)\n- [SymPy](https://www.sympy.org/en/index.html)\n\n#### Optional Dependencies\n\nFor numerical analysis (install with `pip install electricpy[numerical]`):\n\n- [numdifftools](https://numdifftools.readthedocs.io/en/latest/)\n\nFor fault analysis (install with `pip install electricpy[fault]`)\n\n- [arcflash](https://github.com/LiaungYip/arcflash)\n\n\n## Get Involved / Contribute\n\nIf you're interested in contributing, we'd love to see your support in a number\nof ways!\n\n1. **Write Tests** - We're really lacking in this area. We've recently added\nsimple GitHub actions to test installation, but that's about it. We hope that\nsomeday we can test all functions in this module for verification.\n2. **Contribute New Electrical Engineering Functions** - If you've got a new\nfunction related to electrical engineering that you'd like to see added, we'd\nlove to throw it into this module. Our goal is that this module can become the\ncomprehensive electrical engineering toolkit in Python. Drop us a note, or\ncreate a [pull request](https://github.com/engineerjoe440/ElectricPy/pulls)!\n3. **Report Issues** - We don't want issues to go unnoticed. Please help us\ntrack bugs in [our issues](https://github.com/engineerjoe440/ElectricPy/issues)\nand resolve them!\n4. **Get the Word Out** - This project is still in its infancy, so please share\nit with your friends and colleagues. We want to make sure that everyone has the\nopportunity to take advantage of this project.\n\n**Check out the [contribution guide](https://github.com/engineerjoe440/ElectricPy/blob/master/CONTRIBUTING.md)**\n\n**Come [chat about ElectricPy](https://matrix.to/#/#electricpy:stanleysolutionsnw.com)**\n\n### Special thanks to...\n\n- Stephen Weeks | Student - U of Idaho\n- Jeremy Perhac | Student - U of Idaho\n- Daniel Allen | Student - Universtiy of Idaho\n- Dr. Dennis Sullivan | Proffessor - U of Idaho\n- Dr. Brian Johnson | Proffessor - U of Idaho\n- Dr. Joe Law | Proffessor - U of Idaho\n- StackOverflow user gg349\n- Shaurya Uppal | Online Code Contributor\n- Paul Ortman | Power Quality Engineer - Idaho Power | Instructor - U of Idaho\n\n*and*\n\n\u003ca href=\"https://github.com/engineerjoe440/electricpy/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=engineerjoe440/electricpy\" alt=\"contributors\"\u003e\n\u003c/a\u003e\n\n## Contact\n\nFor more information regarding this resource, please contact Joe Stanley\n\n- \u003cengineerjoe440@yahoo.com\u003e\n\n## License and Usage\n\nElectricPy is licensed under the standard MIT license, and as such, you are\npermitted to use this resource as you see fit. Please feel free to ask\nquestions, suggest edits and report bugs or other issues.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fengineerjoe440%2Felectricpy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fengineerjoe440%2Felectricpy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fengineerjoe440%2Felectricpy/lists"}