Skip to content

Commit 4811741

Browse files
committed
update CLI usage doc and refine SEG-Y command examples
1 parent 2b4747c commit 4811741

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

docs/cli_usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ get information about usage.
223223
.. typer:: mdio.cli:app
224224
:prog: mdio
225225
:theme: monokai
226-
:width: 90
226+
:width: 100
227227
:show-nested:
228228
:make-sections:
229229
```

src/mdio/commands/segy.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -193,17 +193,18 @@ def segy_import( # noqa: PLR0913
193193
) -> None:
194194
"""Convert a SEG-Y file into an MDIO dataset.
195195
196+
\b
196197
In non-interactive mode you must provide both --mdio-template and --segy-spec.
197198
Use --interactive to be guided through selecting a template and building a SEG-Y spec.
198199
199200
\b
200201
Examples:
201202
- Non-interactive (local files):
202-
mdio segy import input.segy output.mdio --mdio-template PostStack3DTime --segy-spec segy_spec.json
203-
- Overwrite existing output:
204-
mdio segy import input.segy output.mdio --mdio-template PostStack3DDepth --segy-spec segy_spec.json --overwrite
203+
mdio segy import in.segy out.mdio --mdio-template PostStack3DTime --segy-spec spec.json
204+
- Overwrite existing output with interactive template with spec:
205+
mdio segy import in.segy out.mdio --segy-spec spec.json --overwrite
205206
- Interactive (prompts for template and spec):
206-
mdio segy import input.segy output.mdio --interactive
207+
mdio segy import in.segy out.mdio --interactive
207208
208209
\b
209210
Notes:
@@ -283,11 +284,12 @@ def segy_export( # noqa: PLR0913
283284
) -> None:
284285
"""Export an MDIO dataset to SEG-Y.
285286
287+
\b
286288
Status: not yet implemented. This command currently raises NotImplementedError.
287289
288290
\b
289291
Example (will error until implemented):
290-
- mdio segy export input.mdio output.segy --segy-spec segy_spec.json
292+
- mdio segy export in.mdio out.segy --segy-spec spec.json
291293
"""
292294
if storage_input is not None:
293295
input_path = UPath(input_path, storage_options=storage_input)

0 commit comments

Comments
 (0)