Skip to content

Commit e876f2b

Browse files
committed
marsfiles help fixes
1 parent 5644e83 commit e876f2b

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

bin/MarsFiles.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ def wrapper(*args, **kwargs):
171171
parser.add_argument('-bin', '--bin_files', nargs='+', type=str,
172172
choices=['fixed', 'diurn', 'average', 'daily'],
173173
help=(
174-
f"Produce MGCM ``fixed``, ``diurn``, ``average`` and ``daily`` "
174+
f"Produce MGCM 'fixed', 'diurn', 'average' and 'daily' "
175175
f"files from Legacy output:\n"
176176
f" - ``fixed`` : static fields (e.g., topography)\n"
177177
f" - ``daily`` : instantaneous data\n"
@@ -193,10 +193,10 @@ def wrapper(*args, **kwargs):
193193
f"00334.atmos_average.nc 00668.atmos_average.nc\n"
194194
f"> MarsFiles *.atmos_average.nc -c\n"
195195
f"{Blue}Overwrites 00334.atmos_average.nc with concatenated "
196-
f"files:\n"
196+
f"files:{Green}\n"
197197
f"> ls\n"
198198
f" 00334.atmos_average.nc\n"
199-
f"{Blue}To preserve original files, use [-ext --extension]:"
199+
f"{Yellow}To preserve original files, use [-ext --extension]:"
200200
f"{Green}\n"
201201
f"> MarsFiles *.atmos_average.nc -c -ext _concatenated\n"
202202
f"{Blue}Produces 00334.atmos_average_concatenated.nc and "
@@ -215,7 +215,7 @@ def wrapper(*args, **kwargs):
215215
f"-dim.\nIf a file contains multiple Mars Years of data, the "
216216
f"function splits the file in the first Mars Year.\n"
217217
f"{Green}Example:\n"
218-
f"> MarsFiles 01336.atmos_average.nc --split 0 90"
218+
f"> MarsFiles 01336.atmos_average.nc --split 0 90\n"
219219
f"> MarsFiles 01336.atmos_average.nc --split 270\n"
220220
f"{Yellow}Use -dim to specify the dimension:{Green}\n"
221221
f"> MarsFiles 01336.atmos_average.nc --split 0 90 -dim lat"
@@ -307,7 +307,7 @@ def wrapper(*args, **kwargs):
307307
f"to add the original linear trend to the amplitudes \n"
308308
f"\n{Yellow}Generates a new file ending in ``_lpt.nc``\n"
309309
f"{Green}Example:\n"
310-
f"> MarsFiles 01336.atmos_daily.nc -lpt 0.5\n"
310+
f"> MarsFiles 01336.atmos_daily.nc -lpt 0.75\n"
311311
f"{Nclr}\n\n"
312312
)
313313
)
@@ -318,13 +318,13 @@ def wrapper(*args, **kwargs):
318318
nargs="+", type=float,
319319
help=(
320320
f"Temporal band-pass filtering"
321-
f"specified by user.\nOnly works with 'daily' or 'average' files. Requires two "
322-
f"cutoff frequencies in Sols.\n"
321+
f"specified by user.\nOnly works with 'daily' or 'average' "
322+
f"files. Requires two cutoff frequencies in Sols.\n"
323323
f"Data is detrended before filtering. Use ``--add_trend`` \n"
324324
f"to add the original linear trend to the amplitudes \n"
325325
f"\n{Yellow}Generates a new file ending in ``bpt.nc``\n"
326326
f"{Green}Example:\n"
327-
f"> MarsFiles 01336.atmos_daily.nc -hpt 0.5 10.\n"
327+
f"> MarsFiles 01336.atmos_daily.nc -bpt 0.75 10.\n"
328328
f"{Nclr}\n\n"
329329
)
330330
)
@@ -463,15 +463,15 @@ def wrapper(*args, **kwargs):
463463
parser=parser,
464464
nargs=0,
465465
help=(
466-
f"Return filtered oscillation amplitudes with the linear trend added."
467-
f"(Fast Fourier transform natively eliminate affine Y = at + b )\n"
466+
f"Return filtered oscillation amplitudes with the linear trend "
467+
f"added. Works with 'daily' and 'average' files.\n"
468468
f"For use with temporal filtering utilities (``-lpt``, "
469469
f"``-hpt``, ``-bpt``).\n"
470470
f"{Yellow}Generates a new file ending in ``_trended.nc``\n"
471471
f"{Green}Example:\n"
472472
f"> MarsFiles 01336.atmos_daily.nc -hpt 10. -add_trend\n"
473-
f"> MarsFiles 01336.atmos_daily.nc -lpt 0.5 -add_trend\n"
474-
f"> MarsFiles 01336.atmos_daily.nc -hpt 0.5 10. -add_trend"
473+
f"> MarsFiles 01336.atmos_daily.nc -lpt 0.75 -add_trend\n"
474+
f"> MarsFiles 01336.atmos_daily.nc -bpt 0.75 10. -add_trend"
475475
f"{Nclr}\n\n"
476476
)
477477
)

0 commit comments

Comments
 (0)