Metadata-Version: 2.1
Name: fieldbillard
Version: 0.0.1
Summary: Field Billard
Home-page: https://github.com/DFNaiff/FieldBillard/
Author: Danilo de Freitas Naiff
Author-email: dfnaiff@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
License-File: LICENSE

A simulator of 2-D positive charges interacting with each other and 
a bounding electric field. Can consider either quasi-electrostatic approximation 
or quasi-electromagnetostatics approximation (through the Darwin Hamiltonian).
Built on PyTorch mostly.

Mostly a toy project done from boredom.


## Installing
On this folder:
```sh
pip install .
```

## Usage
To open the GUI
```sh
import fieldbillard
fieldbillard.run()
```

![Alt text](docs/figs/examplegui.png?raw=true "GUI")

