circuitpython-noise

Introduction

.. image:: https://img.shields.io/discord/327254708534116352.svg :target: https://adafru.it/discord :alt: Discord

.. image:: https://github.com/todbot/CircuitPython_Noise/workflows/Build%20CI/badge.svg :target: https://github.com/todbot/CircuitPython_Noise/actions :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black :alt: Code Style: Black

Simplex noise (like Perlin) for CircuitPython

Dependencies

This driver depends on:

• Adafruit CircuitPython <https://github.com/adafruit/circuitpython>_

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle <https://circuitpython.org/libraries>_ or individual libraries can be installed using circup <https://github.com/adafruit/circup>_.

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

.. code-block:: shell

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

.. code-block:: shell

circup install noise

Or the following command to update an existing version:

.. code-block:: shell

circup update

Usage Example

.. code-block:: python

import time
from noise import noise

i=0
while True:
    n = noise(0.02 * i)
    i += 1
    # print a random terrain with asterisks
    print( " " * int(max(n+1,0) * 40), "*")
    time.sleep(0.01)

Documentation

API documentation for this library can be found on Read the Docs <https://circuitpython-noise.readthedocs.io/>_.

For information on building library documentation, please check out this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>_.

Contributing

Contributions are welcome! Please read our Code of Conduct <https://github.com/todbot/CircuitPython_Noise/blob/HEAD/CODE_OF_CONDUCT.md>_ before contributing to help this project stay welcoming.