Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update README for the "Intro to PyGMT" #2678

Merged
merged 4 commits into from
Sep 12, 2023
Merged

Update README for the "Intro to PyGMT" #2678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6bbae57
Expand README for 'Intro to PyGMT'
yvonnefroehlich Sep 9, 2023
8b7dcc8
Merge branch 'main' into update-intro-readme
yvonnefroehlich Sep 10, 2023
e2ca44a
Remove note regarding JN usage
yvonnefroehlich Sep 11, 2023
cdf3515
Merge branch 'main' into update-intro-readme
yvonnefroehlich Sep 11, 2023
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
13 changes: 2 additions & 11 deletions examples/get_started/01_first_figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,12 @@
1. Making your first figure
===========================

This tutorial page covers the basics of creating a figure using PyGMT - a
This tutorial covers the basics of creating a figure using PyGMT - a
Python wrapper for the Generic Mapping Tools (GMT). It will only use
the :meth:`pygmt.Figure.coast` method for plotting. Later examples will
the :meth:`pygmt.Figure.coast` method for plotting. Later tutorials will
address other PyGMT methods.
"""

# %%
# Setting up the development environment
# --------------------------------------
#
# PyGMT can be used in both a Python script and a notebook environment, such
# as Jupyter. The tutorial's recommended method is to use a notebook, and the
# code will be for a notebook environment.


# %%
# Loading the library
# -------------------
Expand Down
20 changes: 9 additions & 11 deletions examples/get_started/README.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
Intro to PyGMT
==============

Welcome to PyGMT! This tutorial is designed to teach the basic concepts to
make a map in PyGMT.
Welcome to PyGMT! The tutorials in this intro are designed to teach basic
concepts to create maps in PyGMT.

**About this tutorial**
**About this intro**

This tutorial assumes that PyGMT has been successfully
:doc:`installed </install>`. A quick way to test this is to type
``import pygmt`` in a Python IDE or
`Jupyter <https://jupyter.org>`__ Notebook.

This tutorial will progressively cover PyGMT plotting concepts, and later
examples will use concepts explained in previous examples. It will not
cover all PyGMT methods.
It is assumed that PyGMT has been successfully :doc:`installed </install>`
on your system. To test this, run ``import pygmt`` in a Python IDE or
`Jupyter <https://jupyter.org>`__ notebook.

This intro will progressively cover PyGMT data manipulation and plotting
concepts, and later tutorials will use concepts explained in previous ones.
It will not cover all PyGMT functions and methods.