"""
PyGMT is a library for processing geospatial and geophysical data and making
publication-quality maps and figures. It provides a Pythonic interface for the
Generic Mapping Tools (GMT), a command-line program widely used across the
Earth, Ocean, and Planetary sciences and beyond. Besides making GMT more
accessible to new users, PyGMT aims to provide integration with the PyData
ecosystem as well as support for rich display in Jupyter notebooks.
Main Features
-------------
Here are just a few of the things that PyGMT does well:
- Easy handling of individual types of data like Cartesian, geographic, or
time-series data.
- Processing of (geo)spatial data including gridding, filtering, and masking.
- Plotting of a large spectrum of objects on figures including
lines, vectors, polygons, and symbols (pre-defined and customized).
- Generating publication-quality illustrations and making animations.
"""
import atexit as _atexit
import sys
from importlib.metadata import version
from pygmt import clib
# Get semantic version through setuptools-scm
__version__ = f'v{version("pygmt")}' # e.g. v0.1.2.dev3+g0ab3cd78
__commit__ = __version__.split("+g")[-1] if "+g" in __version__ else "" # 0ab3cd78
with clib.Session() as lib:
__gmt_version__ = lib.info["version"]
# Import modules to make the high-level GMT Python API
from pygmt import datasets
from pygmt.accessors import GMTDataArrayAccessor
from pygmt.figure import Figure, set_display
from pygmt.io import load_dataarray
from pygmt.session_management import begin as _begin
from pygmt.session_management import end as _end
from pygmt.src import (
binstats,
blockmean,
blockmedian,
blockmode,
config,
dimfilter,
filter1d,
grd2cpt,
grd2xyz,
grdclip,
grdcut,
grdfill,
grdfilter,
grdgradient,
grdhisteq,
grdinfo,
grdlandmask,
grdproject,
grdsample,
grdtrack,
grdvolume,
info,
makecpt,
nearneighbor,
project,
select,
sph2grd,
sphdistance,
sphinterpolate,
surface,
triangulate,
which,
x2sys_cross,
x2sys_init,
xyz2grd,
)
# Start our global modern mode session
_begin()
# Tell Python to run _end when shutting down
_atexit.register(_end)
[docs]def print_clib_info(file=sys.stdout):
"""
Print information about the GMT shared library that we can find.
Includes the GMT version, default values for parameters, the path to the
``libgmt`` shared library, and GMT directories.
"""
from pygmt.clib import Session # pylint: disable=import-outside-toplevel
lines = ["GMT library information:"]
with Session() as ses:
for key in sorted(ses.info):
lines.append(f" {key}: {ses.info[key]}")
print("\n".join(lines), file=file)
[docs]def show_versions(file=sys.stdout):
"""
Print various dependency versions which are useful when submitting bug
reports.
This includes information about:
- PyGMT itself
- System information (Python version, Operating System)
- Core dependency versions (NumPy, Pandas, Xarray, etc)
- GMT library information
"""
# pylint: disable=import-outside-toplevel
import importlib
import platform
import subprocess
def _get_module_version(modname):
"""
Get version information of a Python module.
"""
try:
if modname in sys.modules:
module = sys.modules[modname]
else:
module = importlib.import_module(modname)
try:
return module.__version__
except AttributeError:
return module.version
except ImportError:
return None
def _get_ghostscript_version():
"""
Get ghostscript version.
"""
os_name = sys.platform
if os_name.startswith(("linux", "freebsd", "darwin")):
cmds = ["gs"]
elif os_name == "win32":
cmds = ["gswin64c.exe", "gswin32c.exe"]
else:
return None
for gs_cmd in cmds:
try:
return subprocess.check_output(
[gs_cmd, "--version"], universal_newlines=True
).strip()
except FileNotFoundError:
continue
return None
sys_info = {
"python": sys.version.replace("\n", " "),
"executable": sys.executable,
"machine": platform.platform(),
}
deps = [
"numpy",
"pandas",
"xarray",
"netCDF4",
"packaging",
"contextily",
"geopandas",
"IPython",
"rioxarray",
]
print("PyGMT information:", file=file)
print(f" version: {__version__}", file=file)
print("System information:", file=file)
for key, val in sys_info.items():
print(f" {key}: {val}", file=file)
print("Dependency information:", file=file)
for modname in deps:
print(f" {modname}: {_get_module_version(modname)}", file=file)
print(f" ghostscript: {_get_ghostscript_version()}", file=file)
print_clib_info(file=file)