diff --git a/doc/sphinx/user_manual/concepts/painting_in_the_world.md b/doc/sphinx/user_manual/concepts/painting_in_the_world.md index d4cbbc516..6cf5782df 100644 --- a/doc/sphinx/user_manual/concepts/painting_in_the_world.md +++ b/doc/sphinx/user_manual/concepts/painting_in_the_world.md @@ -4,7 +4,7 @@ Painting in the world In the last section we introduced the concept of a feature. In this section we are going to discuss how features are placed inside the world and how they can interact with each other. -The first thing to understand about how GWB features are primarily defined by the user as 2D features on a map. That means that the user provides 2D coordinates of where the feature is located. Only after that, the user provides information to actually make the feature a 3D object. The second thing to understand is that features are provided in a list. The GWB goes through that list from top to bottom and adds each feature to the world in order. If there is any overlap, the user can decide what to do (how to blend the the old and new value), but by default each feature overwrites the old value with the new value. You can think of it like paining, where each features add a layer of paint and the painter can decide to completely paint over an area, or create an interesting blend! +The first thing to understand about how GWB features are primarily defined by the user as 2D features on a map. That means that the user provides 2D coordinates of where the feature is located. Only after that, the user provides information to actually make the feature a 3D object. The second thing to understand is that features are provided in a list. The GWB goes through that list from top to bottom and adds each feature to the world in order. If there is any overlap, the user can decide what to do (how to blend the old and new value), but by default each feature overwrites the old value with the new value. You can think of it like paining, where each features add a layer of paint and the painter can decide to completely paint over an area, or create an interesting blend! Starting with a topographic map ------------------------------- diff --git a/doc/sphinx/user_manual/how_to_use_the_applications/gwb-dat_app.md b/doc/sphinx/user_manual/how_to_use_the_applications/gwb-dat_app.md index 201f31dd7..63da8dbbd 100644 --- a/doc/sphinx/user_manual/how_to_use_the_applications/gwb-dat_app.md +++ b/doc/sphinx/user_manual/how_to_use_the_applications/gwb-dat_app.md @@ -4,7 +4,7 @@ The gwb-dat app The `gwb-dat` app allows you to query the GWB world at many points at a time. As arguments it takes a world builder file, which specifies what the world looks like, and a `.dat` file, which specifies what points you want to query and what information you want to get from it. An example of how it is run is the following: `gwb-dat world_builder_file.wb point_info.dat`. There is only one optional extra argument, which is an option to limit some consistency checks in debug mode: `--limit-debug-consistency-checks` (or `-ldcc` as a shortcut). If you want to use it, it always has to be after the `.dat` file. -The main part of the `.dat` file consists of 3 (in 2D) or 4 (in 3D) columns of numbers. The first 2 or 3 columns are the coordinates of the 2D or 3D point respectively. The last column is the depth. By default in debug mode it is checked for spherical models whether those values are consistent, but you can turn that off the the above mentioned `--limit-debug-consistency-checks` option. +The main part of the `.dat` file consists of 3 (in 2D) or 4 (in 3D) columns of numbers. The first 2 or 3 columns are the coordinates of the 2D or 3D point respectively. The last column is the depth. By default in debug mode it is checked for spherical models whether those values are consistent, but you can turn that off the above mentioned `--limit-debug-consistency-checks` option. Lines with a `#` are either ignored or can have a special meaning. For example a line with `# random text here` is ignored, but a line with `# dim = 2` sets the dimension to 2. The available options are: diff --git a/doc/sphinx/user_manual/how_to_use_the_applications/gwb-grid_app.md b/doc/sphinx/user_manual/how_to_use_the_applications/gwb-grid_app.md index 0fa30e4dc..a8a507708 100644 --- a/doc/sphinx/user_manual/how_to_use_the_applications/gwb-grid_app.md +++ b/doc/sphinx/user_manual/how_to_use_the_applications/gwb-grid_app.md @@ -2,18 +2,18 @@ The gwb-grid app ================ -While the `gwb-dat` app is great at providing individual points, providing gridded output can be very useful as well, especially when you want to to visualize the result. This is exactly what the `gwb-grid` app does. It creates a grid for you with the values you request and outputs it as a `vtu` file. The way of using `gwb-grid` is very similar to using `gwb-dat`: `gwb-grid world_builder_file.wb grid_info.grid`. The only difference is that you now have to provide a `.grid` file instead of a `.dat` file. +While the `gwb-dat` app is great at providing individual points, providing gridded output can be very useful as well, especially when you want to visualize the result. This is exactly what the `gwb-grid` app does. It creates a grid for you with the values you request and outputs it as a `vtu` file. Using `gwb-grid` is very similar to using `gwb-dat`: `gwb-grid world_builder_file.wb grid_info.grid`. The only difference is that you now have to provide a `.grid` file instead of a `.dat` file. -A grid file consists of a number of parameters you can set. The start with a name (no spaces) followed by an equal sign, followed by the value. The available parameters are: +A grid file consists of a number of parameters you can set. Each parameter should start with a name (no spaces) followed by an equal sign, followed by the value. The available parameters are: 1. `grid_type`: Options are `cartesian`, `sphere`, `chunk` and `anullus`. 2. `dim`: dimension, either 2 or 3. 3. `composition`: how many compositions -4. `vtu_output_format`: Either `ASCII` or readable output or `RawBinaryCompressed` for compressed output. +4. `vtu_output_format`: Either `ASCII` for readable output or `RawBinaryCompressed` for compressed output. 5. `x_min`: either the minimum x value or minimum longitude. 6. `x_max`: either the maximum x value or maximum longitude. -7. `y_min`: either the minimum y value or minimum longitude. -8. `y_min`: either the maximum y value or maximum longitude. +7. `y_min`: either the minimum y value or minimum latitude. +8. `y_min`: either the maximum y value or maximum latitude. 9. `z_min`: either the minimum z value or minimum radius. 10. `z_min`: either the maximum z value or maximum radius. 11. `n_cell_x`: either the cells in the x or longitude direction. diff --git a/doc/sphinx/user_manual/how_to_use_the_applications/index.md b/doc/sphinx/user_manual/how_to_use_the_applications/index.md index 4e07186f5..cb74cba06 100644 --- a/doc/sphinx/user_manual/how_to_use_the_applications/index.md +++ b/doc/sphinx/user_manual/how_to_use_the_applications/index.md @@ -2,7 +2,7 @@ How to use the applications =========================== -The Geodynamic World Builder is in its core a code library, which can be used by other codes. That means that to use it you need to write a program which uses it. The apps the gwb provide do exactly this. They are small programs which allow users to directly use the GWB without writing a program themselves. There are currently two apps which come with the GWB: `gwb-dat` and `gwb-grid`. The first application allows users to provide a world builder file and a `.dat`, which is a space separated value file with some extra options, to query individual points of in the world builder world. The second application allows users to use a `.grid` file to create a grid output (`.vtu`) of a whole domain, which then can be visualized in a program like Paraview. +The Geodynamic World Builder is in its core a code library, which can be used by other codes. That means that to use it you need to write a program which uses it. The apps the GWB provides do exactly this. They are small programs that allow users to directly use the GWB without writing a program themselves. There are currently two apps that come with the GWB: `gwb-dat` and `gwb-grid`. The first application allows users to provide a world builder file and a `.dat`, which is a space-separated value file with some extra options, to query individual points of interest in the world builder world. The second application allows users to use a `.grid` file to create a grid output (`.vtu`) of a whole domain, which can then be visualized in a program like Paraview. ```{toctree} :caption: User manual