artificial-terrains 0.1.0__tar.gz

artificial_terrains-0.1.0/LICENCE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2025 Erik Wallin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

artificial_terrains-0.1.0/PKG-INFO

@@ -0,0 +1,364 @@
+Metadata-Version: 2.4
+Name: artificial-terrains
+Version: 0.1.0
+Summary: Modular, extensible terrain generation library
+Author-email: Erik Wallin <erik.wallin@umu.se>
+License: MIT
+Project-URL: Homepage, https://github.com/erikwallin86/artificial_terrains
+Description-Content-Type: text/markdown
+License-File: LICENCE.md
+Requires-Dist: numpy
+Requires-Dist: matplotlib
+Requires-Dist: scipy
+Requires-Dist: colorcet
+Requires-Dist: opensimplex
+Dynamic: license-file
+
+# artificial_terrain
+
+A library and script for creating artificial terrains.
+The library is described in more detail in the following arXiv preprint: [arXiv abstract](https://arxiv.org/abs/2506.19751), [PDF download](https://arxiv.org/pdf/2506.19751).
+The paper also includes more up-to-date and relevant examples.
+For now, the README has only been cleaned to remove outdated or incorrect information; further updates are planned.
+
+The script executes an ordered list of specified 'modules', to create and combine terrain buidling blocks to (more or less) realistic terrains.
+
+## Use as libary
+To use as library (temporary solution until properly published/released on pypi) (only tested in linux)
+1. Clone this repo
+2. Navigate the the main folder, and run `pip install .`
+Example of how to construct a simple terrain:
+```
+import artificial_terrains as at
+
+
+settings = [
+    ('Size', 100),
+    ('Basic', {}),
+    ('WeightedSum', {}),
+    ('Print', {}),
+    ('Plot', {}),
+    ('Save', {}),
+]
+
+at.run(settings, verbose=True)
+terrain = at.get_terrain()
+print(f"terrain:{terrain}")
+```
+
+
+
+## Getting started
+The following command creates a terrain with an overall ground-shape generated from a `WeightedSum` of different simplex noise `Octaves`. `Holes` and `Rocks` of different scale are generated and combined with a `Min` and `Max` operation respectivly. The resultant ground, holes, and rocks are `Combined` with a default Add operation, and the result is `Save`d and `Plot`ted in the folder Result.
+```
+python generate_terrain.py --modules Holes Combine:Min Octaves WeightedSum Rocks Combine:Max Combine Save:Result Plot:Result --save-dir Terrains/test_001a/
+```
+
+Alternativly, the same command can be run by
+```
+python generate_terrain.py --settings-file settings.yml
+```
+with settings specified in a yaml file,
+```yaml
+save-dir: runs/data_001a
+modules:
+- Holes
+- [Combine, Min]
+- Octaves
+- WeightedSum
+- Rocks
+- [Combine, Max]
+- Combine
+- [Save, Result]
+- [Plot, Result]
+```
+In all runs, a copy of the used settings is saved in `settings.yml`, and commands and prints are appended to `logger.txt`.
+
+## Modules
+The overall setup for creating a terrain is to create 'terrain elements', and combine them in different ways.
+
+We can split the modules in some main categories. Two fundamental such is 'generating' and 'combining'. The 'generating' generate 'terrain elements', and the 'combining' combine these elements into more complex terrains. Some modules alter the general 'settings' (e.g. extent and resolution), and some do 'input/output' (e.g. save terrains and plot).
+
+### Pipes
+Modules are called in order, and the output of one module is passed as input to the next, as if connected along a 'pipe'. This makes it possible to generate a multitude of terrain of different types and complexities using basic building blocks.
+
+It is also possible to run multiple pipes to generate a number of terrains.
+
+### 'Primary' and 'temporary' terrain lists
+In order to combine basic building blocks to more complex results, and in turn combine these and so on, we utilize two lists for storing sub-results, 'primary' and 'temporary'.
+Generated terrain elements are placed in the `temporary` list.
+If a 'combining' module is run, it primarily operates on the content of the 'temporary' list, with the result appended to the 'primary' list.
+If the 'temporary' list is empty, the 'combining' module operates on the 'primary' list instead.
+
+### Generating from noise
+| Technique | Description | Input arguments| Output |
+|-----------|-------------|-------|-------|
+| **Octaves** | Generate a list of 'terrain elements' (default=10) from random noise with increasing scale factor. Additionally passes a `weights` list which can be used by `WeightedSum` to combine the 'terrain elements' to a more complex terrain. | `num_octaves=10` <br /> `start=128` <br /> `persistance=0.6` <br /> `amplitude_start=10` <br /> `random_amp=0.5` | <img src="readme/images/octaves_fixed.png" height="75"> <br /> `weights=amplitude_list` |
+| **Basic** | Generate a list of 3 'terrain elements' with a large, medium, small scale factor from random noise. | | <img src="readme/images/basic_fixed.png" height="75"> |
+| **Rocks** | Generate a list of 'terrain elements' (default=4) representing rocks from random noise. | `rock_size=[0.5,1,2,4]` <br /> `rock_heights=None` <br /> `fraction=0.8` | <img src="readme/images/rocks_fixed.png" height="75"> |
+| **Holes** | Generate a list of 'terrain elements' (default=4) representing holes from random noise. | `size_list=[0.5,1,2,4]` <br /> `fraction=0.8`  | <img src="readme/images/holes_fixed.png" height="75"> |
+
+### Combining
+| Technique | Description | Input arguments | Example input| Output |
+|-----------|-------------|----------------|---------------|--------|
+|**Combine**| Combines the (entire by default) content of the 'temporary' list (primarily) or the 'primary' list (secondarily) using a mathematical operation e.g. (add, min, max, prod). | `operation='add'`  <br /> `last=None` | <img src="readme/images/trio_fixed.png" height="75"> | `Combine:add` <img src="readme/images/add.png" height="75"> <br /> `Combine:max` <img src="readme/images/max.png" height="75"> <br /> `Combine:min`<img src="readme/images/min.png" height="75">  <br /> `Combine:prod`<img src="readme/images/prod.png" height="75">
+|**CombineLast**| As Combine, but only work on the last 2 terrains in the 'temporary' or primary lists. (note that this is a shortcut, and the option `last=X` can be passed to `Combine` for the more general case of combining the last X terrains) | `operation='add'` |  |
+|**WeightedSum**| Add the content of the 'temporary' list as a weighted sum. The input `weights` must match the length of the 'temporary' list.| `weights=[5,8,0.1]` | <img src="readme/images/octaves_fixed.png" height="75"> | <img src="readme/images/octaves_sum_fixed.png" height="75"> |
+
+
+
+
+### Other?
+| Technique | Description | Image |
+|-----------|-------------|-------|
+| **Extent** | Set the coordinate bounds of the terrain as [x_min, x_max, y_min, y_max]. Determines the physical area covered. | |
+| **Location** | Shifts the terrain’s position in space. Applied as an offset to the Extent. | |
+| **Size** | Set the physical size of the terrain  | |
+| **Resolution** | 'resolution', in points per meter. Used to infer the grid-size, if that is not explicitly given | |
+| **GridSize** | Set the 'grid_size', the number of values in each dimension. Overrides the `resolution` if given. | |
+| **Seed** | Set random seed | |
+| **Folder** | Set folder, affects eg. 'Save' and 'Plot' and other modules where a 'folder' is given as input | |
+| **Set** | Set parameter value as `Set:parameter=value` | |
+| **SetDistribution** | Set distribution as `SetDistribution:parameter=distribution[*args]`. Both square and rounded parenthesis can be used. In bash, rounded parameter must either be 'escaped' (as  `SetDistribution:parameter=distribution\(*args\)`), or placed within quotation marks (as `SetDistribution:'parameter=distribution(*args)'` | |
+
+
+
+### Obstacles?
+| Technique | Description | Input | Example 1 | Example 2 | Example 3 | Example 4 |
+|-----------|-------------|-------|-------|-------|-------|-------|
+| **LoadObstacles** | LoadObstacles | | |
+| **SaveObstacles** | SaveObstacles | | |
+| **Random** | Random | `number_of_values` <br /> `position_distribution` <br /> `height_distribution` <br /> `yaw_deg_distribution` <br /> `width_distribution` <br /> `aspect_distribution` <br /> `pitch_deg_distribution` <br /> `position_distribution_2d` | `Random:10` <br /> <img src="readme/images/random_10.png" height="75">  | `Random:position` <br /> <img src="readme/images/random_2.png" height="75"> | `Random:[position,yaw_deg]` <br /> <img src="readme/images/random_5.png" height="75"> |`Set:number_of_values=10 Random:[position,yaw_deg]` <br /> <img src="readme/images/random_6.png" height="75"> |
+
+
+### Generating from functions
+| Technique | Description | Input | Basic output | Combined output |
+|-----------|-------------|-------|---|----|
+| **Gaussian** | Gaussian | `position` <br /> `height` <br /> `yaw_deg` <br /> `width` <br /> `aspect` <br /> ~~`pitch_deg`~~ |  `Gaussian` <br /> <img src="readme/images/gaussian_fixed.png" height="75"> | `Random:10 Gaussian Combine:Max` <br /> <img src="readme/images/combined_gaussian_fixed.png" height="75"> |
+| **Step** | Step| `position` <br /> `height` <br /> `yaw_deg` <br /> ~~`width`~~ <br /> ~~`aspect`~~ <br /> ~~`pitch_deg`~~  | `Step` <br /> <img src="readme/images/step_fixed.png" height="75"> | `Random:10 Step Combine:Max` <br /> <img src="readme/images/combined_step_fixed.png" height="75"> |
+| **Donut** | Donut| `position` <br /> `height` <br /> `yaw_deg` <br /> `width` <br /> `aspect` <br /> ~~`pitch_deg`~~  | `Donut` <br /> <img src="readme/images/donut_fixed.png" height="75"> | `Random:10 Donut Combine:Max` <br /> <img src="readme/images/combined_donut_fixed.png" height="75"> |
+| **Plane** | Plane| ~~`position`~~ <br /> ~~`height`~~ <br /> `yaw_deg` <br /> ~~`width`~~ <br /> `aspect` <br /> `pitch_deg`  | `Plane` <br /> <img src="readme/images/plane_fixed.png" height="75"> | `Random:10 Plane Combine:Max` <br /> <img src="readme/images/combined_plane_fixed.png" height="75"> |
+| **Sphere** | Sphere| `position` <br /> `height` <br /> `yaw_deg` <br /> `width` <br /> `aspect` <br /> ~~`pitch_deg`~~  | `Sphere` <br /> <img src="readme/images/sphere_fixed.png" height="75"> | `Random:10 Sphere Combine:Max` <br /> <img src="readme/images/combined_sphere_fixed.png" height="75"> |
+| **Cube** | Cube| `position` <br /> `height` <br /> `yaw_deg` <br /> `width` <br /> `aspect` <br /> ~~`pitch_deg`~~  | `Cube` <br /> <img src="readme/images/cube_fixed.png" height="75"> | `Random:10 Cube Combine:Max` <br /> <img src="readme/images/combined_cube_fixed.png" height="75"> |
+| **SmoothStep** | SmoothStep| | `SmoothStep` <br /> <img src="readme/images/smoothstep_fixed.png" height="75"> | `Random:10 SmoothStep Combine:Max` <br /> <img src="readme/images/combined_smoothstep_fixed.png" height="75"> |
+| **Sine** | Sine| ~~`position`~~ <br /> `height` <br /> `yaw_deg` <br /> `width` <br /> ~~`aspect`~~ <br /> ~~`pitch_deg`~~  | `Sine` <br /> <img src="readme/images/sine_fixed.png" height="75"> | `Random:10 Sine Combine:Max` <br /> <img src="readme/images/combined_sine_fixed.png" height="75"> |
+
+
+### Modifiers
+| Technique | Description | Image |
+|-----------|-------------|-------|
+|**Negate**| Negate ||
+|**Scale**| Scale ||
+|**Add**| Add ||
+|**Absolute**| Absolute ||
+|**Clip**| Clip ||
+|**Around**| Around ||
+|**Smooth**| Smooth ||
+|**AsProbability**| AsProbability ||
+|**AsLookupFor**| AsLookupFor ||
+|**AsFactor**| AsFactor ||
+
+
+### Settings
+
+
+### Input/output
+| Technique | Description | Input |
+|-----------|-------------|-------|
+| Save | Save terrains | `folder='Save'` (default) <br /> `filename='terrain.npz'`  |
+| Plot | Plot terrains | |
+
+
+### Other
+| Technique | Description | Input |
+|-----------|-------------|-------|
+| **Exit** | Exit early  |   |   |
+| **Print** | Print information of pipe  |   |   |
+
+
+
+### Examples
+Examples of different combinations of modules and the resultant terrains. Only the relevant modules are listed in the table, and not the full command to generate the terrain/rendered images. However, these commands can be found below the table. In some cases, alternative (equivalent or almost equivalent) formatting are shown. Most of the terrains/images are generated by a single command, but some might require two or more.
+
+| #| Description | Modules | Output |
+|-|------------|-------|-------|
+| 1 | Sloped plane with grooves. Adding an angled plane to a sine plane | `Set:width=10 Sine Random:1 Plane Combine` **or** <br /> `Sine:"dict(width=10)" Plane:"dict(pitch_deg=10)" Combine:Add` |  <img src="readme/images/02_angled_sine_plane_fixed.png" > |
+| 2|  Walls along the perimiter. Negating a large cube. | `Set:width=45 Cube Negate` **or** <br /> `Cube:"dict(width=45)" Negate`| <img src="readme/images/01_wall_fixed.png"> |
+| 3 | Moon landscape. Combine multiple 'donuts' using a pointwise max, and adding to a large sphere | `Random:20 Donut Combine:Max Set:width=500 Sphere ToPrimary Combine:Add` | <img src="readme/images/03_moon_landcape_fixed.png"> |
+|4 | Stone circle. Interpret a large donut as a positional probability, and setup a constant width-distribution. Draw 30 random samples to generate cube-terrains in the temporary list, and combine using pointwise max.  | `Donut:"dict(width=35)" AsProbability SetDistribution:width=uniform[2,2] Random:30 Cube Combine:Max` | <img src="readme/images/04_stone_circle_fixed.png" > |
+| 5| Stone circle with obj-file stones. Increase resolution to 10 points-per-meter. Make a flat terrain, and use to make a blender-ground. Sample points along a circle as above, and use to add rocks in blender. Generate Depth image and save. | `Resolution:10 Plane Ground Donut:"dict(width=35)" AsProbability SetDistribution:width=uniform[2,2] Random:30 AddRocks Depth Save` | <img src="readme/images/05_stone_circle2b_fixed.png"> |
+| 6 | Terrain from noise, combined with step function  |  `Octaves WeightedSum Random:2 Step Combine:Max Combine:Add` | <img src="readme/images/06_terrain_with_step_fixed.png" > |
+| 7 | Load from saved 'octaves' and combine using random weights  | `Resolution:10 Octaves Save:Octaves` **then** `Load:runs/data_030/Octaves Random:weights WeightedSum` | <img src="readme/images/07_generate_and_load_fixed.png" > |
+| 8 | Load from saved octaves, and add unevenly spaced rocks. We use the combination of some 'Basic' terrains to get a 2d position probability, and add 10 obj-file rocks in blender.   | (Assumes first step from 7) `Load:runs/data_030/Octaves Random:weights WeightedSum Ground Basic Combine:Add AsProbability Random:10 AddRocks Depth Save` | <img src="readme/images/08_unevenly_spaced_rocksb_fixed.png" > |
+
+
+#### Full commands to make terrains, plot, and save as numpy npz files
+```
+# 1
+python generate_terrain.py --save-dir runs/data_030 --settings overwrite:True --modules Sine:"dict(width=10)" Plane:"dict(pitch_deg=10)" Combine:Add Folder:02_angled_sine_plane Plot Save
+# 2
+python generate_terrain.py --save-dir runs/data_030 --settings overwrite:True --modules Set:width=45 Cube Negate Folder:01_wall Plot Save
+
+# 6
+python generate_terrain.py --save-dir runs/data_030 --settings overwrite:True --modules Octaves WeightedSum Random:2 Step Combine:Max Combine:Add Folder:06_terrain_with_step Plot Save
+# 7
+python generate_terrain.py --save-dir runs/data_030 --settings overwrite:True --modules Resolution:10 Octaves Save:Octaves
+python generate_terrain.py --save-dir runs/data_030 --settings overwrite:True --modules Load:runs/data_030/Octaves Random:weights WeightedSum Folder:07_generate_and_load Plot Save
+# 8
+blender --python generate_terrain.py -- --save-dir runs/data_030 --settings overwrite:True --modules Load:runs/data_030/Octaves Random:weights WeightedSum Ground Basic Combine:Add AsProbability Random:10 AddRocks Folder:08_unevenly_spaced_rocks Resolution:10 Camera:top Depth Save
+```
+
+
+#### Full commands to make the above rendered images
+```
+# 1
+blender --python generate_terrain.py -- --save-dir runs/data_030 --settings overwrite:True --modules Sine:"dict(width=10)" Plane:"dict(pitch_deg=10)" Combine:Add Folder:02_angled_sine_plane Plot Save Ground ColorMap:dimgray Camera:angled Holdout Render Exit
+# 2
+blender --python generate_terrain.py -- --save-dir runs/data_030 --settings overwrite:True --modules Set:width=45 Cube Negate Folder:01_wall Plot Save Ground ColorMap:dimgray Camera:angled Holdout Render Exit
+
+# 6
+blender --python generate_terrain.py -- --save-dir runs/data_030 --settings overwrite:True --modules Octaves WeightedSum Random:2 Step Combine:Max Combine:Add Folder:06_terrain_with_step Plot Save Ground ColorMap:dimgray Camera:angled Holdout Render
+# 7
+python generate_terrain.py --save-dir runs/data_030 --settings overwrite:True --modules Resolution:10 Octaves Save:Octaves
+blender --python generate_terrain.py -- --save-dir runs/data_030 --settings overwrite:True --modules Load:runs/data_030/Octaves Random:weights WeightedSum Folder:07_generate_and_load Plot Save Ground ColorMap:dimgray Camera:angled Holdout Render
+# 8
+blender --python generate_terrain.py -- --save-dir runs/data_030 --settings overwrite:True --modules Load:runs/data_030/Octaves Random:weights WeightedSum Ground Basic Combine:Add AsProbability Random:10 AddRocks Folder:08_unevenly_spaced_rocks Resolution:10 Camera:top Depth Save
+blender --python generate_terrain.py -- --save-dir runs/data_030 --settings overwrite:True --modules Load:runs/data_030/08_unevenly_spaced_rocks/terrain_00000.npz Ground Folder:08_unevenly_spaced_rocksb Plot Save Ground ColorMap:dimgray Camera:angled Holdout Render
+```
+
+
+
+
+### Blender
+The script `generate_terrain.py` enables using blender via its python interface. All the above modules work, in additionally a number of specific modules, listed below.
+To run the blender script, the following command is used in place of `python generate_terrain.py`: `blender --python generate_terrain.py --`. Note the final `--`, which states that any following arguments are passed to the script `generate_terrain.py` (and not the actual blender software). An example run, producing an angled plane with sine grooves:
+```
+blender --python generate_terrain.py -- --save-dir runs/data_001/ --modules Sine Random Plane Combine Ground
+```
+
+| Technique | Description | Input | Output |
+|-----------|-------------|-------|-------|
+| **Ground** | Create grid, using either a terrain from a specified file, or the latest terrain in the primary or temporary heaps | `filename=None` | `Ground` <br /> <img src="readme/images/ground_fixed.png" height="75"> |
+| **ColorMap** | Color heightfield using colormap  | ~~`cmap='viridis'`~~  |  `Ground ColorMap` <br /> <img src="readme/images/colormap_fixed.png" height="75"> |
+| **AddRocks** | Add rocks to scene.   |   `position` <br /> ~~`height`~~ <br /> `yaw_deg` <br /> `width` <br /> ~~`aspect`~~ <br /> `pitch_deg` | `Ground Random:10 AddRocks` <br /> <img src="readme/images/addrocks_fixed.png" height="75"> |
+| **ImageTexture** | Color heightfield using image texture file  | `filename=None`  |  `Ground ImageTexture:image_texture.png` <br /> <img src="readme/images/imagetexture_fixed.png" height="75"> |
+| **Render** |   |   | `Ground Random:10 AddRocks Render` <br /> <img src="readme/images/addrocks_fixed.png" height="75"> |
+| **RenderSegmentation** |   |  |  `Ground Random:10 AddRocks RenderSegmentation` <br /> <img src="readme/images/render_segmentation_fixed.png" height="75"> |
+| **Depth** | Generate depth image. This also returns a 'terrain', but this will only be resonable together with the `Camera:top` command, see below.  |   | `Ground Random:10 AddRocks Depth` <br /> <img src="readme/images/depth_fixed.png" height="75"> |
+| **Camera** | Setup camera. Takes either 'angled' or 'top' as input  |   | `... Depth:top` <br /> <img src="readme/images/depth_top.png" height="75"> |
+| **GenericCamera** |   |   |   |
+| **Holdout** | Add a large 'holdout plane' at height -100 m, which gives a transparent background in generated images.  |   |   |
+| **BasicSetup** | Clean and setup basic blender scene. NOTE: Runs by default as the first module.  |   |   |
+
+
+
+
+
+
+
+## Dependencies
+In order to be able to run, the following python packages should be installed.
+```
+python -m pip install numpy
+python -m pip install matplotlib
+python -m pip install opensimplex
+python -m pip install colorcet
+python -m pip install PyYaml
+python -m pip install scipy
+```
+
+
+## Settings file
+The options in the settings can be specified with different formatting. The `modules` is a list of 2-tuples/lists `(module-name, options)`. The following contains 4 examples of equivalent formatting.
+```yaml
+modules
+# Version 1, default formatting
+- - Donut
+  - position:
+    - 10
+    - 10
+    height: 5
+
+# Version 2, position list on one line
+- - Donut
+  - position: [10, 10]
+    height: 5
+
+# Version 3, options as a one line dict
+- - Donut
+  - {position: [10, 10], height: 5}
+
+# Version 4, [name, options] on one line
+- [Donut, {position: [10, 10], height: 5}]
+```
+In each run, the used settings are saved to `<save_dir>/settings.yml`.
+
+
+## Extending
+The setup is modular and new 'modules' can easiliy be added, as e.g.
+```
+class NewModule(Module):
+    ''' A new module '''
+    @debug_decorator
+    def __call__(self, terrain=None,
+                 default=None,
+                 overwrite=False,
+                 **_):
+```
+This inherits from the `Module` base class, which sets up e.g. logging and `self.save_dir`. The new module is setup by defining the `__call__` method. As a module is run, this method is executed, with the `pipe` given as keyword arguments. The `default` argument is special. If a single value/string is passed as options for the module, e.g. `Random:10` or `Load:folder/terrain.npz`, then this is passed as the 'default' value.
+Otherwise the keyword arguments are given py the pipe, or by specifying a dict input to the module, as e.g. `Gaussian:"dict(position=[10,10],height=3,width=10)"`
+
+The above example takes a `terrain` keyword as input, with the idea of this being passed in the 'pipe' from a previous module, e.g. `Load` or some 'generating' module. Anything can be passed between modules in this way, and the names are arbitrary. Some special are the following,
+[Note that these are the current names and this might/will change after some clean up]
+| Name | Description |
+|-----------|-------------|
+| `terrain_prim` | The primary list |
+| `terrain_temp` | The temporary list |
+| `position`, `height`, `yaw_deg`, `width`, `aspect`, `pitch_deg` | Parameterisation of generation functions, obstacles etc. in a common interface |
+| `extent`, `resolution` | Parameterisation of the terrain extent and resolution. |
+| `weights` | A list of weights, which is currently used by `WeightedSum` to combine different basics to a terrain |
+
+The `return` from a module is collected, in order to allow passing information between modules. The typical return type is a `dict`. It is used to update the pipe, after which any `None` type values are removed from the pipe.
+
+
+## Ubuntu
+Install blender, and clone the repo.
+Use a virtual environment for python.
+If the virtual environment uses the same version of python as blender does, life will be easier.
+(otherwise the blender script will give some ModuleNotFoundError)
+Install the following python packages
+```
+python -m pip install numpy
+python -m pip install matplotlib
+python -m pip install opensimplex
+python -m pip install colorcet
+python -m pip install PyYaml
+python -m pip install scipy
+```
+
+
+## Windows
+Install git for Windows, install python, and install blender. Clone the repo.
+
+When running blender scripts, this uses a separate python, and the dependencies must be installed there as well.
+This worked by running the following in git-bash in Windows:
+```
+ C:\\Program\ Files\\Blender\ Foundation\\Blender\ 4.1\\4.1\\python\\bin\\python.exe -m pip install matplotlib
+ C:\\Program\ Files\\Blender\ Foundation\\Blender\ 4.1\\4.1\\python\\bin\\python.exe -m pip install opensimplex
+ C:\\Program\ Files\\Blender\ Foundation\\Blender\ 4.1\\4.1\\python\\bin\\python.exe -m pip install colorcet
+ C:\\Program\ Files\\Blender\ Foundation\\Blender\ 4.1\\4.1\\python\\bin\\python.exe -m pip install PyYaml
+ C:\\Program\ Files\\Blender\ Foundation\\Blender\ 4.1\\4.1\\python\\bin\\python.exe -m pip install scipy
+```
+(There where some problems with scipy though, for unknown reasons)
+
+
+## If things don't work
+There is a script, `print_installed_packages.py`, which can be used to debug the python environment.
+Running it with blender can show the installed packages, and help to understand which python is run (e.g. blender python, system python, or some python environment?).
+```
+blender --python print_installed_packages.py --background
+```
+This can be compared to running python
+```
+python print_installed_packages.py
+```