Merge pull request #1009 from ess-dmsc/ECDC-3111_updating_getting_sta…

…rted

ECDC-3111: updating getting started

README.md

@@ -13,7 +13,7 @@ from the detector and other beamline apparatus during an experiment.
 
 There is a ["Getting Started" guide](getting_started.md) to help new users.
 
-![NeXus Constructor](resources/images/nc_screenshot.png)
+![NeXus Constructor](resources/images/main_pic.png)
 
 Although the application may be useful to other institutions using NeXus, the NeXus Constructor is being
 developed as part of the software suite for the

getting_started.md

@@ -17,22 +17,22 @@ Firstly, either download the [latest release](https://github.com/ess-dmsc/nexus-
 
 You will be shown the main window of the application (pictured below) which contains a list of *components* which comprise the beamline, and a 3D view visualising the components listed with their respective shape and position.
 
-The sample component is added by default, and is indicated by the red cube. You can move around the 3D view by using the arrow keys to move, click+drag to pan, and pgup/down to zoom.
+You can move around the 3D view by using the arrow keys to move, click+drag to pan, and pgup/down to zoom.
 
-![](resources/images/NeXusConstructor_001.png)
+![](resources/images/startup_pict.png)
 
 
 ## Adding components
 
-Click the "add component" button.
+Click the "Group" button.
 
-![](resources/images/Selection_003.png)
+![](resources/images/add_group_pic.png)
 
 
 In this screen, we are given options to set what type of component it is, its shape, as well as being able to add fields to describe it further.
 As well as these options, the NeXus format documentation for the component type selected is shown on the right. This suggests what fields to add. You can add undocumented fields with additional information, but the ones in the documentation may be able to be used by other software which reads NeXus files.
 
-![](resources/images/AddComponent_004.png)
+![](resources/images/entry_pic.png)
 
 
 ### Adding a source
@@ -53,44 +53,44 @@ When inputting the name of the field, in this case we'll add "type", you will se
 
 Set the data type of the field by selecting the type combo and selecting "String". In the value edit, enter one of the options specified in the "type" field in the documentation on the right. In this case, let's use `Spallation Neutron Source`
 
-![](resources/images/AddComponent_007.png)
+![](resources/images/select_type.png)
 
-Hit the "Add component" button to save it (Note: you can edit this component once saved by selecting it in the list and using the "Edit component" button near to the add button).
-You will notice in the 3d view there is a new cube which has been added that is black. Currently it overlaps the sample, to remedy this we should add a transformation to the newly added source component.
+Hit the "Add group" button to save it (Note: you can edit this component once saved by selecting it in the list and using the "Edit component" button near to the add button).
+You will notice in the 3d view there is a new cube which has been added that is grey. To move the source away from the origin we will add a transformation to the newly added source component.
 
 #### Setting translation on the source
 
-To the right of the "Add component" button in the main window toolbar, three additional controls can be used to add transformations to a component. Here we have the option to translate, rotate and link to another component's transformations.
+To the right of the "Group" button in the main window toolbar, three additional controls can be used to add transformations to a component. Here we have the option to translate, rotate and link to another component's transformations.
 
-Select the source component in the list by clicking it, then click the "add translation" button.
+Select the source component in the list by clicking it, then click the "Translation" button.
 
-You will see upon adding a new translation the black cube gets shifted to the right immediately. This is because of the default vector specified in the translation. By default the field is disabled, but to edit these fields simply click on it. When finished editing, clicking elsewhere in the list will save the changes.
+You will see upon adding a new translation the cube gets moves immediately. This is because of the default vector specified in the translation. By default the field is disabled, but to edit these fields simply click on it. When finished editing, clicking elsewhere in the list will save the changes.
 
-![](resources/images/NeXusConstructor_008.png)
+![](resources/images/positive_translation.png)
 
 The beam direction is conventionally along the z-axis, so use a vector of (0,0,1) and the set a distance of `-2m`. Distance units can be changed with the units field next to the value.
 
-![](resources/images/NeXusConstructor_009.png)
+![](resources/images/negative_translation.png)
 
 
 ### Adding a detector
 
 *Detectors* are a key component of any beamline. A detector comprised of an array of detecting pixels can be used to infer the angle that the neutrons/muons/photons scattered from the sample.
 
-Enter the "Add component" dialog and select "NXdetector" as the component type. Notice pixel data options appear.
+Enter the "Add group" dialog and select "NXdetector" as the component type. Notice pixel data options appear.
 
 In this example our detector is comprised of a 16x16 grid of pixels.
 
 Select "Cylinder" as the "Shape type" and set the height as 0.5 and radius as 0.3, and leave the units as "m".
 
-![](resources/images/AddComponent_010.png)
+![](resources/images/pixel_setup.png)
 
 We will select the "repeated single pixel shape" here and enter the rows and columns as 16. The row and column heights can be left as their default values.
 
 
 When hitting add, you will notice that the 3D view is updated should contain a grid of 16x16 cylinders. We now just need to move it backwards from the sample by applying another transformation of 5 metres along the z-axis.
 
-![](resources/images/NeXusConstructor_012.png)
+![](resources/images/look_at_instrument.png)
 
 ### Adding a Monitor
 
@@ -104,7 +104,7 @@ Alternatively to cylinder shapes, mesh shapes can be used for components to desc
 To use a mesh file for geometry, select the "Mesh" geometry type. This will show an option to browse for a file. As well as this, units can also be set to change the scale of the geometry.
 To test this, there are OFF and STL files in the `tests/` folder. Let's use the "cube.off" file.
 
-![](resources/images/AddComponent_011.png)
+![](resources/images/mesh_setup.png)
 
 Again, this would need to be moved away from the sample if reflecting a real scenario. It may also need to be rotated. To add multiple transformations, select "Add rotation" or "Add translation" in the order you want them to be added.
 
@@ -116,16 +116,34 @@ These are examples of static datasets. Nexus-constructor also allows you to prov
 In the figure below, you find an example where `rotation_speed` field of a disk chopper is configured as `kafka stream`
 instead of `Scalar or Array dataset`. Choosing `kafka stream` option from the dropdown opens another dialog window where there are options to pick the schema for the `kafka stream` (in this example an [f142](https://github.com/ess-dmsc/kafka-to-nexus/blob/main/documentation/writer_module_f142_log_data.md)). In the example below, `topic` input is the kafka topic where data for chopper `rotation_speed` will be available. There are certain mandatory inputs for eg `topic` and `source` which are common across all the [file-writer](https://github.com/ess-dmsc/kafka-to-nexus) supported [schemas](https://github.com/ess-dmsc/kafka-to-nexus/tree/main/documentation).
 
-![](resources/images/disk_chopper_stream.png)
+![](resources/images/create_kafka_chop.png)
 
 There are often cases where the components (for eg. a detector bank, chopper etc) are installed on platforms that can be translated or rotated with the help of motors during the course of experiment. In such cases datastreams (`kafka stream`) should be used when adding translation/rotation for the component. In this particular case a chopper translation along the `z` direction is assumed to be controlled by a motor (`some_motor_name`) and the information about its datastreams is provided by editing the configurations in `kafka stream` dialog window.
 
-![](resources/images/disk_chopper_transformation_stream.png)
+![](resources/images/edit_kafka_trans.png)
 
 
 ### Opening and saving file-writer commands
 
 We now have a very basic example of a beamline instrument visualised in 3D as well as the resulting NeXus file. The constructor can output to a [file-writer command](https://github.com/ess-dmsc/kafka-to-nexus/blob/master/documentation/commands.md) in JSON format, and can also load from these files.
 To save to a JSON file, open the file menu and click "Save to filewriter JSON". This will bring up a file dialog in order to save the file.
 
-To open a JSON file, open the file menu and click "Open from filewriter JSON". The constructor will then load in all components and their fields from a given file.
+To open a JSON file, open the file menu and click "Open from filewriter JSON". The constructor will then load in all components and their fields from a given file.
+
+## Render settings
+
+In the render settings tab, it is possible to change if the program should render the full geometries or just the convex hulls for large geometries.
+It is also possible to change the colours of materials.
+
+![](resources/images/default_render.png)
+
+### Show high resolution
+
+By default, any large geometry loaded won't be fully rendered. The convex hull of the geometry will be shown instead to improve performance. 
+After meshes have been loaded, the toggle high resolution checkbox will trigger the program to load and render the full geometries of all objects. This may take a long time and might crash the program if the computer lacks enough available memory and video memory.
+
+### Colour settings
+
+Choosing a material class in the dropdown menu makes it possible to change the used colour palette. By pressing the colour rectangles, a colour picker will open where colour can be chosen.
+
+![](resources/images/changed_color.png)