Skip to content

Commit 09a988b

Browse files
author
Mustafa Al Ibrahim
committed
Update Getting Started.txt
1 parent fe6c062 commit 09a988b

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

‎Getting Started.txt

+14-11
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ The software simulates the formation of three-dimensional packings of spherical
2121

2222
2. Running the executable:
2323

24-
The executable can be ran using �Particula.exe� in the �Executable� folder. The parameter file can be modified for the simulation is located in the �Particula_Data� folder. The parameters are defined below. Keyboard shortcut can be used to interactively control the simulation. The shortcuts are defined below. PDF files can be added or modified to define the grain size distribution. They are located in the "PDFs" folder. We suggest the use of NotePad++ to modify the parameter file and the PDF files.
24+
Download the executable from the release tab in GitHub. The executable can be ran using �Particula.exe� in the �Executable� folder. The parameter file can be modified for the simulation is located in the �Particula_Data� folder. The parameters are defined below. Keyboard shortcut can be used to interactively control the simulation. The shortcuts are defined below. PDF files can be added or modified to define the grain size distribution. They are located in the "PDFs" folder. We suggest the use of NotePad++ to modify the parameter file and the PDF files.
2525

2626
========================================================================================
2727

2828
3. Modifying and compiling the source code:
2929

30-
The code has to be compiled in Unity. We recommend downloading version 2018.3 (https://unity3d.com/). Installation of Unity is straight forward. No optional modules are required. Along with familiarity with C#, which is the scripting language in unity, it is highly recommended that you have some familiarly of the basics of Unity before modifying the code. We recommend going through the Roll a Ball and Space Shooter tutorials.
30+
The code has to be compiled in Unity. We recommend downloading version 2020.2 (https://unity3d.com/). Installation of Unity is straight forward. No optional modules are required. Along with familiarity with C#, which is the scripting language in unity, it is highly recommended that you have some familiarly of the basics of Unity before modifying the code. We recommend going through the Roll a Ball and Space Shooter tutorials.
3131

3232
========================================================================================
3333

@@ -46,6 +46,7 @@ If the executable is used, a parameter file is used to provide the input to the
4646
| Modify Scale Automatically | Resize the container based on the grain volume | Boolean | True |
4747
| Estimated Porosity | Estimated porosity used in automatic rescaling | Scaler (fraction)| 0.45 |
4848
| Buffer Length | Edge to exclude in the deposition | Scaler (fraction)| 0.1 |
49+
| Background Color | Color of the background of the software | Vector | [255 255 255] |
4950

5051
-------------------------------------------- Simulation Parameters --------------------------------------------
5152
| Parameter | Explanation | Value type | Example |
@@ -62,7 +63,7 @@ If the executable is used, a parameter file is used to provide the input to the
6263
-------------------------------------------- Shaking Parameters --------------------------------------------
6364
| Parameter | Explanation | Value type | Example |
6465
| --------------------------------|:----------------------------------------------------|:-----------------|:-----------|
65-
| Shake Transversly | Activate/deactivate transverse shaking | Boolean | False |
66+
| Shake Transversely | Activate/deactivate transverse shaking | Boolean | False |
6667
| Shake Rotationally | Activate/deactivate rotational shaking | Boolean | False |
6768
| Stabilize Camera | Stabilize camera while shaking | Boolean | True |
6869
| Shaking Fraction | Fraction with respect to radius (higher: more shake)| Scaler (fraction)| 0.001 |
@@ -112,8 +113,8 @@ If the executable is used, a parameter file is used to provide the input to the
112113
| Bed x Grain y Friction Combine | Average, Minimum, Maximum, Multiply | (Selection) | Average |
113114
| Bed x Grain y Bounce Combine | Average, Minimum, Maximum, Multiply | (Selection) | Average |
114115
| Bed x Grain y Color Type | Size, Base, Secondary, Random | (Selection) | Size |
115-
| Bed x Grain y Base Color | First color in RGB (0-255) | 3D Vector | [255 128 0] |
116-
| Bed x Grain y Secondary Color | Coefficient of restitution (0: in elastic) | 3D Vector | [255 128 0] |
116+
| Bed x Grain y Base Color | First color in RGB (0-255) | Vector | [255 128 0] |
117+
| Bed x Grain y Secondary Color | Coefficient of restitution (0: in elastic) | Vector | [255 128 0] |
117118

118119

119120
-------------------------------------------- Deposition Parameters --------------------------------------------
@@ -132,12 +133,14 @@ If the executable is used, a parameter file is used to provide the input to the
132133
5. Keyboard shortcuts:
133134

134135
--------------------- View ---------------------
135-
| Shortcut | Functionality | Notes |
136-
| ----------------------|:----------------------|:----- |
137-
| Tab | Reset view | |
138-
| w,s,a,d | Move point of view | |
139-
| Up,Down,Left,Right | Rotate point of view | |
140-
| PageUp, PageDown | Zoom in/out | |
136+
| Shortcut | Functionality | Notes |
137+
| ----------------------|:-----------------------|:----- |
138+
| Tab | Reset view | |
139+
| w,s,a,d | Move point of view | |
140+
| Up,Down,Left,Right | Rotate point of view | |
141+
| PageUp, PageDown | Zoom in/out | |
142+
| p | Switch background color| |
143+
| o | Hide/show container | |
141144

142145
--------------------- Deposition ---------------------
143146
| Shortcut | Functionality | Notes |

0 commit comments

Comments
 (0)