Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sjaak31367/micropython_perlin
A module for micropython which adds the ability to generate Perlin noise
https://github.com/sjaak31367/micropython_perlin
micropython perlin
Last synced: 2 months ago
JSON representation
A module for micropython which adds the ability to generate Perlin noise
- Host: GitHub
- URL: https://github.com/sjaak31367/micropython_perlin
- Owner: sjaak31367
- License: mit
- Created: 2024-08-31T13:35:25.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-09-11T14:14:20.000Z (3 months ago)
- Last Synced: 2024-09-30T07:07:34.718Z (2 months ago)
- Topics: micropython, perlin
- Language: C
- Homepage:
- Size: 1.09 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- trackawesomelist - Micropython Perlin (⭐0) - A Perlin noise generator module. (Recently Updated / [Sep 15, 2024](/content/2024/09/15/README.md))
- awesome-micropython - Micropython Perlin - A Perlin noise generator module. (Libraries / Mathematics)
README
## Micropython Perlin
----
#### A module for micropython which adds the ability to generate Perlin noise
Developed against micropython [v1.24.0-preview.218.gb704ff66c.dirty](https://github.com/micropython/micropython/commit/b704ff66c3e034c36e548eb0b9874871b5f3b5d0) with a WEMOS S2 Mini (esp32s2) and ESP-IDF [v5.2.2](https://github.com/espressif/esp-idf/releases/tag/v5.2.2) with Python [3.8.10](https://www.python.org/downloads/release/python-3810/).
#### 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:
```py
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](https://gist.github.com/Flafla2/1a0b9ebef678bbce3215).
Early Natmod version was based off Casey Duncan's [Noise](https://github.com/caseman/noise) (MIT License).