Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/phaseportrait/phaseportrait

A simple way to do 2D and 3D phase portraits.
https://github.com/phaseportrait/phaseportrait

3d-trajectory-visualization cobweb-plot logistic-maps phase-diagram phase-portrait python

Last synced: 23 days ago
JSON representation

A simple way to do 2D and 3D phase portraits.

Awesome Lists containing this project

README

        

[![PyPI Downloads](https://img.shields.io/pypi/dm/phaseportrait.svg?label=downloads)](https://pypi.org/project/phaseportrait/)
[![PyPI Version](https://img.shields.io/pypi/v/phaseportrait?)](https://pypi.org/project/phaseportrait/)

![Commit activity](https://img.shields.io/github/commit-activity/m/phaseportrait/phaseportrait)
[![License](https://img.shields.io/pypi/l/phaseportrait)](LICENSE)
[![Build](https://img.shields.io/github/actions/workflow/status/phaseportrait/phaseportrait/ci.yml)](https://github.com/phaseportrait/phaseportrait/actions)

[![Python Version](https://img.shields.io/pypi/pyversions/phaseportrait)](https://pypi.org/project/phaseportrait/)
[![Wheel](https://img.shields.io/pypi/wheel/phaseportrait)](https://pypi.org/project/phaseportrait/)










```py
from matplotlib import pyplot
import numpy

import phaseportrait

def pendulum(θ, dθ):
return dθ, - numpy.sin(θ)

SimplePendulum = phaseportrait.PhasePortrait2D(pendulum, [-9, 9], Title='Simple pendulum', xlabel=r"$\Theta$", ylabel=r"$\dot{\Theta}$")
SimplePendulum.plot()

pyplot.show()
```










.

# Documentation

To check out [*phaseportrait*'s documentation](https://phaseportrait.github.io/), view some examples and read more about it, check our website or try our [Graphical User Interface](https://github.com/phaseportrait/phaseportrait-gui)!

# Installation
**Installing via pip:**

Phaseportrait releases are available as wheel packages for macOS, Windows and Linux on PyPI. Install it using pip:
```
$ pip install phaseportrait
```

**Installing from source:**

Open a terminal on desired route and type the following:
```
$ git clone https://github.com/phaseportrait/phaseportrait
```
**Manual installation**

Visit [phase-portrait](https://github.com/phaseportrait/phaseportrait) webpage on GitHub. Click on green button saying *Code*, and download it in zip format.
Save and unzip on desired directory.

# What's this?
The idea behind this project was to create a simple way to make phase portraits in 2D and 3D in Python, as we couldn't find something similar on the internet, so we got down to work. (Update: found [jmoy/plotdf](https://github.com/jmoy/plotdf), offers similar 2D phase plots but it is very limited).

Eventually, we did some work on bifurcations, 1D maps and chaos in 3D trayectories.

This idea came while taking a course in non linear dynamics and chaos, during the 3rd year of physics degree, brought by our desire of visualizing things and programming.

We want to state that we are self-taught into making this kind of stuff, and we've tried to make things as *professionally* as possible, any comments about improving our work are welcome!

# Authors

- Víctor Loras Herrero ([email protected])
- Unai Lería Fortea ([email protected])

# Contributing
This proyect is open-source, everyone can download, use and contribute. To do that, several options are offered:

* Fork the project, add a new feature / improve the existing ones and pull a request via GitHub.
* Contact us on our emails:
* [[email protected]](mailto:[email protected])
* [[email protected]](mailto:[email protected])