Commandline interface

Commandline interface#

xoa comes with an executable script with the same name. Here is its help.

xoa#

xoa interface

usage: xoa [-h] {info,reset_cf_cache} ...

xoa info#

usage: xoa info [-h] [{all,paths,versions,options}]

Positional Arguments#

category

Possible choices: all, paths, versions, options

info category

Default: 'all'

Examples#

Print all info:

$ xoa info
# VERSIONS
- python: 3.13.3
- xoa: 0.8.1.dev0+g6f2b11f.d20250512
- platformdirs: 4.3.8
- cartopy: 0.24.0
- cmocean: 4.0.3
- configobj: 5.0.9
- matplotlib: 3.10.3
- numpy: 2.2.5
- pandas: 2.2.3
- scipy: 1.15.3
- xarray: 2025.4.0
- xesmf: NOT INSTALLED or UKNOWN

# FILES AND DIRECTORIES
- xoa library dir: /home/docs/checkouts/readthedocs.org/user_builds/xoa/conda/stable/lib/python3.13/site-packages/xoa
- user config file: /home/docs/.config/xoa/xoa.cfg [*]
- user CF specs file: /home/docs/.config/xoa/cf.cfg [*]
- user CF cache file: /home/docs/.cache/xoa/cf.pyk
- data samples: hycom.gdp.v.nc hycom.gdp.h.nc gdp-6203641.csv croco.south-africa.zonal.nc argo-7900573.nc croco.south-africa.surf.nc ibi-argo-7900573.nc __pycache__ hycom.gdp.u.nc croco.south-africa.meridional.nc
*: file not present

# OPTIONS
[cf] # cf module
cache=boolean(default=False) # use the :mod:`~xoa.cf` in memory and file caches

[plot] # plot parameters
cmapdiv = string(default="cmo.balance") # defaut diverging colormap
cmappos = string(default="cmo.amp")     # default positive colormap
cmapneg = string(default="cmo.tempo_r") # default negative colormap
cmapcyc = string(default="cmo.phase")   # default cyclic colormap

Print only info about paths:

$ xoa info paths
- xoa library dir: /home/docs/checkouts/readthedocs.org/user_builds/xoa/conda/stable/lib/python3.13/site-packages/xoa
- user config file: /home/docs/.config/xoa/xoa.cfg [*]
- user CF specs file: /home/docs/.config/xoa/cf.cfg [*]
- user CF cache file: /home/docs/.cache/xoa/cf.pyk
- data samples: hycom.gdp.v.nc hycom.gdp.h.nc gdp-6203641.csv croco.south-africa.zonal.nc argo-7900573.nc croco.south-africa.surf.nc ibi-argo-7900573.nc __pycache__ hycom.gdp.u.nc croco.south-africa.meridional.nc
*: file not present

xoa reset_cf_cache#

usage: xoa reset_cf_cache [-h]
Contents