pre-commit

Author: BrianMichell

docs/environment.md

@@ -1,6 +1,6 @@
 # Environment Variables
 
-MDIO can be configured using environment variables to customize behavior for import, export, 
+MDIO can be configured using environment variables to customize behavior for import, export,
 and validation operations. These variables provide runtime control without requiring code changes.
 
 ## CPU and Performance
@@ -10,7 +10,7 @@ and validation operations. These variables provide runtime control without requi
 **Type:** Integer  
 **Default:** Number of logical CPUs available
 
-Controls the number of CPUs used during SEG-Y export operations. Adjust this to balance 
+Controls the number of CPUs used during SEG-Y export operations. Adjust this to balance
 performance with system resource availability.
 
 ```shell
@@ -23,7 +23,7 @@ $ mdio segy export input.mdio output.segy
 **Type:** Integer  
 **Default:** Number of logical CPUs available
 
-Controls the number of CPUs used during SEG-Y import operations. Higher values can 
+Controls the number of CPUs used during SEG-Y import operations. Higher values can
 significantly speed up ingestion of large datasets.
 
 ```shell
@@ -38,8 +38,8 @@ $ mdio segy import input.segy output.mdio --header-locations 189,193
 **Type:** Float  
 **Default:** 2.0
 
-Sparsity ratio threshold that triggers warnings during grid validation. The sparsity ratio 
-measures how sparse the trace grid is compared to a dense grid. Values above this threshold 
+Sparsity ratio threshold that triggers warnings during grid validation. The sparsity ratio
+measures how sparse the trace grid is compared to a dense grid. Values above this threshold
 will log warnings but won't prevent operations.
 
 ```shell
@@ -51,8 +51,8 @@ $ export MDIO__GRID__SPARSITY_RATIO_WARN=3.0
 **Type:** Float  
 **Default:** 10.0
 
-Sparsity ratio threshold that triggers errors and prevents operations. Use this to enforce 
-quality standards and prevent ingestion of excessively sparse datasets that may indicate 
+Sparsity ratio threshold that triggers errors and prevents operations. Use this to enforce
+quality standards and prevent ingestion of excessively sparse datasets that may indicate
 data quality issues.
 
 ```shell
@@ -67,7 +67,7 @@ $ export MDIO__GRID__SPARSITY_RATIO_LIMIT=15.0
 **Default:** false  
 **Accepted values:** `true`, `false`, `1`, `0`, `yes`, `no`, `on`, `off`
 
-When enabled, preserves the original SEG-Y textual file header during import. 
+When enabled, preserves the original SEG-Y textual file header during import.
 This is useful for maintaining full SEG-Y standard compliance and preserving survey metadata.
 
 ```shell
@@ -80,7 +80,7 @@ $ mdio segy import input.segy output.mdio --header-locations 189,193
 **Type:** String (file path)  
 **Default:** None
 
-Path to a custom SEG-Y specification file that defines byte locations and data types for 
+Path to a custom SEG-Y specification file that defines byte locations and data types for
 trace headers. Use this to handle non-standard SEG-Y variants or custom header layouts.
 
 ```shell
@@ -94,20 +94,22 @@ $ mdio segy import input.segy output.mdio --header-locations 189,193
 **Default:** false  
 **Accepted values:** `true`, `false`, `1`, `0`, `yes`, `no`, `on`, `off`
 
-Enables buffered reads during SEG-Y header scans to optimize performance when reading from or 
-writing to cloud object storage (S3, GCS, Azure). This mode balances bandwidth usage with read 
-latency by processing the file twice: first to determine optimal buffering, then to perform the 
+Enables buffered reads during SEG-Y header scans to optimize performance when reading from or
+writing to cloud object storage (S3, GCS, Azure). This mode balances bandwidth usage with read
+latency by processing the file twice: first to determine optimal buffering, then to perform the
 actual ingestion.
 
 ```{note}
 This variable is designed for cloud storage I/O, regardless of where the compute is running.
 ```
 
 **When to use:**
+
 - Reading from cloud storage (e.g., `s3://bucket/input.segy`)
 - Writing to cloud storage (e.g., `gs://bucket/output.mdio`)
 
 **When to skip:**
+
 - Local file paths on fast storage
 - Very slow network connections where bandwidth is the primary bottleneck
 
@@ -124,11 +126,11 @@ $ mdio segy import s3://bucket/input.segy output.mdio --header-locations 189,193
 **Default:** false  
 **Accepted values:** `true`, `false`, `1`, `0`, `yes`, `no`, `on`, `off`
 
-Bypasses validation checks during MDIO operations. This is primarily intended for development, 
+Bypasses validation checks during MDIO operations. This is primarily intended for development,
 testing, or debugging scenarios where you need to work with non-standard data.
 
 ```{warning}
-Disabling checks can lead to corrupted output or unexpected behavior. Only use this 
+Disabling checks can lead to corrupted output or unexpected behavior. Only use this
 when you understand the implications and are working in a controlled environment.
 ```
 
@@ -170,13 +172,15 @@ mdio segy import input.segy output.mdio --header-locations 189,193
 To make environment variables permanent, add them to your shell profile:
 
 **Bash/Zsh:**
+
 ```shell
 # Add to ~/.bashrc or ~/.zshrc
 export MDIO__IMPORT__CPU_COUNT=16
 export MDIO__IMPORT__CLOUD_NATIVE=true
 ```
 
 **Windows:**
+
 ```console
 # Set permanently in PowerShell (run as Administrator)
 [System.Environment]::SetEnvironmentVariable('MDIO__IMPORT__CPU_COUNT', '16', 'User')
@@ -201,4 +205,3 @@ MDIO__IMPORT__CPU_COUNT=16
 MDIO__GRID__SPARSITY_RATIO_LIMIT=15.0
 MDIO__IMPORT__CLOUD_NATIVE=true
 ```
-