Skip to content

Latest commit

 

History

History
74 lines (54 loc) · 2.26 KB

readme.rst

File metadata and controls

74 lines (54 loc) · 2.26 KB

attractors

Build status Docs status PyPI version PyPI license CodeCov

attractors is a package for simulation and visualization of strange attractors.

Installation

The simplest way to install the module is via PyPi using pip

pip install attractors

Alternatively, the package can be installed via github as follows

git clone https://github.com/Vignesh-Desmond/attractors
cd attractors
python -m pip install .

To set up the package for development and debugging, it is recommended to use Poetry. Just install with poetry install and let Poetry manage the environment and dependencies.

Prerequisites

To generate video output, the package uses ffmpeg. Download and install from here according to your os and distribution and set PATH accordingly. Note that this is only required for generating video output.

Usage

Read documentation on readthedocs.io

Changelog

See changelog for previous versions

Contributing

Read contributing on how to contribute.

License

This package is licensed under the MIT License