Skip to content

Remove Jupyter Notebook notes from tutorials #1199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions examples/tutorials/3d_perspective_image.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,6 @@

Create 3-D perspective image or surface mesh from a grid
using :meth:`pygmt.Figure.grdview`.

.. note::

This tutorial assumes the use of a Python notebook, such as IPython or Jupyter Notebook.
To see the figures while using a Python script instead, use
``fig.show(method="external")`` to display the figure in the default PDF viewer.

To save the figure, use ``fig.savefig("figname.pdf")`` where ``"figname.pdf"``
is the desired name and file extension for the saved figure.
"""
# sphinx_gallery_thumbnail_number = 4

Expand Down
9 changes: 0 additions & 9 deletions examples/tutorials/coastlines.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,6 @@
======================

Plotting coastlines and borders is handled by :meth:`pygmt.Figure.coast`.

.. note::

This tutorial assumes the use of a Python notebook, such as IPython or Jupyter Notebook.
To see the figures while using a Python script instead, use
``fig.show(method="external")`` to display the figure in the default PDF viewer.

To save the figure, use ``fig.savefig("figname.pdf")`` where ``"figname.pdf"``
is the desired name and file extension for the saved figure.
"""
# sphinx_gallery_thumbnail_number = 5

Expand Down
9 changes: 0 additions & 9 deletions examples/tutorials/configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,6 @@
==========================

Default GMT parameters can be set globally or locally using :class:`pygmt.config`.

.. note::

This tutorial assumes the use of a Python notebook, such as IPython or Jupyter Notebook.
To see the figures while using a Python script instead, use
``fig.show(method="external")`` to display the figure in the default PDF viewer.

To save the figure, use ``fig.savefig("figname.pdf")`` where ``"figname.pdf"``
is the desired name and file extension for the saved figure.
"""
# sphinx_gallery_thumbnail_number = 3

Expand Down
9 changes: 0 additions & 9 deletions examples/tutorials/contour_map.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,6 @@
=================================

Plotting a contour map is handled by :meth:`pygmt.Figure.grdcontour`.

.. note::

This tutorial assumes the use of a Python notebook, such as IPython or Jupyter Notebook.
To see the figures while using a Python script instead, use
``fig.show(method="external")`` to display the figure in the default PDF viewer.

To save the figure, use ``fig.savefig("figname.pdf")`` where ``"figname.pdf"``
is the desired name and file extension for the saved figure.
"""
# sphinx_gallery_thumbnail_number = 5

Expand Down
9 changes: 0 additions & 9 deletions examples/tutorials/earth_relief.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,6 @@
Plotting a map of Earth relief can use the data accessed by the
:meth:`pygmt.datasets.load_earth_relief` method. The data can then be plotted using the
:meth:`pygmt.Figure.grdimage` method.

.. note::

This tutorial assumes the use of a Python notebook, such as IPython or Jupyter Notebook.
To see the figures while using a Python script instead, use
``fig.show(method="external")`` to display the figure in the default PDF viewer.

To save the figure, use ``fig.savefig("figname.pdf")`` where ``"figname.pdf"``
is the desired name and file extension for the saved figure.
"""
# sphinx_gallery_thumbnail_number = 5

Expand Down
10 changes: 0 additions & 10 deletions examples/tutorials/first_figure.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,6 @@

Welcome to PyGMT! Here we'll cover some of basic concepts, like creating simple figures
and naming conventions.

.. note::

This tutorial assumes the use of a Python notebook, such as `IPython <https://ipython.org/>`__
or `JupyterLab <https://jupyter.org/>`__.
To see the figures while using a Python script instead, use
``fig.show(method="external")`` to display the figure in the default PDF viewer.

To save the figure, use ``fig.savefig("figname.pdf")`` where ``"figname.pdf"``
is the desired name and file extension for the saved figure.
"""

########################################################################################
Expand Down
9 changes: 0 additions & 9 deletions examples/tutorials/frames.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,6 @@

Setting the style of the map frames, ticks, etc, is handled by the ``frame`` parameter
that all plotting methods of :class:`pygmt.Figure`.

.. note::

This tutorial assumes the use of a Python notebook, such as IPython or Jupyter Notebook.
To see the figures while using a Python script instead, use
``fig.show(method="external")`` to display the figure in the default PDF viewer.

To save the figure, use ``fig.savefig("figname.pdf")`` where ``"figname.pdf"``
is the desired name and file extension for the saved figure.
"""
# sphinx_gallery_thumbnail_number = 4

Expand Down
9 changes: 0 additions & 9 deletions examples/tutorials/insets.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,6 @@
:meth:`pygmt.Figure.inset` method. After a large figure has been created,
call ``inset`` using a ``with`` statement, and new plot elements will be
added to the inset figure instead of the larger figure.

.. note::

This tutorial assumes the use of a Python notebook, such as IPython or Jupyter Notebook.
To see the figures while using a Python script instead, use
``fig.show(method="external")`` to display the figure in the default PDF viewer.

To save the figure, use ``fig.savefig("figname.pdf")`` where ``"figname.pdf"``
is the desired name and file extension for the saved figure.
"""
# sphinx_gallery_thumbnail_number = 4

Expand Down
9 changes: 0 additions & 9 deletions examples/tutorials/lines.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,6 @@
==============

Plotting lines is handled by :meth:`pygmt.Figure.plot`.

.. note::

This tutorial assumes the use of a Python notebook, such as IPython or Jupyter Notebook.
To see the figures while using a Python script instead, use
``fig.show(method="external")`` to display the figure in the default PDF viewer.

To save the figure, use ``fig.savefig("figname.pdf")`` where ``"figname.pdf"``
is the desired name and file extension for the saved figure.
"""
# sphinx_gallery_thumbnail_number = 3

Expand Down
9 changes: 0 additions & 9 deletions examples/tutorials/plot.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,6 @@
:mod:`pygmt.datasets` package. If you don't have the data files already, they are
automatically downloaded and saved to a cache directory the first time you use them
(usually ``~/.gmt/cache``).

.. note::

This tutorial assumes the use of a Python notebook, such as IPython or Jupyter Notebook.
To see the figures while using a Python script instead, use
``fig.show(method="external")`` to display the figure in the default PDF viewer.

To save the figure, use ``fig.savefig("figname.pdf")`` where ``"figname.pdf"``
is the desired name and file extension for the saved figure.
"""
# sphinx_gallery_thumbnail_number = 3

Expand Down
9 changes: 0 additions & 9 deletions examples/tutorials/regions.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,6 @@
Many of the plotting functions take the ``region`` parameter, which sets
the area that will be shown in the figure. This tutorial covers the different types of
inputs that it can accept.

.. note::

This tutorial assumes the use of a Python notebook, such as IPython or Jupyter Notebook.
To see the figures while using a Python script instead, use
``fig.show(method="external")`` to display the figure in the default PDF viewer.

To save the figure, use ``fig.savefig("figname.pdf")`` where ``"figname.pdf"``
is the desired name and file extension for the saved figure.
"""

import pygmt
Expand Down
9 changes: 0 additions & 9 deletions examples/tutorials/text.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,6 @@

It is often useful to add annotations to a map plot. This is handled by
:meth:`pygmt.Figure.text`.

.. note::

This tutorial assumes the use of a Python notebook, such as IPython or Jupyter Notebook.
To see the figures while using a Python script instead, use
``fig.show(method="external")`` to display the figure in the default PDF viewer.

To save the figure, use ``fig.savefig("figname.pdf")`` where ``"figname.pdf"``
is the desired name and file extension for the saved figure.
"""
# sphinx_gallery_thumbnail_number = 3

Expand Down
9 changes: 0 additions & 9 deletions examples/tutorials/vectors.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,6 @@
================

Plotting vectors is handled by :meth:`pygmt.Figure.plot`.

.. note::

This tutorial assumes the use of a Python notebook, such as IPython or Jupyter Notebook.
To see the figures while using a Python script instead, use
``fig.show(method="external")`` to display the figure in the default PDF viewer.

To save the figure, use ``fig.savefig("figname.pdf")`` where ``"figname.pdf"``
is the desired name and file extension for the saved figure.
"""
# sphinx_gallery_thumbnail_number = 6

Expand Down