Metadata-Version: 2.1
Name: double-pendulum
Version: 1.0.4
Summary: A small double pendulum simulator
Home-page: https://github.com/Nekurone/double-pendulum-ascii/
Author: Nekurone
Author-email: florencesecure@protonmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 (LGPLv2)
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Terminals
Description-Content-Type: text/markdown

<h1 align="center">Double Pendulum Using Curses in Python.</h1>

<p align="center"><a href="https://forthebadge.com" target="_blank"><img src="https://forthebadge.com/images/badges/built-with-love.svg" alt="Build with <3" /></a>&nbsp;<a href="https://forthebadge.com" target="_blank"><img src="https://forthebadge.com/images/badges/made-with-python.svg" alt="Made with python" /></a>&nbsp;<a href="https://forthebadge.com" target="_blank"><img src="https://forthebadge.com/images/badges/powered-by-coffee.svg"/></p>


<p align="center"><a href="https://github.com/psf/black" target="_blank"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black" /></a>&nbsp;<a href="http://makeapullrequest.com" target="_blank"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shields"/></p>

<p align="center">A nice relaxing double pendulum simulation using ASCII, able to simulate multiple pendulums at once, and provide tracing of pendulums.</p>

## Table of Contents

- [Features](#features)
- [Demo](#demo)
- [Quickstart](#demo)
- [Args](#args)
- [TODO](#todo)

## Features
- As mentioned, able to simulate multiple pendulums at once.
- Able to specify the weight and mass of pendulums to create different butterfly effects.
- Uses equations from [here.](https://www.myphysicslab.com/pendulum/double-pendulum-en.html)
- `-s` allows it to grab system specs and display them  (hi r/unixporn)
- `-t` allows for pretty trails :D
- Obviously a lot could be done to it (see below the Args), Any contributions are appreciated)

## Demo:


https://user-images.githubusercontent.com/11583852/127770473-25e63061-cca6-4ca3-997f-d3d1b1469652.mov



## Quickstart:

__Dependencies:__ Python 3.2+,curses (standard on UNIX), psutils if you want to use -s

### Github
- Clone using `https://github.com/Nekurone/double-pendulum-ascii.git` or download the zip.
- Extract if necessary and head inside the folder `double-pendulum`
- ```python3 pendulum.py [args]```

### Pip
- `python3 -m pip install double-pendulum-ascii`
- `python3 -m double-pendulum [args]`

## Args
|short|long|help|default
|--|---|--|--|
|-h| --help | shows help message |N/A|
|-t| --trace | enables the trace functionality | off|
|-p| --pendulums |  Number of pendulums | 1|
|-m| --mass | Starting mass of pendulums | 100.0|
|-l| --length | Starting length of the arms | 250.0|
|-s| --specs | Enables Specs Mode | off |
---------------------------------------------------

## TODO

Note I will not be updating the words on this TODO, but rather just checking them off, as a nice front page reminder of the work done :)

- [x] Add windows functionality
- [ ] Add more functionality to arguments (epsilon, weight1, weight2)
- [ ] General cleanup of variable names
- [ ] Improve efficiency (esp in lists)
- [ ] Add colors :)

<h3 align="center">If you have any suggestions, or anything you'd like to add, just open a PR :)</h3>


