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

https://github.com/todbot/circuitpython_noise

Simplex noise (like Perlin) for CircuitPython
https://github.com/todbot/circuitpython_noise

Last synced: about 1 year ago
JSON representation

Simplex noise (like Perlin) for CircuitPython

Awesome Lists containing this project

README

          

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 `_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle `_
or individual libraries can be installed using
`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 `_.

For information on building library documentation, please check out
`this guide `_.

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
`_
before contributing to help this project stay welcoming.