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 <https://python-poetry.org/>`__. Just install with
``poetry install`` and let Poetry manage the environment and
dependencies.
Prerequisites
-------------
To generate video output, the package uses
`ffmpeg <https://ffmpeg.org/>`__. Download and install from
`here <https://ffmpeg.org/download.html>`__ according to your os and
distribution and set PATH accordingly. Note that this is only required
for generating video output.
Usage
=====
See
`documentation <https://attractors.readthedocs.io/en/latest/>`__
on readthedocs.io
Changelog
=========
See
`changelog <https://github.com/Vignesh-Desmond/attractors/blob/main/CHANGELOG.md>`__
for previous versions
Development
===========
This package is under early stages of development it's open to any constructive suggestions.
Please send bug reports and feature requests through issue trackers and pull requests.
License
=======
This package is licensed under the `MIT
License <https://github.com/Vignesh-Desmond/attractors/blob/main/LICENSE>`__
.. |Build status| image:: https://img.shields.io/github/workflow/status/Vignesh-Desmond/attractors/Build?style=flat-square&logo=GitHub
:target: https://github.com/Vignesh-Desmond/attractors/actions/workflows/build.yml
.. |PyPI version| image:: https://img.shields.io/pypi/v/attractors?color=blue&style=flat-square
:target: https://pypi.python.org/pypi/attractors/
.. |PyPI license| image:: https://img.shields.io/pypi/l/attractors?style=flat-square&color=orange
:target: https://lbesson.mit-license.org/
.. |CodeCov| image:: https://codecov.io/gh/Vignesh-Desmond/attractors/branch/main/graph/badge.svg?token=2VKMZ5EYVS
:target: https://codecov.io/gh/Vignesh-Desmond/attractors
.. |Docs status| image:: https://img.shields.io/readthedocs/attractors?style=flat-square
:target: https://attractors.readthedocs.io/en/latest/
Raw data
{
"_id": null,
"home_page": "https://github.com/Vignesh-Desmond/attractors",
"name": "attractors",
"maintainer": "Vignesh Mohan",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "vignesh.desmond@gmail.com",
"keywords": "Attractors,Strange Attractors,Lorenz,Chen,Chaotic Attractors",
"author": "Vignesh Mohan",
"author_email": "vignesh.desmond@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/13/fd/f32716e07836dae77dd42b3b9a7b831589b040e15750da614e8824477d0c/attractors-1.4.1.tar.gz",
"platform": "",
"description": "attractors\n==========\n\n|Build status| |Docs status| |PyPI version| |PyPI license| |CodeCov|\n\nattractors is a package for simulation and visualization of strange\nattractors.\n\nInstallation\n============\n\nThe simplest way to install the module is via PyPi using pip\n\n``pip install attractors``\n\nAlternatively, the package can be installed via github as follows\n\n::\n\n git clone https://github.com/Vignesh-Desmond/attractors\n cd attractors\n python -m pip install .\n\nTo set up the package for development and debugging, it is recommended\nto use `Poetry <https://python-poetry.org/>`__. Just install with\n``poetry install`` and let Poetry manage the environment and\ndependencies.\n\nPrerequisites\n-------------\n\nTo generate video output, the package uses\n`ffmpeg <https://ffmpeg.org/>`__. Download and install from\n`here <https://ffmpeg.org/download.html>`__ according to your os and\ndistribution and set PATH accordingly. Note that this is only required\nfor generating video output.\n\nUsage\n=====\n\nSee\n`documentation <https://attractors.readthedocs.io/en/latest/>`__\non readthedocs.io\n\nChangelog\n=========\n\nSee\n`changelog <https://github.com/Vignesh-Desmond/attractors/blob/main/CHANGELOG.md>`__\nfor previous versions\n\nDevelopment\n===========\n\nThis package is under early stages of development it's open to any constructive suggestions. \nPlease send bug reports and feature requests through issue trackers and pull requests.\n\nLicense\n=======\n\nThis package is licensed under the `MIT\nLicense <https://github.com/Vignesh-Desmond/attractors/blob/main/LICENSE>`__\n\n.. |Build status| image:: https://img.shields.io/github/workflow/status/Vignesh-Desmond/attractors/Build?style=flat-square&logo=GitHub\n :target: https://github.com/Vignesh-Desmond/attractors/actions/workflows/build.yml\n.. |PyPI version| image:: https://img.shields.io/pypi/v/attractors?color=blue&style=flat-square\n :target: https://pypi.python.org/pypi/attractors/\n.. |PyPI license| image:: https://img.shields.io/pypi/l/attractors?style=flat-square&color=orange\n :target: https://lbesson.mit-license.org/\n.. |CodeCov| image:: https://codecov.io/gh/Vignesh-Desmond/attractors/branch/main/graph/badge.svg?token=2VKMZ5EYVS\n :target: https://codecov.io/gh/Vignesh-Desmond/attractors\n.. |Docs status| image:: https://img.shields.io/readthedocs/attractors?style=flat-square\n :target: https://attractors.readthedocs.io/en/latest/",
"bugtrack_url": null,
"license": "MIT",
"summary": "Simulation and visualization of strange attractors",
"version": "1.4.1",
"project_urls": {
"Documentation": "https://attractors.readthedocs.io/en/latest/",
"Homepage": "https://github.com/Vignesh-Desmond/attractors",
"Repository": "https://github.com/Vignesh-Desmond/attractors"
},
"split_keywords": [
"attractors",
"strange attractors",
"lorenz",
"chen",
"chaotic attractors"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d193d235ded8cc96e9381e08715a6789a3a3478978cdd6f5794e90cfb38bbfe1",
"md5": "f39d2db3e47bd99a6277df24f8da5bb9",
"sha256": "f7345aa07cd5ee76d8849f21c390d0e947713c873d0fb8f604473e9ea0f8e421"
},
"downloads": -1,
"filename": "attractors-1.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f39d2db3e47bd99a6277df24f8da5bb9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 33897,
"upload_time": "2021-08-01T16:57:12",
"upload_time_iso_8601": "2021-08-01T16:57:12.735685Z",
"url": "https://files.pythonhosted.org/packages/d1/93/d235ded8cc96e9381e08715a6789a3a3478978cdd6f5794e90cfb38bbfe1/attractors-1.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "13fdf32716e07836dae77dd42b3b9a7b831589b040e15750da614e8824477d0c",
"md5": "815d9705c33946acd4379d3041cfe7f0",
"sha256": "0f97bb6a07aaa6f24132b1f92b75e55965d8c8ea6a789dc59ae786b900167bc8"
},
"downloads": -1,
"filename": "attractors-1.4.1.tar.gz",
"has_sig": false,
"md5_digest": "815d9705c33946acd4379d3041cfe7f0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 30849,
"upload_time": "2021-08-01T16:57:14",
"upload_time_iso_8601": "2021-08-01T16:57:14.278173Z",
"url": "https://files.pythonhosted.org/packages/13/fd/f32716e07836dae77dd42b3b9a7b831589b040e15750da614e8824477d0c/attractors-1.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-08-01 16:57:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Vignesh-Desmond",
"github_project": "attractors",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "attractors"
}
JSON
