Micropython Perlin

---

A module for micropython which adds the ability to generate Perlin noise

Developed against micropython v1.24.0-preview.218.gb704ff66c.dirty with a WEMOS S2 Mini (esp32s2) and ESP-IDF v5.2.2 with Python 3.8.10.

Examples:

planets.py

How to:

Compile (firmware version):

1. You need the micropython repo.
2. Clone this repo into micropython/ports/{port}/boards/{board}/modules
   I'm using a Lolin S2 Mini, so I'll end up with /home/sjaak/.../micropython/ports/esp32/boards/LOLIN_S2_MINI/modules/micropython_perlin/.
3. (A) Compile the firmware:
   cd to micropython/ports/{port}
make USER_C_MODULES=./boards/{board}/modules/micropython_perlin/firmware/perlin.cmake BOARD={board} all
   (B) Or you can add it to micropython/ports/{port}/boards/{board}/mpconfigboard.cmake with set(USER_C_MODULES ${MICROPY_BOARD_DIR}/modules/micropython_perlin/firmware/perlin.cmake)
4. Flash your new firmware, and you should have a functioning perlin noise generator installed!

Compile (native module version):

1. Have the micropython repo, and have mpy-cross compiled.
2. cd into this repo's natmod.
3. Update MPY_DIR and ARCH to your usecase.
4. make
5. Upload perlin.mpy to your board.

Known limitations:
Native module and firmware/python version have different results due to having a different random source.

Speed:

To calculate 6 octaves for 100'000 points (on an ESP32) took:

version	time
python	231'003ms
firmware	9'974ms
natmod	4'340ms

Or in other words, the Python version is here for compatibility, but I'd recommend using another version.

Usage:

import perlin

#perlin.reseed(int seed)
perlin.reseed(31367)

#perlin.octave_perlin(float x, float y, float z, [int octaves, [float persistence]])
perlin.octave_perlin(0.5, 0.5, 0.5, 6)  # 0.531746

---

Credits

Firmware version is based off Adrian Biagioli's Perlin.cs.
Early Natmod version was based off Casey Duncan's Noise (MIT License).