From 6bbae579ff5bcd5e74a3fc9a1d09f467bd1e8d61 Mon Sep 17 00:00:00 2001 From: yvonnefroelich Date: Sat, 9 Sep 2023 22:16:27 +0200 Subject: [PATCH 1/2] Expand README for 'Intro to PyGMT' --- examples/get_started/01_first_figure.py | 13 ++----------- examples/get_started/README.txt | 22 ++++++++++++---------- 2 files changed, 14 insertions(+), 21 deletions(-) diff --git a/examples/get_started/01_first_figure.py b/examples/get_started/01_first_figure.py index a21310c403d..50cd21c9057 100644 --- a/examples/get_started/01_first_figure.py +++ b/examples/get_started/01_first_figure.py @@ -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 # ------------------- diff --git a/examples/get_started/README.txt b/examples/get_started/README.txt index a56cd35a0bc..75df9641cbe 100644 --- a/examples/get_started/README.txt +++ b/examples/get_started/README.txt @@ -1,17 +1,19 @@ 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 `. A quick way to test this is to type -``import pygmt`` in a Python IDE or -`Jupyter `__ Notebook. +It is assumed that PyGMT has been successfully :doc:`installed ` +on your system. To test this, run ``import pygmt`` in a Python IDE or +`Jupyter `__ 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. +PyGMT can be used in both a Python script and a notebook environment, such +as Jupyter. The recommended method for these tutorials is to use a notebook, +as the code is set up for a notebook environment. +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. From e2ca44ab742622866a4a3024b9f6a6ae5c407acf Mon Sep 17 00:00:00 2001 From: yvonnefroelich Date: Mon, 11 Sep 2023 09:27:22 +0200 Subject: [PATCH 2/2] Remove note regarding JN usage --- examples/get_started/README.txt | 4 ---- 1 file changed, 4 deletions(-) diff --git a/examples/get_started/README.txt b/examples/get_started/README.txt index 75df9641cbe..95363dcd2e4 100644 --- a/examples/get_started/README.txt +++ b/examples/get_started/README.txt @@ -10,10 +10,6 @@ It is assumed that PyGMT has been successfully :doc:`installed ` on your system. To test this, run ``import pygmt`` in a Python IDE or `Jupyter `__ notebook. -PyGMT can be used in both a Python script and a notebook environment, such -as Jupyter. The recommended method for these tutorials is to use a notebook, -as the code is set up for a notebook environment. - 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.