Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
62d3f3f
add starter-tutorial.rst as intro for tutorial
willschlitzer Nov 5, 2021
ef4d987
update doc/conf.py to fix merge conflicts
willschlitzer Nov 15, 2021
8f5c49c
merge main branch changes
willschlitzer Nov 15, 2021
41814f3
update conf.py for starer tutorials folder
willschlitzer Nov 15, 2021
3661ada
Apply suggestions from code review
willschlitzer Nov 16, 2021
5605b9d
moving tutorial files
willschlitzer Nov 16, 2021
793b555
update conf.py
willschlitzer Nov 16, 2021
77799f0
add starter tutorial files to gitignore
willschlitzer Nov 16, 2021
1ab117c
add starter tutorials to Makefile
willschlitzer Nov 16, 2021
962d05d
run make fomrat
willschlitzer Nov 16, 2021
a9441a2
add into to README.txt
willschlitzer Nov 17, 2021
d6e7c1e
remove sub-sections in intro
willschlitzer Nov 17, 2021
943c51f
update docstrings
willschlitzer Nov 17, 2021
016b7f7
update the first figure plotted
willschlitzer Nov 17, 2021
33fb360
update coordinates in first figure example
willschlitzer Nov 17, 2021
473a63b
add external display parameter explanation
willschlitzer Nov 17, 2021
bd99bcf
style fix
willschlitzer Nov 17, 2021
cf98638
format fix
willschlitzer Nov 17, 2021
9131163
add projection settings
willschlitzer Nov 17, 2021
b9aa8d6
removing figure saving from tutorial
willschlitzer Nov 17, 2021
03bc80a
wording update
willschlitzer Nov 18, 2021
3c53e55
add frame section
willschlitzer Nov 18, 2021
c880bd7
add additional exercises
willschlitzer Nov 18, 2021
b89e708
format fix
willschlitzer Nov 18, 2021
ae030ba
specify sphinx gallery image
willschlitzer Nov 18, 2021
0e8efcb
Apply suggestions from code review
willschlitzer Nov 19, 2021
af13124
remove "About PyGMT" section from starter tutorial
willschlitzer Dec 4, 2021
416175b
rename starter tutorial
willschlitzer Dec 6, 2021
3be0dca
rename starter tutorial folder
willschlitzer Dec 6, 2021
3479d32
update Makefile with new tutorial folder name
willschlitzer Dec 6, 2021
94b9976
update gitignore with new tutorial folder name
willschlitzer Dec 6, 2021
cd7f278
update index with new tutorial folder name
willschlitzer Dec 6, 2021
748c12b
update folder name
willschlitzer Dec 6, 2021
c02cdaf
fix link
willschlitzer Dec 6, 2021
b792c6c
Apply suggestions from code review
willschlitzer Dec 8, 2021
9604d7f
Apply suggestions from code review
willschlitzer Dec 11, 2021
b1e3b5e
update additional exercises
willschlitzer Dec 11, 2021
7fe3ee1
style fix
willschlitzer Dec 11, 2021
1f3a071
Merge branch 'main' into tutorial/starter-tutorial
willschlitzer Dec 11, 2021
380d4af
Merge branch 'main' into tutorial/starter-tutorial
willschlitzer Dec 14, 2021
e90bc27
Apply suggestions from code review
willschlitzer Dec 14, 2021
64dfe0a
change frame argument
willschlitzer Dec 14, 2021
3ae1a1e
run make format
willschlitzer Dec 14, 2021
75fb36c
format lines
willschlitzer Dec 14, 2021
a4a417c
Merge branch 'main' into tutorial/starter-tutorial
michaelgrund Dec 15, 2021
7c1ffec
Apply suggestions from code review
willschlitzer Dec 16, 2021
2024b6c
remove mention of using external method for show
willschlitzer Dec 16, 2021
f912e75
changing frame settings
willschlitzer Dec 16, 2021
dfc996d
change ISO code description
willschlitzer Dec 16, 2021
892a14c
format fix
willschlitzer Dec 16, 2021
3ce6a71
Apply suggestions from code review
willschlitzer Dec 17, 2021
237e141
update README
willschlitzer Dec 17, 2021
9f5568f
add link to Jupyter notebook
willschlitzer Dec 17, 2021
5910c38
update install link
willschlitzer Dec 19, 2021
894a1cd
Merge branch 'main' into tutorial/starter-tutorial
willschlitzer Dec 19, 2021
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
1 change: 1 addition & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@
"../examples/projections/table",
"../examples/tutorials/basics",
"../examples/tutorials/advanced",
"../examples/tutorials/starter-tutorials",
]
),
# Patter to search for example files
Expand Down
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

overview.rst
install.rst
tutorials/basics/first_figure.rst
tutorials/starter-tutorial.rst

.. toctree::
:maxdepth: 2
Expand Down
21 changes: 21 additions & 0 deletions examples/tutorials/starter-tutorial.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Starter Tutorial
================

Welcome to PyGMT! This tutorial is designed to teach the basic concepts to
make a map in PyGMT.

About this tutorial
-------------------

This tutorial assumes that PyGMT has been successfully installed. A quick
way to test this is to type ``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 modules.

.. toctree::
:maxdepth: 1

starter-tutorials/first_figure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
Making your first figure
========================

Welcome to PyGMT! Here we'll cover some of basic concepts, like creating simple
figures and naming conventions.
Here is how to plot your first figure.
"""

###############################################################################
Expand Down