Metadata-Version: 2.1
Name: electripy
Version: 0.0.1
Summary: Visualize the electric field of a point charge network
Home-page: https://github.com/pypa/sampleproject
Author: Dylan Tintenfich
Author-email: tintenfichdylan05@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/dylannalex/electripy
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# ElectriPy :zap:

<p align="center">
  <img width="400" height="400" src="../media/electripy-demo.gif?raw=true">
</p>

Visualize the electric field of a point charges network.

## :electric_plug: Installation

Install ElectriPy package:

```
$ pip install electripy
```

You are all done! To start the simulation type:

```
$ python -m electripy
```

_NOTE:_ you need to have **Python** and **pip** installed.

## :electric_plug: Controls

- Right click to add an electron
- Left click to add a proton
- Press <kbd>r</kbd> to remove all charges from screen
- Press <kbd>+</kbd> to increment force vector scale
- Press <kbd>-</kbd> to decrement force vector scale
- Press <kbd>t</kbd> to show or hide force array components


