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.11.6
- xoa: 0.7.2.dev4+g173a071.d20231107
- appdirs: 1.4.4
- cartopy: 0.22.0
- cmocean: 3.0.3
- configobj: 5.0.8
- matplotlib: 3.8.1
- numpy: 1.24.4
- pandas: 2.1.2
- scipy: 1.11.3
- xarray: 2023.10.1
- xesmf: NOT INSTALLED or UKNOWN

# FILES AND DIRECTORIES
- xoa library dir: /home/docs/checkouts/readthedocs.org/user_builds/xoa/conda/latest/lib/python3.11/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: mercator.cfg hycom.gdp.u.nc argo-7900573.nc hycom.gdp.v.nc gdp-6203641.csv croco.south-africa.surf.nc croco.cfg croco.south-africa.meridional.nc hycom.gdp.h.nc hycom.cfg croco.south-africa.zonal.nc ibi-argo-7900573.nc gdp.cfg argo.cfg
*: file not present

# OPTIONS
[cf] # cf module
cache=boolean(default=True) # 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/latest/lib/python3.11/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: mercator.cfg hycom.gdp.u.nc argo-7900573.nc hycom.gdp.v.nc gdp-6203641.csv croco.south-africa.surf.nc croco.cfg croco.south-africa.meridional.nc hycom.gdp.h.nc hycom.cfg croco.south-africa.zonal.nc ibi-argo-7900573.nc gdp.cfg argo.cfg
*: file not present

xoa reset_cf_cache

usage: xoa reset_cf_cache [-h]