[FEATURE REQUEST] Create a function to print out version numbers of GCPy dependent packages

[yantosca]

Description:

The xarray package contains a function xr.show_versions(), which lists the version numbers of all dependent packages. This can be useful for debugging.

I propose that we make a similar function gcpy.show_versions(). We can ask GCPy users to cut-n-paste us the output of show_versions when they open issues.

[yantosca]

This feature was implemented in d434905.

If you type this:

import gcpy
gcpy.show_versions()

You will get this printout:

INSTALLED VERSIONS
------------------

bottleneck      : 1.2.1
cartopy         : 0.17.0
cython          : 0.29.13
dask            : 2.3.0
esmf            : None
esmpy           : None
graphviz        : 0.10.1
future          : 0.17.1
gcpy            : None
h5netcdf        : 0.6.2
h5py            : 2.8.0
h5pyd           : 0.3.3
IPython         : 7.7.0
jupyter         : None
matplotlib      : 3.1.1
netCDF4         : 1.4.2
notebook        : 6.0.0
numpy           : 1.16.4
pandas          : 0.25.1
pip             : 19.2.2
pycodestyle     : 2.4.0
pyresample      : 1.10.3
pytest          : 4.2.0
python          : 3.6.9
scipy           : 1.3.1
seaborn         : 0.9.0
setuptools      : 41.2.0
six             : 1.12.0
sphinx          : 2.1.2
xbpch           : 0.3.5
xarray          : 0.12.1
xesmf           : None

Or if you do this

import gcpy
a  = gcpy.show_versions(as_json=True)
print(a)

you get a JSON object back, which prints out as this:

{"bottleneck": "1.2.1", "cartopy": "0.17.0", "cython": "0.29.13", "dask": "2.3.0", "esmf": null, "esmpy": null, "graphviz": "0.10.1", "future": "0.17.1", "gcpy": null, "h5netcdf": "0.6.2", "h5py": "2.8.0", "h5pyd": "0.3.3", "IPython": "7.7.0", "jupyter": null, "matplotlib": "3.1.1", "netCDF4": "1.4.2", "notebook": "6.0.0", "numpy": "1.16.4", "pandas": "0.25.1", "pip": "19.2.2", "pycodestyle": "2.4.0", "pyresample": "1.10.3", "pytest": "4.2.0", "python": "3.6.9", "scipy": "1.3.1", "seaborn": "0.9.0", "setuptools": "41.2.0", "six": "1.12.0", "sphinx": "2.1.2", "xbpch": "0.3.5", "xarray": "0.12.1", "xesmf": null}

NOTE: Not all packages have a version number, so those will show up as "None".

This is a nice way of asking people to send us version numbers for support requests.

[JiaweiZhuang]

My fault -- I forgot to define __version__ for xesmf 0.1.1; this is fixed in 0.1.2 and 0.2.0 JiaweiZhuang/xESMF@50477f7

[yantosca]

In commit b059bd2, gcpy.show_versions() now prints out the platform information, as shown below. Also, we suppress printing of packages for which no version information is available:

SYSTEM INFORMATION
------------------
platform        : Linux-3.10.0-957.12.1.el7.x86_64-x86_64-with-centos-7.6.1810-Core
python          : 3.6.9

VERSION NUMBERS FOR GCPy DEPENDENCIES
-------------------------------------

bottleneck      : 1.2.1
cartopy         : 0.17.0
cython          : 0.29.13
dask            : 2.3.0
graphviz        : 0.10.1
future          : 0.17.1
h5netcdf        : 0.6.2
h5py            : 2.8.0
h5pyd           : 0.3.3
IPython         : 7.7.0
matplotlib      : 3.1.1
netCDF4         : 1.4.2
notebook        : 6.0.0
numpy           : 1.16.4
pandas          : 0.25.1
pip             : 19.2.2
pycodestyle     : 2.4.0
pyresample      : 1.10.3
pytest          : 4.2.0
scipy           : 1.3.1
seaborn         : 0.9.0
setuptools      : 41.2.0
six             : 1.12.0
sphinx          : 2.1.2
xbpch           : 0.3.5
xarray          : 0.12.1
xesmf           : 0.2.0