### Install Qt with aqtinstall
Source: https://resinsight.org/releases/build-from-source/build-instructions-windows/index.html
Creates a Python virtual environment, installs aqtinstall, and installs Qt 6.6.3 for Windows desktop with the qtnetworkauth module.
```bash
python3 -m venv myvenv
myvenv/Scripts/activate
pip3 install aqtinstall
aqt install-qt windows desktop 6.6.3 win64_msvc2019_64 -m qtnetworkauth
```
--------------------------------
### Install Qt 6.7.0 with aqtinstall
Source: https://resinsight.org/releases/build-from-source/build-instructions-mac/index.html
Creates a Python virtual environment, installs aqtinstall, and uses it to install Qt 6.7.0 for macOS desktop with the qtnetworkauth module. Run these commands in a root folder for Qt installations.
```bash
python3 -m venv myvenv
source myvenv/bin/activate
pip3 install aqtinstall
aqt install-qt mac desktop 6.7.0 -m qtnetworkauth
```
--------------------------------
### Install custom Qt version with aqtinstall
Source: https://resinsight.org/releases/build-from-source/build-instructions-ubuntu/index.html
Creates a virtual environment, installs aqtinstall, and uses it to install a custom Qt version (6.6.3) with the qtcharts and qtnetworkauth modules.
```bash
python3 -m venv myvenv
source myvenv/bin/activate
pip3 install aqtinstall
aqt install-qt linux desktop 6.6.3 -m qtcharts qtnetworkauth
```
--------------------------------
### ASCII Well Path File Format Example 2
Source: https://resinsight.org/wells-and-completions/wellpaths/index.html
An example of an ASCII well path file demonstrating the use of headers, comments starting with '--' or '#', and the 'Name' keyword for defining well names.
```text
X Y TVD(MSL) MD(RKB)
Name Well_1
6507.1 725 2542 2542
6523.5 757 2549 2578.6
6523.5 760 2559 2589.1
-- A Comment new well
This is not its name
Name Well_2
550.7 1020.2 2410 2520
551 1004.1 2422.2 2540.2
# a comment inside the data
555.2 993.9 2425 2551.6
3Q AHB-J
5507.0 4638.5 0.0 0.0
5507 4638.5 1628.6 1628.6
```
--------------------------------
### Install Ninja and CMake with Homebrew
Source: https://resinsight.org/releases/build-from-source/build-instructions-mac/index.html
Installs the Ninja build system and CMake using Homebrew, which are required for building ResInsight.
```bash
brew install ninja cmake
```
--------------------------------
### Install GCC and build tools on Ubuntu
Source: https://resinsight.org/releases/build-from-source/build-instructions-ubuntu/index.html
Installs GCC and related build tools and libraries required for building ResInsight on Ubuntu.
```bash
sudo apt install build-essential curl zip unzip tar flex bison pkg-config libgl1-mesa-dev libglu1-mesa-dev libfreetype6-dev libfontconfig1-dev
```
--------------------------------
### Install ResInsight via apt-get on Ubuntu
Source: https://resinsight.org/releases/linux-installation
Installs ResInsight and octave-resinsight from the OPM PPA. The apt-get package does not include Python support due to build server issues. After installation, launch ResInsight using the command 'ResInsight'.
```bash
sudo apt-get update
sudo apt-get install software-properties-common
sudo apt-add-repository ppa:opm/ppa
sudo apt-get update
sudo apt-get install resinsight
sudo apt-get install octave-resinsight
```
--------------------------------
### Install ResInsight via apt-get on Ubuntu
Source: https://resinsight.org/releases/linux-installation/index.html
Install ResInsight on Ubuntu without Python support using the OPM PPA. The apt-get package does not include Python support due to build server issues. After installation, launch the application with the command `ResInsight`.
```bash
sudo apt-get update
sudo apt-get install software-properties-common
sudo apt-add-repository ppa:opm/ppa
sudo apt-get update
sudo apt-get install resinsight
sudo apt-get install octave-resinsight
```
--------------------------------
### Install Qt6 via apt
Source: https://resinsight.org/releases/build-from-source/build-instructions-ubuntu/index.html
Installs Qt6 development packages via the Ubuntu package manager. Note that Qt 6.4 is fully supported for build, but some install features are not supported.
```bash
apt install qt6-base-dev qt6-base-private-dev qt6-charts-dev qt6-networkauth-dev libqt6svg6-dev
Ubuntu 22.04 : Qt 6.2.4
Ubuntu 24.04 : Qt 6.4.2
```
--------------------------------
### Cloud service configuration file paths
Source: https://resinsight.org/import/cloudservicesauthorization/index.html
Lists the default locations for OSDU and SUMO configuration JSON files, both in the user's home folder and in the installation share folder. The paths are shown as examples of where to place configuration files.
```text
home_folder/.resinsight/osdu_config.json
home_folder/.resinsight/sumo_config.json
location_of_executable/../share/cloud_services/osdu_config.json
location_of_executable/../share/cloud_services/osdu_config.json
```
--------------------------------
### Example PTL data file format
Source: https://resinsight.org/reference-manual/surfaces/ptlsurface/index.html
Header lines start with # and specify metadata. Data lines contain x, y, z, column, and row values. The example shows typical header fields and a few surface points.
```plaintext
#Type: scattered data
#Version: 6
#Description: No description
#Format: free
#Field: 1 x
#Field: 2 y
#Field: 3 z meters
#Field: 4 column
#Field: 5 row
#Projection: Local Rectangular
#Units: meters
#End:
#Information from grid
#Grid_size: Not_avaiable
#Grid_space: Not_available
#Z_field: z
#Vertical fault: Not_available
#History: No history
#Z_units: meters
443479.500000 7305390.500000 -1000.000000 1 1
443479.500000 7305488.500000 -1000.000000 1 2
443479.500000 7305586.500000 -1000.000000 1 3
443479.500000 7305684.500000 -1000.000000 1 4
443479.500000 7305782.500000 -1000.000000 1 5
443479.500000 7305880.500000 -1000.000000 1 6
...
```
--------------------------------
### Polyline file format example
Source: https://resinsight.org/3d-main-window/annotations/index.html
Example of a polyline annotation file. Each line defines a point as three doubles (X Y Depth). Lines starting with '#' are comments. Multiple polylines can be defined in one file, separated by comment lines.
```text
# This is a comment
# This is a comment
58177.76 732.7 1643.6
58260.83 732.8 1596.6
57985.66 732.7 1542.0
59601.45 732.4 3639.0
59422.01 732.2 3639.0
59793.41 732.2 3639.0
999 999 999
# starting polyline 2
58260.83 732.8 1596.6
57985.66 732.7 1542.0
59601.45 732.4 3639.0
```
--------------------------------
### Formation Names description file (.lyr) example
Source: https://resinsight.org/3d-main-window/formations/index.html
Example of a Formation Names description file (.lyr). Each line defines a formation name, a k-range (either a single layer or a range), and an optional color specified as an SVG color keyword or a six-digit hexadecimal number. Lines starting with '--' are treated as comments.
```text
-- Any text as comment
'My First Formation Name' 4 - 12 red
'My Second Formation Name' 15 - 17 green
'Formation spanning 3 k-layers, i.e. 18,19 and 20' 3 blue
'Last Formation Name' 21 - 21 #FFFF00
```
--------------------------------
### Perforation interval file example
Source: https://resinsight.org/wells-and-completions/completions/index.html
Example of a perforation interval file in the format described above. The file starts with a UNITS line, then lists wells with WELLNAME and perforation entries. Comments start with '--' and run to the end of the line. Dates can be 'SOH' (Start Of History) or a specific date like '01 SEP 2006'.
```text
UNITS METRIC
-- R-2 AH sidetrack into Ile/Tilje
WELLNAME R-2AH
"SOH" perforation 6200 6350 0.212 0 -- target Ile 2 and Ile 3
"SOH" perforation 7050 7133 0.212 0 -- target Tilje 3, 83 m prodint
-- S-2 AH
WELLNAME S-2AH
"SOH" perforation 4340 4369 0.212 0 -- target Garn 2, 29 m prodint (update 290915)
01 SEP 2006 perforation 5060 6185 0.212 0 -- target Tilje 3, 1125 m prodint
```
--------------------------------
### Install dependencies for RHEL8
Source: https://resinsight.org/releases/build-from-source/build-instructions-ubuntu/index.html
Installs dependencies for building ResInsight on RHEL8 using yum.
```bash
yum install curl zip unzip tar flex bison perl-IPC-Cmd gcc-toolset-10 freeglut perl-Time-Piece
```
--------------------------------
### Example OP_1.txt file
Source: https://resinsight.org/plot-window/ensemblerftplot/index.html
Contains five columns specifying UTM coordinates, depths, and reservoir zone names for a well.
```text
461288.719 5933415.000 1816.200 1611.692 UpperReek
461288.685 5933415.027 1824.560 1620.052 MidReek
461288.683 5933415.029 1840.000 1635.492 LowerReek
```
--------------------------------
### Open ResInsight.app
Source: https://resinsight.org/releases/build-from-source/build-instructions-mac/index.html
Starts the app normally after removing the quarantine attribute. You can also double-click the app.
```bash
open ResInsight.app
```
--------------------------------
### Install Homebrew bison and prepend to PATH
Source: https://resinsight.org/releases/build-from-source/build-instructions-mac/index.html
macOS ships an old bison (2.3) in /usr/bin, which is insufficient for the thrift package built by vcpkg (requires bison newer than 2.5). Install the Homebrew version and put it ahead on your PATH.
```bash
brew install bison
export PATH="$(brew --prefix bison)/bin:$PATH"
```
--------------------------------
### Example well_date_rft.txt with measurement IDs
Source: https://resinsight.org/plot-window/ensemblerftplot/index.html
Shows the mapping of wells to dates and measurement IDs.
```text
R_A2 2018-03-01 1
R_A2 2019-03-01 2
```
--------------------------------
### GOCAD TSURF file format example
Source: https://resinsight.org/reference-manual/surfaces/gocadsurface/index.html
An example of a TSURF data file showing the header, coordinate system definition, and vertex/triangle connectivity definitions.
```text
GOCAD TSurf 1
HEADER {
name:MF_027_SU
}
GOCAD_ORIGINAL_COORDINATE_SYSTEM
NAME Default
AXIS_NAME "X" "Y" "Z"
AXIS_UNIT "m" "m" "m"
ZPOSITIVE Depth
END_ORIGINAL_COORDINATE_SYSTEM
TFACE
VRTX 1 458177.767090 7322538.712891 1643.655884 CNXYZ
VRTX 2 458260.834961 7322392.890625 1596.685303 CNXYZ
VRTX 3 457985.662109 7322783.783203 1542.060059 CNXYZ
VRTX 4 459601.453125 7322511.427734 3639.000000 CNXYZ
VRTX 5 459422.015625 7322689.230469 3639.000000 CNXYZ
VRTX 6 459793.410156 7322338.230469 3639.000000 CNXYZ
...
TRGL 2 61 98
TRGL 20 153 66
TRGL 152 19 65
END
```
--------------------------------
### Example OP_1.obs file
Source: https://resinsight.org/plot-window/ensemblerftplot/index.html
Contains observed pressure in the first column and error in the second column for a specific well.
```text
303.000 3.000
304.000 3.000
305.000 3.000
```
--------------------------------
### Fishbone COMPDAT Export Example
Source: https://resinsight.org/export/completionexport/index.html
Example of an exported COMPDAT file for fishbones, where transmissibility contributions are included as comments.
```text
WELSPECS
-- Well Grp I J RefDepth WellType
Well Path B GR 26 45 1230 Oil \
\
COMPDAT
-- Well I J K1 K2 Status SAT TR DIAM KH S Df
-- Well Path B main bore : 0.0569986
Well Path B 26 45 29 29 OPEN 1* 5.699858E-02 /
-- Fishbone 0: Sub: 0 Lateral: 0 : 0.0021382
-- Fishbone 0: Sub: 0 Lateral: 1 : 0.00228575
-- Fishbone 0: Sub: 0 Lateral: 2 : 0.0126269
-- Fishbone 0: Sub: 1 Lateral: 1 : 0.0112929
-- Fishbone 0: Sub: 2 Lateral: 0 : 0.00566964
-- Well Path B main bore : 0.230572
Well Path B 27 41 15 15 OPEN 1* 2.645858E-01 /
/
```
--------------------------------
### Example well_date_rft.txt (Date Format 1)
Source: https://resinsight.org/plot-window/ensemblerftplot/index.html
Uses a date format with separate columns for day, month, and year.
```text
OP_1 01 02 2000 1
OP_2 01 02 2000 1
OP_4 01 01 2001 1
WI_1 01 02 2000 1
WI_3 01 03 2001 1
```
--------------------------------
### ASCII Well Path File Format Example 1
Source: https://resinsight.org/wells-and-completions/wellpaths/index.html
An example of an ASCII well path file using the WELLNAME keyword and numeric data points for well trajectories.
```text
WELLNAME: WELL1
6507.1 725 2542 2590
6523.5 757 2549 2626.6
6523.5 760 2559 2637.1
-999
WELLNAME: WELL2
550.7 1020.2 2410 2410
551 1004.1 2422.2 2430.2
555.2 993.9 2425 2441.6
-999
```
--------------------------------
### Example well_date_rft.txt (Date Format 2)
Source: https://resinsight.org/plot-window/ensemblerftplot/index.html
Uses a date format with YYYY-MM-DD.
```text
R_A2 2018-03-01 1
R_A2 2019-03-01 2
R_A6 2018-11-07 1
R_A6 2018-11-07 2
R_A6 2018-11-07 3
```
--------------------------------
### ABQUS element property table for elastic properties (MODULUS, RATIO)
Source: https://resinsight.org/import/elementpropertytable
Example of an ABQUS element property table for elastic properties. The first line after the *Distribution Table header lists the property names (MODULUS, RATIO). Data lines start with an element identifier (e.g., Res-1.210) followed by the property values. ResInsight strips the part before the dot and uses the first column as the element ID.
```text
** ELASTIC SETTING FOR EACH ELEMENT
*Distribution Table, name=RSV_Res-1_Elastic_Table
MODULUS, RATIO
*Distribution, name=RSV_Res-1_ELASTICS, location=ELEMENT, Table=RSV_Res-1_Elastic_Table
** Description: Element-by-Element Elastic properties
, 2.
Res-1.210, 11198814808.2538, 0.19041
Res-1.209, 11207002032.1436, 0.19063
Res-1.208, 11222989223.0933, 0.19104
Res-1.207, 11202549454.349, 0.19051
```
--------------------------------
### Full VTU File Example
Source: https://resinsight.org/reference-manual/vtkgeomechmodel/index.html
A complete VTK UnstructuredGrid file demonstrating all sections together: PointData, CellData, Points, and Cells with connectivity, offsets, and types. The example shows a mesh with 2 hexahedral cells and 12 points.
```XML
0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0
100.0 200.0
0 0 0 1 0 0 2 0 0
0 1 0 1 1 0 2 1 0
0 0 1 1 0 1 2 0 1
0 1 1 1 1 1 2 1 1
0 1 4 3 6 7 10 9
1 2 5 4 7 8 11 10
8 16
12 12
```
--------------------------------
### WPIMULT Factor Export Example
Source: https://resinsight.org/export/completionexport/index.html
Example of exporting completion data with WPIMULT factors, which represent the ratio between calculated transmissibility and COMPDAT-exported transmissibility.
```text
WELSPEC
-- Well Grp I J RefDepth WellType
Well Path B GR 26 45 1230 Oil \
\
COMPDAT
-- Well I J K1 K2 Status SAT TR DIAM KH S Df DIR
-- Well Path B main bore : 0.0569986
Well Path B 26 45 29 29 OPEN 1* 1* 0.21600 1* 0.00000 1* 'Z'
-- Fishbone 0: Sub: 0 Lateral: 0 : 0.0021382
-- Fishbone 0: Sub: 0 Lateral: 1 : 0.00228575
-- Fishbone 0: Sub: 0 Lateral: 2 : 0.0126269
-- Fishbone 0: Sub: 1 Lateral: 1 : 0.0112929
-- Fishbone 0: Sub: 2 Lateral: 0 : 0.00566964
-- Well Path B main bore : 0.230572
Well Path B 27 41 15 15 OPEN 1* 1* 0.21600 1* 0.00000 1* 'Z'
/
WPIMULT
-- Well Mult I J K
Well Path B 0.70133 25 45 29 /
Well Path B 25.11396 27 41 15 /
/
```
--------------------------------
### FMU Layer Zone Table (layer_zone_table.txt) example
Source: https://resinsight.org/3d-main-window/formations/index.html
Example of an FMU Layer Zone Table (layer_zone_table.txt). The file contains two columns: the first column lists grid k-layer numbers and the second column gives the corresponding formation name for each layer.
```text
1 UpperReek
2 UpperReek
3 UpperReek
4 UpperReek
5 UpperReek
6 MidReek
7 MidReek
8 MidReek
9 MidReek
10 MidReek
11 LowerReek
12 LowerReek
13 LowerReek
14 LowerReek
```
--------------------------------
### VTU File Format Example
Source: https://resinsight.org/reference-manual/surfaces/vtksurface/index.html
A complete example of a VTU file structure defining an unstructured grid with cell data, points, and connectivity information.
```xml
83769 83769 83769 83769 83769 83769 70169 83769 83769 83769 83769 83769
83769 83769 77369 77369 83769 83769 83769 83769 83769 83769 83769 70169
1.2e-13 1.2e-13 1.2e-13 1.2e-13 1.2e-13 1.2e-2 1.2e-13 1.2e-13 nan nan 1.2e-13 1.2e-13
1.2e-13 1.2e-13 1.2e-13 1.2e-13 1.2e-13 1.2e-13 1.2e-13 1.2e-13 1.2e-13 1.2e-13 1.2e-13 1.2e-13
10 11 12 13 14 15 16 17 17 19 20 21
22 23 24 25 26 27 28 29 30 31 32 33
1095 1095 2604.45 1095 1095 2603.84 1094.47 1095 2604.15 1094.47 1095 2604.76
1095 1095 2605.06 1095.53 1095 2604.76 1095.53 1095 2604.15 1095 1095 2603.23
1094.39 1095 2603.39 1093.94 1095 2603.84 1093.78 1095 2604.45 1093.94 1095 2605.06
1094.39 1095 2605.51 1095 1095 2605.67 1095.61 1095 2605.51 1096.06 1095 2605.06
1096.22 1095 2604.45 1096.06 1095 2603.84 1095.61 1095 2603.39
0 1 2 0 2 3 0 3 4 0 4 5
0 5 6 0 6 1 1 7 8 1 8 2
2 8 9 2 9 10 2 10 3 3 10 11
3 11 12 3 12 4 4 12 13 4 13 14
4 14 5 5 14 15 5 15 16 5 16 6
6 16 17 6 17 18 6 18 1 1 18 7
3 6 9 12 15 18 21 24 27 30 33 36
39 42 45 48 51 54 57 60 63 66 69 72
5 5 5 5 5 5 5 5 5 5 5 5
5 5 5 5 5 5 5 5 5 5 5 5
```
--------------------------------
### Configure ResInsight build with CMake
Source: https://resinsight.org/releases/build-from-source/build-instructions-mac/index.html
Configures the Mac build with explicit CMake flags because there is no Mac preset yet. Set CMAKE_PREFIX_PATH to your local Qt installation and run from the repository root. gRPC and HDF5 are disabled.
```bash
cmake -S . -B build -G Ninja \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_OSX_DEPLOYMENT_TARGET=15.0 \
-DCMAKE_PREFIX_PATH=/6.7.0/macos/lib/cmake \
-DCMAKE_TOOLCHAIN_FILE=ThirdParty/vcpkg/scripts/buildsystems/vcpkg.cmake \
-DRESINSIGHT_ENABLE_GRPC=false \
-DRESINSIGHT_ENABLE_HDF5=false
```
--------------------------------
### Configure custom Qt paths for ResInsight
Source: https://resinsight.org/releases/linux-installation/index.html
Set runtime Qt paths for ResInsight when using a custom Qt version not in the system path. Replace `/path_to_qt` with the actual Qt installation path.
```bash
export LD_LIBRARY_PATH=/path_to_qt
export QT_PLUGIN_PATH=/path_to_qt/plugins:$QT_PLUGIN_PATH
```
--------------------------------
### IRAP text file example
Source: https://resinsight.org/reference-manual/surfaces/rmssurface/index.html
Example of an IRAP text file for a regular surface. The file contains header lines with grid dimensions, coordinates, and spacing, followed by a block of surface elevation values. Use this format when importing or exporting regular surfaces in IRAP text format.
```text
-996 440 25.000000 25.000000
461500.000000 468475.000000 5926500.000000 5937475.000000
280 30.000000 461500.000000 5926500.000000
0 0 0 0 0 0 0
1707.3628 1707.3628 1707.3628 1707.3628 1707.6440 1707.6440
1707.6440 1709.3605 1709.3605 1709.3605 1709.3605 1710.8440
1710.8440 1710.8440 1711.9529 1711.9529 1713.3983 1714.1257
1714.1257 1716.3483 1716.3483 1716.3483 1718.0007 1718.0007
1720.4965 1720.4965 1720.4965 1722.1692 1722.9777 1722.9777
1722.9777 1726.9590 1726.9590 1726.9590 1726.9590 1729.3735
1729.3735 1729.3735 1730.9493 1730.9493 1732.3593 1733.0602
1733.0602 1735.1357 1735.1357 1735.1357 1735.1357 1738.3810
1738.3810 1738.3810 1738.3810 1739.8019 1740.5305 1740.5305
1740.5305 1744.0310 1744.0310 1744.0310 1744.0310 1745.9899
1745.9899 1745.9899 1747.1111 1747.1111 1747.6205 1747.8715
1747.8715 1748.4703 1748.4703 1748.4703 1748.4703 1748.1962
1748.1962 1748.1962 1748.1962 1747.6161 1747.2528 1747.2528
1747.2528 1745.1470 1745.1470 1745.1470 1745.1470 1743.4398
1743.4398 1743.4398 1742.3307 1742.3307 1741.4071 1740.9467
1740.9467 1739.6583 1739.6583 1739.6583 1739.6583 1738.2701
```
--------------------------------
### Example log messages from rotating_logger
Source: https://resinsight.org/misc/applicationlogging/index.html
Shows the format of log messages written by the rotating logger, including timestamps, log level, and messages. The example includes successful completion messages for SMSPEC files and an error message about missing unified or non-unified result files.
```text
[2025-07-24 07:39:52.648] [rotating_logger] [info] Completed C:/gitroot/ResInsight-regression-test/ModelData/2021.10.3dev_drogonsmry/realization-96/iter-3/eclipse/model/DROGON-96.SMSPEC
[2025-07-24 07:39:52.648] [rotating_logger] [info] Completed C:/gitroot/ResInsight-regression-test/ModelData/2021.10.3dev_drogonsmry/realization-97/iter-3/eclipse/model/DROGON-97.SMSPEC
[2025-07-24 07:39:52.648] [rotating_logger] [info] Completed C:/gitroot/ResInsight-regression-test/ModelData/2021.10.3dev_drogonsmry/realization-98/iter-3/eclipse/model/DROGON-98.SMSPEC
[2025-07-24 07:39:52.648] [rotating_logger] [info] Completed C:/gitroot/ResInsight-regression-test/ModelData/2021.10.3dev_drogonsmry/realization-99/iter-3/eclipse/model/DROGON-99.SMSPEC
[2025-07-24 07:39:53.552] [rotating_logger] [info] Completed C:/gitroot/ResInsight-regression-test/ModelData/2021.10.3dev_drogonsmry/realization-93/iter-3/eclipse/model/DROGON-93.SMSPEC
[2025-07-24 07:39:53.553] [rotating_logger] [info] ERROR : Optimized Summary Reader error : neigther unified or non-unified result files found
```
--------------------------------
### CSV polygon file format example
Source: https://resinsight.org/3d-main-window/polygons/index.html
Example of the CSV polygon file format. Each line defines a point as X,Y,Depth,ID. Column headers are ignored.
```text
X,Y,Depth,ID
58177.76,732.7,1643.6,1
58260.83,732.8,1596.6,1
57985.66,732.7,1542.0,1
59601.45,732.4,3639.0,2
59422.01,732.2,3639.0,2
59793.41,732.2,3639.0,2
```
--------------------------------
### Example observation file naming convention
Source: https://resinsight.org/plot-window/ensemblerftplot/index.html
Shows how measurement IDs are appended to the well name for observation files.
```text
R_A2_1.obs
R_A2_1.txt
R_A2_2.obs
R_A2_2.txt
```
--------------------------------
### Well Plan Data Example
Source: https://resinsight.org/wells-and-completions/createnewwellpaths/index.html
Example well plan data displayed when selecting Show Well Plan from the right-click menu of a generated well path. The columns are MDRKB, CL, Inc, Azi, TVDMSL, NS, EW, Dogleg, Build, and Turn. The values are numeric and appear as a tabular text block.
```text
-- MDRKB CL Inc Azi TVDMSL NS EW Dogleg Build Turn
0.00000 0.00000 91.23218 67.46458 2560.64104 7320830.60875 456093.37763 0.00000 0.00000 0.00000
109.69761 109.69761 91.23218 67.46458 2558.28210 7320872.64113 456194.67560 0.00000 0.00000 0.00000
383.74602 274.04841 90.01335 94.84447 2555.24550 7320914.37090 456462.87518 3.00000 -0.13343 2.99727
518.95310 135.20708 88.73259 106.92696 2556.73062 7320888.88803 456595.39303 2.69569 -0.28418 2.68089
597.83872 78.88561 88.73259 106.92696 2558.47547 7320865.92593 456670.84259 0.00000 0.00000 0.00000
730.04479 132.20607 90.46303 138.71821 2559.42803 7320795.18191 456780.51358 7.22424 0.39267 7.21402
1087.97847 357.93368 92.23380 -164.19586 2550.23230 7320460.45997 456856.25443 4.78528 0.14842 -25.38856
```
--------------------------------
### Fracture entry example for Multi-Segment Wells
Source: https://resinsight.org/export/completionexport/index.html
Example of a fracture entry where ResInsight creates one segment for the entire fracture with corresponding COMPSEGS entries for intersecting cells.
```text
WELSEGS
-- Name Dep 1 Tlen 1 Vol 1 Len&Dep PresDrop
C-1 H 2575.39553 2919.53029 1* INC H-- /
-- First Seg Last Seg Branch Num Outlet Seg Length Depth Change Diam Rough
-- Fracture Segments
-- Diam: MSW - Default Dummy
-- Rough: MSW - Default Dummy
-- Traversal Fracture 02 connected to Main stem segment 11
25 25 2 11 0.01000 0.00000 0.15000 0.00005 /
/
COMPSEGS
-- Fractures
-- Name
C-1 H /
-- I J K Branch no Start Length End Length Dir Pen End Range Connection Depth
27 43 1 2 11.27214 11.28214 /
26 44 1 2 11.27214 11.28214 /
```
--------------------------------
### Differential Depletion Fracture Output Table Example
Source: https://resinsight.org/export/completionexport/index.html
Example of the output table for differential depletion scaling, showing well name, fracture name, WBHP source, actual WBHP, and min/max pressure drop. The header comments indicate the time step, WBHP source, and user-defined WBHP.
```text
--
-- Pressure Depletion Time step: 01.Feb 2001
-- WBHP Source: WBHP From Summary Case
-- User Defined WBHP: 200
-- Well Fracture Actual WBHP Min Pressure Drop Max Pressure Drop
------------------------------------------------------------------------------
-- B-1H Fracture_01 221.68147 0.04077 45.10402
-- B-1H Fracture_02 221.68147 0.00624 36.02608
-- B-4DH Fracture_07 200.00000 28.21733 97.34970
--
```
--------------------------------
### exportPropertyInViews examples with and without viewNames
Source: https://resinsight.org/scripting/commandfile/index.html
Exports property values for cells in specified views. The first example exports from all views with caseId=1; the second limits to views "view A" and "view 4".
```python
exportPropertyInViews(caseId=1)
```
```python
exportPropertyInViews(caseId=1, viewNames=["view A", "view 4"])
```
--------------------------------
### Integer list text format
Source: https://resinsight.org/misc/advancedtextinput/index.html
Example of the supported text format for specifying a list of integers, including ranges and steps.
```text
5,10-13,20-26:2
```
--------------------------------
### Pressure/Depth File Format Example
Source: https://resinsight.org/import/pressuredata/index.html
Shows the required format for a pressure/depth data file. It includes a header with TVDMSL and RFT markers, followed by well sections with WELLNAME, DATE, PRESSURE DEPTH, and unit labels (BARSA and METRES), then depth-pressure pairs. Multiple wells can be included in one file.
```text
--TVDMSL
RFT
--
WELLNAME 'OP_1'
DATE 28-FEB-2000
PRESSURE DEPTH
BARSA METRES
302.88 1605.91
303.88 1615.91
304.88 1625.91
304.38 1635.91
--
WELLNAME 'OP_2'
DATE 28-FEB-2000
PRESSURE DEPTH
BARSA METRES
302.88 1600.91
303.68 1610.91
303.88 1612.91
303.99 1620.91
```
--------------------------------
### riGetTimeStepDays
Source: https://resinsight.org/scripting/octaveinterfacereference/index.html
Returns the time from the simulation start as decimal days for all time steps as a vector of doubles.
```APIDOC
## riGetTimeStepDays([CaseId])
### Description
Returns the time from the simulation start as decimal days for all time steps as a vector of doubles.
### Parameters
#### Optional
- **CaseId** (int) - Optional - The ID of the case. If not defined, the current case is used.
### Return Value
- **Vector[DecimalDay]** - A vector of doubles representing the time from simulation start in decimal days for each time step.
```
--------------------------------
### Well Pick CSV file format example
Source: https://resinsight.org/3d-main-window/formations/index.html
Example of a Well Pick file, a semicolon-separated CSV with columns Well name, Column name, Unit name, Top MD, and Base MD. The file must contain the columns "Well name", "Unit name", "Top MD", and "Base MD" to be recognized; other columns are ignored. Unit names OIL, GAS, and WATER are interpreted as fluids, and unit names with capital letters are groups.
```csv
Well name; Column name; Unit name; Top MD; Base MD
B-3H; FLUID; GAS;2203.2;2317.4
B-3H; FLUID; OIL;2317.4;2459
B-3H; STRAT; FANGST GP. ;2203.399902;2223.350098
B-3H; STRAT; Ile Fm. ;2203.399902;2223.350098
B-3H; STRAT; Ile Fm. 3 ;2203.401123;2219.26001
B-3H; STRAT; Ile Fm. 2 ;2219.26001;2222.399902
B-3H; STRAT; Ile Fm. 2.2 ;2219.26;2219.350098
B-3H; STRAT; Ile Fm. 2.1 ;2219.350098;2222.399902
B-3H; STRAT; Ile Fm. 1 ;2222.399902;2223.350098
B-3H; STRAT; BAAT GP. ;2223.350098;2979.28125
B-3H; STRAT; Ror Fm. ;2223.350098;2285.199951
B-3H; STRAT; Ror Fm. 2 ;2223.350098;2246
B-3H; STRAT; Ror Fm. 1 ;2246;2285.199951
B-2H; FLUID; GAS;2144.4;2338.5
B-2H; FLUID; OIL;2338.5;2440
B-2H; STRAT; FANGST GP. ;2144.199951;2158.389893
B-2H; STRAT; Ile Fm. ;2144.199951;2158.389893
B-2H; STRAT; Ile Fm. 2 ;2144.201416;2156.197266
B-2H; STRAT; Ile Fm. 1 ;2156.197266;2158.38501
```
--------------------------------
### Calculate change of oil saturation from time step to time step
Source: https://resinsight.org/scripting/octaveinterface/index.html
Example 1: Uses riGetActiveCellProperty and riSetActiveCellProperty to compute the difference in SOIL between consecutive time steps and store the result as SOILDIFF. The script sets the first column difference to zero and the last column to zero.
```octave
# Calculate change of oil saturation from time step to time step
SOIL = riGetActiveCellProperty("SOIL");
SOILDIFF = SOIL;
i = 0;
for timestep = SOIL
if (i > 0)
SOILDIFF(:,i) = timestep - SOIL(:,i);
endif
i++;
endfor
SOILDIFF(:,i) = 0;
riSetActiveCellProperty(SOILDIFF, "SOILDIFF");
```
--------------------------------
### Bootstrap vcpkg
Source: https://resinsight.org/releases/build-from-source/build-instructions-mac/index.html
Bootstraps vcpkg, which is located in the ThirdParty/vcpkg folder. The actual install of the packages specified in vcpkg.json is done during the CMake configure step.
```bash
ThirdParty/vcpkg/bootstrap-vcpkg.sh
```
--------------------------------
### Launch ResInsight from bin folder
Source: https://resinsight.org/releases/linux-installation
Launches ResInsight from the bin folder after unzipping the nightly build.
```bash
./bin/ResInsight
```
--------------------------------
### Update apt package index
Source: https://resinsight.org/releases/build-from-source/build-instructions-ubuntu/index.html
Updates the apt package index before installing build dependencies.
```bash
sudo apt update
```