TkJeoLog is a Python program that is designed to help geological engineers to prepare geological logs more quickly, efficiently and as possible as with few mistakes.
After downloaded the program, users should see the below files and folders in the main directory of the program.
Windows, Linux and macOS
In order to run TkJeoLog, at least Python's 3.6 version must be installed on your computer. Note that in order to use Python on the command prompt, Python should be added to the PATH. There is no need to install manually the libraries that are used by the program. When the program first runs, the necessary libraries will be downloaded and installed automatically.
1. Run the program by writing the below to cmd for Windows or to bash for Unix.
For Unix
python3 run.py
For Windows
python run.py
2. Short time later users should see a window which is similar to below.
3. If users come to the File menu cascade, they should see three menu buttons which are Open, Close and Save.
-
Open menu button enables loading the information of a project stored in a file in JSON format. Thus, we could transfer a project that we have not finished yet or a project that we want to make changes and continue working on it.
-
Close menu button closes a project we have opened or a project we created from scratch.
-
Save menu button saves a project we create into a JSON file.
4. If users come to the Add menu cascade, they should see four menu buttons which are Depth Information, Casing Pipe Information, Project And Company Information and Lithology Information and one menu cascade which is Sample Information. The Sample Information menu cascade contains five menu buttons that are going to be introduced later.
4.1. Clicking the Depth Information menu button creates a window as below:
On the above image, we are seeing that there is one box that we could determine the depth of the borehole. The depth of the borehole could be determined by using the arrows of the box or by entering a number using the keyboard. If the entered value is not a number, we would get a warning message as can be seen below and the box would be colored red:
When a number is written into the box again, the color of the box returns to its original state. By clicking the green button that means OK , we would define the borehole depth and the depth information box closes.
4.2. Clicking the Casing Pipe Information menu button creates a window as below:
The Upper Limit refers to the border that is close to the earth's surface, and the Lower Limit refers to the border that is far from the earth's surface.
When the green plus button at the top is pressed, boxes are created under the Upper Limit and Lower Limit frames as below. If the red minus button is pressed, the created boxes are deleted.
In these boxes, we could enter the meters between which the casing pipe is placed. If a non-number value is written into these boxes, a warning message as below is raised and the color of the box with an invalid value is colored red.
Also, if the button meaning OK is pressed when the Upper Limit value is equal to or greater than Lower Limit, the warning message will be raised as below and the Upper Limit box is colored red.
Also, if a value greater than Borehole Depth is written to Lower Limit and the OK button is pressed, a warning message as below will be raised and the Lower Limit box is colored red.
If the values have been entered correctly, pressing the OK button would close this window.
4.3. Clicking the Project And Company Information menu button creates a window as below:
Each box we see in the picture above allows us to write a value for the information on the left. There is no obligation to fill the entries of this window at the same time. Later, when this window is opened again, previously written values would be preserved. As long as the program is open, the values entered in the boxes created in all opened windows will be preserved if the OK button of the windows is clicked.
4.4. Clicking the Lithology Information menu button creates a window as below:
If the green plus button is clicked, boxes would appear as below:
If incorrect values are written to the Upper Limit and Lower Limit boxes in this window, the user will receive the aforementioned warnings.
There are three values in the Ground Type box. These are as follows:
-
Fine Grained
-
Coarse Grained
-
Rock
The values in the Profile box will change according to the selected Ground Type.
If the Ground Type is selected as Fine Grained, the following values will be included into the Profile box:
-
Clay
-
Silty Clay
-
Sandy Clay
-
Gravely Clay
-
Sandy Silty Clay
-
Gravely Sandy Clay
-
Gravely Sandy Silty Clay
-
Silt
-
Clayey Silt
-
Sandy Silt
-
Gravely Silt
-
Sandy Clayey Silt
-
Gravely Sandy Silt
-
Gravely Sandy Clayey Silt
If the Ground Type is selected as Coarse Grained, the following values will take place in the Profile box:
-
Sand
-
Clayey Sand
-
Silty Sand
-
Gravely Sand
-
Clayey Silty Sand
-
Gravely Clayey Silty Sand
-
Clayey Silty Gravely Sand
-
Gravel
-
Clayey Gravel
-
Silty Gravel
-
Sandy Gravel
-
Clayey Silty Gravel
-
Sandy Clayey Silty Gravel
-
Clayey Silty Sandu Gravel
If the Ground Type is selected as Rock, the following values will take place in the Profile box:
-
Claystone
-
Siltstone
-
Sandstone
-
Conglomerate
-
Breccia
-
Limestone
-
Dolomite
-
Gypsium
-
Anhydrite
-
Salt
-
Coal
-
Ophiolite
-
Tuff
-
Metamorphic Rock
-
Plutonic Rock
-
Volcanic Rock
The Color box next to the Profile box allows the soil or rocks to be colored. When this box is clicked, a window opens as follows:
The desired RGB color could be selected by using the movable buttons in this window or using the arrows of the spinbox or writing a value to the entry field. When the OK key is pressed, this window is closed and the RGB color code of the selected color is written into the Color box.
In the Description box, explanations about the soil or rock could be written.
When the OK button is pressed after the lithology information is entered, the window closes.
4.5. As mentioned before the Sample Information is a menu cascade actually. And it contains the following menu buttons; RC, SPT, UD, Pr and PD.
4.5.1. Clicking the RC menu button creates a window as below:
Clicking the green plus button creates boxes as below, and by clicking the red minus button, the created boxes are deleted.
If incorrect values are entered into the Upper Limit and the Lower Limit boxes in this window, the user would receive the aforementioned warnings.
For a sample with ground type rock, values are selected from the boxes RQD, FRACTURES, WEATHERING and STRENGTH. For a sample that is not ground type rock, these boxes are left blank. For each type of ground, a value is selected from the CAROT RECOVERY box.
What the values in the boxes mean can be figured out by looking at the tables in the Rock and Soil Evaluation section of the log.
If the OK button is clicked after making selections regarding core samples, this window would be closed.
4.5.2. Clicking the SPT menu button creates a window as below:
As in other windows, by clicking the green plus button, boxes are created as follows, and the created boxes are deleted by clicking the red minus button.
If incorrect values are entered into the Upper Limit and the Lower Limit boxes in this window, the user would receive the aforementioned warnings.
The difference between Upper Limit and Lower Limit values cannot be more than 0.45 meters since the SPT test is performed within a maximum range of 45 centimeters. If you do not pay attention to this and the values are selected and the OK button is pressed, users will see a warning like the following:
If any value is selected from the Refusal boxes by mistake, no value can be selected from other boxes until the relevant box is left blank.
If the OK button is clicked after making selections regarding SPT experiments, this window would close.
4.5.3. Clicking the UD menu button creates a window as below:
Again, by clicking the green plus button, the following boxes are created, and by clicking the red minus button, the created boxes are deleted.
If incorrect values are entered into the Upper Limit and the Lower Limit boxes in this window, the user would receive the aforementioned warnings.
If the OK button is clicked after making selections regarding the UD instance, this window would close.
4.5.4. Clicking the Pr menu button creates a window as below:
Again, by clicking the green plus button, the following boxes are created, and by clicking the red minus button, the created boxes are deleted.
If incorrect values are entered into the Upper Limit and the Lower Limit boxes in this window, the user would receive the aforementioned warnings.
This window would close if the OK button is clicked after the selections related to the pressuremeter experiments are made.
4.5.5. Clicking the PD menu button creates a window as below:
Again, by clicking the green plus button, the following boxes are created, and by clicking the red minus button, the created boxes are deleted.
If incorrect values are entered into the Upper Limit and the Lower Limit boxes in this window, the user would receive the aforementioned warnings.
This window would close if the OK button is clicked after the selections related to the Lugeon experiments are made.
5. If users come to the Canvas menu cascade, they should see two menu buttons which are Display, Export.
5.1. If users click the Display menu button, they could display the project information they added before. The canvas could be displayed after the borehole depth is defined.
The arrow keys at the bottom of the screen should be used to navigate through the log pages.
Below are pictures of how a sample project looks on the canvas.
5.2 If users click the Export menu button, they could export the canvas into pdf format.
6. If users come to the Settings menu cascade, they would see only one menu cascade called Language. The Language menu cascade contains two menu buttons which names are English and Turkish. These menu buttons change the language of the program and log. The change would become valid in the next sessions.
The default language of the program is set to English.
If the language of the program is changed while there is a project displayed on the canvas, the menu names and the names of the buttons in the menus will automatically change according to the selected language. In order for the texts on the canvas to be translated according to the selected language, the canvas must be re-displayed. That's why users should go to the Canvas menu cascade and click the Display button. After clicking the Display button, a process takes place in the background to change the texts in the log and after a short while, the texts in the log would be translated to their equivalents in the selected language.
7. If users come to the Help menu cascade, they would see two menu buttons which names are About and Check for updates.
7.1. If the About menu button is clicked, the following window opens:
As can be seen on the above image, in this window, there is not much detailed information about the program and contact information that users can contact me in case of any problem or request.
7.2. If the Check for updates menu button is clicked, users could update their program by clicking this menu button.
TkJeoLog is released under the terms of the GNU GENERAL PUBLIC LICENSE. Please refer to the LICENSE file.