Skip to content

Commit 43e67d9

Browse files
committed
rename config and add reference to Pydantic Settings object
1 parent ec3d061 commit 43e67d9

File tree

2 files changed

+27
-12
lines changed

2 files changed

+27
-12
lines changed

docs/environment.md renamed to docs/configuration.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1-
# Environment Variables
1+
```{eval-rst}
2+
:tocdepth: 3
3+
```
4+
5+
```{currentModule} mdio.core.config
6+
7+
```
8+
9+
# Configuration
210

311
MDIO can be configured using environment variables to customize behavior for import, export,
412
and validation operations. These variables provide runtime control without requiring code changes.
@@ -7,7 +15,7 @@ and validation operations. These variables provide runtime control without requi
715

816
### `MDIO__EXPORT__CPU_COUNT`
917

10-
**Type:** Integer
18+
**Type:** Integer
1119
**Default:** Number of logical CPUs available
1220

1321
Controls the number of CPUs used during SEG-Y export operations. Adjust this to balance
@@ -20,7 +28,7 @@ $ mdio segy export input.mdio output.segy
2028

2129
### `MDIO__IMPORT__CPU_COUNT`
2230

23-
**Type:** Integer
31+
**Type:** Integer
2432
**Default:** Number of logical CPUs available
2533

2634
Controls the number of CPUs used during SEG-Y import operations. Higher values can
@@ -35,7 +43,7 @@ $ mdio segy import input.segy output.mdio --header-locations 189,193
3543

3644
### `MDIO__GRID__SPARSITY_RATIO_WARN`
3745

38-
**Type:** Float
46+
**Type:** Float
3947
**Default:** 2.0
4048

4149
Sparsity ratio threshold that triggers warnings during grid validation. The sparsity ratio
@@ -48,7 +56,7 @@ $ export MDIO__GRID__SPARSITY_RATIO_WARN=3.0
4856

4957
### `MDIO__GRID__SPARSITY_RATIO_LIMIT`
5058

51-
**Type:** Float
59+
**Type:** Float
5260
**Default:** 10.0
5361

5462
Sparsity ratio threshold that triggers errors and prevents operations. Use this to enforce
@@ -63,8 +71,8 @@ $ export MDIO__GRID__SPARSITY_RATIO_LIMIT=15.0
6371

6472
### `MDIO__IMPORT__SAVE_SEGY_FILE_HEADER`
6573

66-
**Type:** Boolean
67-
**Default:** false
74+
**Type:** Boolean
75+
**Default:** false
6876
**Accepted values:** `true`, `false`, `1`, `0`, `yes`, `no`, `on`, `off`
6977

7078
When enabled, preserves the original SEG-Y textual file header during import.
@@ -111,8 +119,8 @@ $ mdio segy import s3://bucket/input.segy output.mdio --header-locations 189,193
111119

112120
### `MDIO_IGNORE_CHECKS`
113121

114-
**Type:** Boolean
115-
**Default:** false
122+
**Type:** Boolean
123+
**Default:** false
116124
**Accepted values:** `true`, `false`, `1`, `0`, `yes`, `no`, `on`, `off`
117125

118126
Bypasses validation checks during MDIO operations. This is primarily intended for development,
@@ -132,8 +140,8 @@ $ mdio segy import input.segy output.mdio --header-locations 189,193
132140

133141
### `MDIO__IMPORT__RAW_HEADERS`
134142

135-
**Type:** Boolean
136-
**Default:** false
143+
**Type:** Boolean
144+
**Default:** false
137145
**Accepted values:** `true`, `false`, `1`, `0`, `yes`, `no`, `on`, `off`
138146

139147
```{warning}
@@ -194,3 +202,10 @@ MDIO__IMPORT__CPU_COUNT=16
194202
MDIO__GRID__SPARSITY_RATIO_LIMIT=15.0
195203
MDIO__IMPORT__CLOUD_NATIVE=true
196204
```
205+
206+
## Reference
207+
208+
```{eval-rst}
209+
.. autopydantic_model:: MDIOSettings
210+
:inherited-members: BaseSettings
211+
```

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ end-before: <!-- github-only -->
1616
1717
installation
1818
cli_usage
19-
environment
19+
configuration
2020
```
2121

2222
```{toctree}

0 commit comments

Comments
 (0)