11``` {eval-rst}
2- :tocdepth: 3
2+ :tocdepth: 2
33```
44
55``` {currentModule} mdio.core.config
1010
1111MDIO can be configured using environment variables to customize behavior for import, export,
1212and validation operations. These variables provide runtime control without requiring code changes.
13+ You can find a summary of the available variables below.
14+
15+ | ** Variable** | ** Type** | ** Default** |
16+ | ------------------------------------- | -------- | -------------------------------- |
17+ | ` MDIO__IMPORT__CPU_COUNT ` | ` int ` | Number of logical CPUs available |
18+ | ` MDIO__EXPORT__CPU_COUNT ` | ` int ` | Number of logical CPUs available |
19+ | ` MDIO__GRID__SPARSITY_RATIO_WARN ` | ` float ` | ` 2.0 ` |
20+ | ` MDIO__GRID__SPARSITY_RATIO_LIMIT ` | ` float ` | ` 10.0 ` |
21+ | ` MDIO__IMPORT__SAVE_SEGY_FILE_HEADER ` | ` bool ` | ` False ` |
22+ | ` MDIO__IMPORT__CLOUD_NATIVE ` | ` bool ` | ` False ` |
23+ | ` MDIO_IGNORE_CHECKS ` | ` bool ` | ` False ` |
24+ | ` MDIO__IMPORT__RAW_HEADERS ` | ` bool ` | ` False ` |
25+ | | | |
1326
1427## CPU and Performance
1528
1629### ` MDIO__EXPORT__CPU_COUNT `
1730
18- ** Type:** Integer
19- ** Default:** Number of logical CPUs available
20-
2131Controls the number of CPUs used during SEG-Y export operations. Adjust this to balance
2232performance with system resource availability.
2333
@@ -28,9 +38,6 @@ $ mdio segy export input.mdio output.segy
2838
2939### ` MDIO__IMPORT__CPU_COUNT `
3040
31- ** Type:** Integer
32- ** Default:** Number of logical CPUs available
33-
3441Controls the number of CPUs used during SEG-Y import operations. Higher values can
3542significantly speed up ingestion of large datasets.
3643
@@ -43,9 +50,6 @@ $ mdio segy import input.segy output.mdio --header-locations 189,193
4350
4451### ` MDIO__GRID__SPARSITY_RATIO_WARN `
4552
46- ** Type:** Float
47- ** Default:** 2.0
48-
4953Sparsity ratio threshold that triggers warnings during grid validation. The sparsity ratio
5054measures how sparse the trace grid is compared to a dense grid. Values above this threshold
5155will log warnings but won't prevent operations.
@@ -56,9 +60,6 @@ $ export MDIO__GRID__SPARSITY_RATIO_WARN=3.0
5660
5761### ` MDIO__GRID__SPARSITY_RATIO_LIMIT `
5862
59- ** Type:** Float
60- ** Default:** 10.0
61-
6263Sparsity ratio threshold that triggers errors and prevents operations. Use this to enforce
6364quality standards and prevent ingestion of excessively sparse datasets that may indicate
6465data quality issues.
@@ -71,8 +72,6 @@ $ export MDIO__GRID__SPARSITY_RATIO_LIMIT=15.0
7172
7273### ` MDIO__IMPORT__SAVE_SEGY_FILE_HEADER `
7374
74- ** Type:** Boolean
75- ** Default:** false
7675** Accepted values:** ` true ` , ` false ` , ` 1 ` , ` 0 ` , ` yes ` , ` no ` , ` on ` , ` off `
7776
7877When enabled, preserves the original SEG-Y textual file header during import.
@@ -83,12 +82,8 @@ $ export MDIO__IMPORT__SAVE_SEGY_FILE_HEADER=true
8382$ mdio segy import input.segy output.mdio --header-locations 189,193
8483```
8584
86- ````
87-
8885### ` MDIO__IMPORT__CLOUD_NATIVE `
8986
90- **Type:** Boolean
91- **Default:** false
9287** Accepted values:** ` true ` , ` false ` , ` 1 ` , ` 0 ` , ` yes ` , ` no ` , ` on ` , ` off `
9388
9489Enables buffered reads during SEG-Y header scans to optimize performance when reading from or
@@ -98,7 +93,7 @@ actual ingestion.
9893
9994``` {note}
10095This variable is designed for cloud storage I/O, regardless of where the compute is running.
101- ````
96+ ```
10297
10398** When to use:**
10499
@@ -119,8 +114,6 @@ $ mdio segy import s3://bucket/input.segy output.mdio --header-locations 189,193
119114
120115### ` MDIO_IGNORE_CHECKS `
121116
122- ** Type:** Boolean
123- ** Default:** false
124117** Accepted values:** ` true ` , ` false ` , ` 1 ` , ` 0 ` , ` yes ` , ` no ` , ` on ` , ` off `
125118
126119Bypasses validation checks during MDIO operations. This is primarily intended for development,
@@ -140,8 +133,6 @@ $ mdio segy import input.segy output.mdio --header-locations 189,193
140133
141134### ` MDIO__IMPORT__RAW_HEADERS `
142135
143- ** Type:** Boolean
144- ** Default:** false
145136** Accepted values:** ` true ` , ` false ` , ` 1 ` , ` 0 ` , ` yes ` , ` no ` , ` on ` , ` off `
146137
147138``` {warning}
0 commit comments