Skip to main content

A library to generate fractals

Project description

FractPy: a Python library for generating fractals

PyPI License: MIT Documentation Status codecov Code style: black

This library currently implements the generation of following fractals:

  • Newton Fractal
    • For Newton Fractal, this library can currently be used only for polynomial functions with real powers.

FractPy relies on sympy, numpy, and matplotlib - all part of the standard scientific Python stack so is easy to install on all operating systems.

How do I install FractPy?

The recommended way to install fractpy is using Python Package index (PyPi), to install use the following command:

$ python -m pip install fractpy

How do I use FractPy?

Here is an example of generating Newton Fractal for :

from fractpy.models import NewtonFractal
model = NewtonFractal("x**8 - 4x**3 + x**2 - 6")
p = model.plot(-2, 2, -2, 2, (1000, 1000))
p.show()

The above code will generate the following plot:

Full documentation is available here: https://fractpy.readthedocs.io/

How can I contribute to FractPy?

After forking and cloning the forked repository on your computer, change the directory to fractpy and create a virtual environment:

$ cd fractpy
$ python -m venv env 

Activate the virtual environment and install tox:

$ . env/bin/activate
$ python -m pip install tox

Make the required changes and then run the tests using tox (Make sure to run the tests before opening a PR):

$ python -m tox -e dev

Documentation

To build the documentation first install flit, which will help in installing the build requirements:

$ python -m pip installl flit
$ python -m flit install --symlink

Then:

$ cd docs
$ make html

Docs will be built in docs/_build directory.

All contributions are welcome, whether it be adding new methods of generating fractals, writing documentation, or fixing embarrassing bugs!

In the interest of fostering an open and welcoming environment, all contributors, maintainers and users are expected to abide by the Python code of conduct: https://www.python.org/psf/codeofconduct/

Getting Help

For more information or to ask questions about FractPy join our Slack Channel.

Licensing

FractPy is fully open source. For more information about its license, see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fractpy-0.0.4.tar.gz (43.8 MB view details)

Uploaded Source

Built Distribution

fractpy-0.0.4-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

Details for the file fractpy-0.0.4.tar.gz.

File metadata

  • Download URL: fractpy-0.0.4.tar.gz
  • Upload date:
  • Size: 43.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.25.1

File hashes

Hashes for fractpy-0.0.4.tar.gz
Algorithm Hash digest
SHA256 a82565c5efe0e504c5053cb6fa6d2841e861c4bc8ff09dbc3f2913f19349cf00
MD5 a145fbef8788c3d9e9db13f118b9f5d3
BLAKE2b-256 ac779f0b00e886f837f5638672e20d0068cf54e8027f0abbe34c3a052cb56afb

See more details on using hashes here.

File details

Details for the file fractpy-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: fractpy-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 8.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.25.1

File hashes

Hashes for fractpy-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d91f0d0f55d2c07e29b7a636c11ebf2a1ca60cb3e34ac314f0492878ea9f602d
MD5 d9d96186e0b3aadf4cce034d31c81db6
BLAKE2b-256 9dc84d8545ab7aba5f400d77b0cad8f41210acccec9e2e7f3f071eed34795cce

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page