Commandline interface¶
xoa comes with an executable script with the same name. Here is its help.
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.9.2
- xoa: 0.2.1.dev0+g79a7c82.d20210415
- appdirs: 1.4.4
- cartopy: 0.18.0
- cmocean: 2.0
- configobj: 5.0.6
- matplotlib: 3.4.1
- numpy: 1.20.2
- pandas: 1.2.4
- scipy: 1.6.2
- xarray: 0.17.0
- xesmf: 0.5.3
# FILES AND DIRECTORIES
- xoa library dir: /home/docs/checkouts/readthedocs.org/user_builds/xoa/conda/v0.2.0/lib/python3.9/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.u.nc hycom.gdp.v.nc gdp-6203641.csv croco.cfg gdp.cfg hycom.cfg croco.south-africa.zonal.nc croco.south-africa.surf.nc hycom.gdp.h.nc croco.south-africa.meridional.nc
*: file not present
# OPTIONS
[cf] # cf module
accessors=boolean(default=True) # automatically load the :mod:`~xoa.cf` accessors?
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/v0.2.0/lib/python3.9/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.u.nc hycom.gdp.v.nc gdp-6203641.csv croco.cfg gdp.cfg hycom.cfg croco.south-africa.zonal.nc croco.south-africa.surf.nc hycom.gdp.h.nc croco.south-africa.meridional.nc
*: file not present
xoa reset_cf_cache¶
usage: xoa reset_cf_cache [-h]