Cookbook for Perlin noise#921
Open
TilmanMay wants to merge 4 commits into
Open
Conversation
|
Contributor
danieldouglas92
left a comment
There was a problem hiding this comment.
Hey @TilmanMay, thanks for adding this, it looks great! The figures are very pretty and the documentation in your README is clear. Aside from a few typos, my only comment is that your figure captions aren't being formatted correctly in the built doc. See my comments on the README for how to fix this.
| This cookbook demonstrates how to set up a 3D Cartesian model in World Builder using Perlin noise to generate spatially varying temperature and composition fields. | ||
|
|
||
|
|
||
| Normal temperature field without added disturbances |
Contributor
There was a problem hiding this comment.
I imagine this is supposed to be a figure caption, but in the built docs it does not render that way. To have this be a figure caption, you have to include it between the ::: :::, so it would look like this:
:::{figure} normal_field.png
:name: perlin_noise_normal_field
:alt: Normal temperature field (without noise)
:align: center
Normal temperature field without added disturbances
:::
|
|
||
| ## Model description | ||
|
|
||
| This example contains a simple mantle features with its temperature field disturbed. Perlin noise is used to introduce realistic, multi-scale variations in both temperature and composition fields. |
Contributor
There was a problem hiding this comment.
Suggested change
| This example contains a simple mantle features with its temperature field disturbed. Perlin noise is used to introduce realistic, multi-scale variations in both temperature and composition fields. | |
| This example contains a simple mantle feature with a disturbed temperature field. Perlin noise is used to introduce realistic, multi-scale variations in both temperature and composition fields. |
| - `min temperature` / `max temperature`: Set the output value range for the noise field. | ||
| - `octaves`: Number of noise layers combined; more octaves add detail and complexity. | ||
| - `lacunarity`: Frequency multiplier for each octave (e.g., `frequency *= lacunarity`, default: 2.0). So the next layer has double the frequency, thus lower wavelength and more detail. | ||
| - `persistence`: Amplitude multiplier for each octave (e.g., `amplitude *= persistence`, default: 0.5). So the next layers impact of the overall field is have as small. |
Contributor
There was a problem hiding this comment.
Suggested change
| - `persistence`: Amplitude multiplier for each octave (e.g., `amplitude *= persistence`, default: 0.5). So the next layers impact of the overall field is have as small. | |
| - `persistence`: Amplitude multiplier for each octave (e.g., `amplitude *= persistence`, default: 0.5). So the next layers impact of the overall field is halved. |
Contributor
|
Please add a changelog entry for this as well! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added a cookbook explaining the perlin noise feature, as Menno said, this would be good for documentation purposes.
#916 followup