You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**Electrocute** is a Python library designed for electronic formulas and signal processing. It provides easy-to-use functions for calculations like Ohm's Law, power, FFT, DFT, and filters, making it ideal for engineers, students, and hobbyists.
27
+
**Electrocute** is a Python library built for electronics and signal processing enthusiasts. Whether you're an engineer, student, or hobbyist, this package offers intuitive functions for working with electrical formulas and analyzing signals with ease.
28
28
29
29
---
30
30
31
-
## Installation
31
+
## 📦 Installation
32
32
33
33
```bash
34
34
pip install electrocute
35
35
```
36
36
37
-
## Usage
37
+
---
38
+
39
+
## 🚀 Quick Start
40
+
41
+
### Basic Electronic Formulas
38
42
39
43
```python
40
-
from electrocute import Electrocute
44
+
from electrocute.formulas.basic import BasicFormulas
45
+
46
+
# Calculate voltage using Ohm's Law: V = I * R
47
+
voltage = BasicFormulas.ohms_law(current=2, resistance=5)
48
+
print(f"Voltage: {voltage} V") # Output: Voltage: 10 V
49
+
50
+
# Calculate power: P = V * I
51
+
power = BasicFormulas.power(voltage=10, current=2)
52
+
print(f"Power: {power} W") # Output: Power: 20 W
53
+
```
41
54
42
-
# Calculate voltage using Ohm's Law
43
-
voltage = Electrocute.ohms_law(current=2, resistance=5)
44
-
print(f"Voltage: {voltage} V") # Output: 10 V
55
+
### Frequency Spectrum Analysis
45
56
57
+
```python
46
58
import numpy as np
47
-
from electrocute import Electrocute
59
+
from electrocute.signal_processing.transforms import Transforms
- 📐 **Electronic Formulas**: Ohm's Law, power, and more.
87
+
- 🎚️ **Signal Processing**: FFT, DFT, filtering, and spectral analysis.
88
+
- 📚 **Extensible API**: Easy-to-use, modular design for seamless integration.
55
89
56
-
- Electronic formulas (Ohm's Law, power calculations, etc.)
57
-
- Signal processing (FFT, DFT, frequency spectrum, filters)
58
-
- Extensible and well-documented API
90
+
---
91
+
92
+
## 🤝 Contributing
93
+
94
+
Contributions are welcome!
95
+
If you'd like to report a bug, request a feature, or contribute code, feel free to open an issue or submit a pull request on [GitHub](https://github.com/your-repo/electrocute).
59
96
60
-
## Contributing
97
+
---
98
+
99
+
## 👨💻 Maintainers
61
100
62
-
Contributions are welcome! Please submit a pull request or open an issue on GitHub.
101
+
This library is actively developed and maintained by **Madhur Thareja**.
63
102
64
-
### Maintainers:
65
-
This library is under development and is actively maintained by Madhur Thareja.
103
+
---
66
104
67
-
## License
105
+
## 📄 License
68
106
69
-
MIT License
107
+
Licensed under the [MIT License](https://opensource.org/licenses/MIT).
108
+
Feel free to use, modify, and distribute this library.
0 commit comments