Troubleshooting๏ƒ

Common issues encountered when using GWexpy and their solutions.

Start Here๏ƒ

Use this page as a reverse lookup by symptom:

  • Install worked for the minimal example, but you now need NDS2 / FrameLIB / other binary dependencies: go back to the Installation Guide.

  • The first example from Quickstart does not import or plot cleanly: check the matching issue below, then retry the quick example.

  • The environment feels mixed or broken after repeated pip and Conda changes: rebuild the dedicated Conda environment from the Installation Guide.

Installation Issues๏ƒ

1. Cannot install nds2 / framel๏ƒ

Binary libraries used in the [gw] extra cannot be installed via pip.

Solution: Use Conda (Miniforge, etc.) in a dedicated environment, then install GWexpy from source there.

conda create -n gwexpy python=3.11
conda activate gwexpy
conda install -c conda-forge python-nds2-client python-framel ldas-tools-framecpp
pip install "gwexpy[gw,analysis,fitting] @ git+https://github.com/tatsuki-washimi/gwexpy.git"

See also: Installation Guide

2. Errors on Apple Silicon (M1/M2/M3) Mac๏ƒ

Some GW analysis packages may be built for Intel (x86_64) and might not work out of the box.

Solution: Native (arm64) support for packages from the conda-forge channel is improving. Always ensure you are using the latest versions.

conda update -c conda-forge --all

3. Compilation error for minepy (MIC calculation)๏ƒ

pip install minepy may fail due to C extension compilation issues.

Solution: Run the automated build script included in the repository.

python scripts/install_minepy.py

If this happened while expanding a minimal install, review the extras guidance in the Installation Guide.

Plotting & Visualization Issues๏ƒ

4. Plots not displaying / Tcl_AsyncDelete error๏ƒ

There may be an inconsistency with the Matplotlib backend in Jupyter Notebook or GUI applications.

Solution: Try explicitly specifying the backend:

import matplotlib
matplotlib.use('Qt5Agg')  # or 'Agg', 'TkAgg'

5. Map (GeoMap) not displaying๏ƒ

Verify the installation status of pygmt and ensure the GMT (Generic Mapping Tools) binary is in your path.

Solution: We recommend reinstalling pygmt via Conda.

conda install -c conda-forge pygmt

If you started from the smallest example in Quickstart, note that pygmt is optional and is not part of the minimal source install.

Still Not Working?๏ƒ

Please report the issue with the error logs on the GitHub Issues page. Including the following information will help us assist you faster:

  • OS Version

  • Python Version

  • The command executed and the full Traceback