Commandline interface

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

xoa

xoa interface

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

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.14.4
- xoa: 2026.2.1.dev3+g6123990a4.d20260505
- platformdirs: 4.9.6
- cartopy: 0.25.0
- cmocean: 4.0.3
- configobj: 5.0.9
- matplotlib: 3.10.9
- numpy: 2.4.3
- pandas: 3.0.2
- scipy: 1.17.1
- xarray: 2026.4.0

# FILES AND DIRECTORIES
- xoa library dir: /home/docs/checkouts/readthedocs.org/user_builds/xoa/conda/latest/lib/python3.14/site-packages/xoa
- user config file: /home/docs/.config/xoa/xoa.cfg [*]
- user CF specs file: /home/docs/.config/xoa/meta.cfg [*]
- data samples: OBS/ARGO/argo-7900573.nc MODELS/CMEMS-IBI/ibi-argo-7900573.nc MODELS/CROCO/SOUTH-AFRICA/croco.south-africa.meridional.nc MODELS/CROCO/SOUTH-AFRICA/croco.south-africa.surf.nc MODELS/CROCO/SOUTH-AFRICA/croco.south-africa.zonal.nc MODELS/HYCOM/hycom.gdp.h.nc MODELS/HYCOM/hycom.gdp.u.nc MODELS/HYCOM/hycom.gdp.v.nc OBS/DRIFTERS/gdp-6203641.csv
*: file not present

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

[plot] # plot parameters
cmapdiv = string(default="cmo.balance") # default 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/latest/lib/python3.14/site-packages/xoa
- user config file: /home/docs/.config/xoa/xoa.cfg [*]
- user CF specs file: /home/docs/.config/xoa/meta.cfg [*]
- data samples: OBS/ARGO/argo-7900573.nc MODELS/CMEMS-IBI/ibi-argo-7900573.nc MODELS/CROCO/SOUTH-AFRICA/croco.south-africa.meridional.nc MODELS/CROCO/SOUTH-AFRICA/croco.south-africa.surf.nc MODELS/CROCO/SOUTH-AFRICA/croco.south-africa.zonal.nc MODELS/HYCOM/hycom.gdp.h.nc MODELS/HYCOM/hycom.gdp.u.nc MODELS/HYCOM/hycom.gdp.v.nc OBS/DRIFTERS/gdp-6203641.csv
*: file not present