diff --git a/doc/install.rst b/doc/install.rst index 83378100034..180b4d019fc 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -273,3 +273,17 @@ For Windows, add the ``GMT_LIBRARY_PATH`` environment variable following these and set its value to a path like:: C:\Users\USERNAME\Anaconda3\envs\pygmt\Library\bin\ + +Notes for Jupyter users +----------------------- + +If you can successfully import pygmt in a Python interpreter or IPython, but +get a ``ModuleNotFoundError`` when importing pygmt in Jupyter, you may need to +install a ``pygmt`` kernel following the commands below:: + + conda activate pygmt + python -m ipykernel install --user --name pygmt # install conda environment properly + jupyter kernelspec list --json + +After that, you need to restart Jupyter, open your notebook, select the +``pygmt`` kernel and then import pygmt.