From b022da4b6105ae9a3dfd798ffa2b501451ba244e Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Thu, 6 Jun 2024 20:58:35 +0800 Subject: [PATCH] doc: Add a single introduction page (#8515) --- doc/rst/source/index.rst | 1 + doc/rst/source/{tutorial/bash => }/intro.rst | 12 ------ doc/rst/source/tutorial/bash/index.rst | 10 ++++- doc/rst/source/tutorial/julia/index.rst | 14 ++++++- doc/rst/source/tutorial/julia/intro.rst | 40 -------------------- 5 files changed, 23 insertions(+), 54 deletions(-) rename doc/rst/source/{tutorial/bash => }/intro.rst (78%) delete mode 100644 doc/rst/source/tutorial/julia/intro.rst diff --git a/doc/rst/source/index.rst b/doc/rst/source/index.rst index 16ef6bfba28..9659557dbce 100644 --- a/doc/rst/source/index.rst +++ b/doc/rst/source/index.rst @@ -37,6 +37,7 @@ it can do. :maxdepth: 1 :caption: Getting started + intro install gallery animations diff --git a/doc/rst/source/tutorial/bash/intro.rst b/doc/rst/source/intro.rst similarity index 78% rename from doc/rst/source/tutorial/bash/intro.rst rename to doc/rst/source/intro.rst index 522e5a8d073..ed1ab07abed 100644 --- a/doc/rst/source/tutorial/bash/intro.rst +++ b/doc/rst/source/intro.rst @@ -35,15 +35,3 @@ maximize flexibility. We standardized early on to use PostScript output instead of other graphics formats. Apart from the built-in support for coastlines, GMT completely decouples data retrieval from the main GMT modules. GMT uses architecture-independent file formats. - -GMT installation considerations -------------------------------- - -See the :doc:`install guide ` -for instructions and to make sure you have all required dependencies installed. -Alternatively, you can build GMT from source by following the -`building guide `_. - -In addition, we recommend access to any flavor of the UNIX operating system -(UNIX, Linux, macOS, Cygwin, MinGW, etc.). -We do not recommend using the DOS command window under Windows. diff --git a/doc/rst/source/tutorial/bash/index.rst b/doc/rst/source/tutorial/bash/index.rst index e38191d3993..778d2f833ea 100644 --- a/doc/rst/source/tutorial/bash/index.rst +++ b/doc/rst/source/tutorial/bash/index.rst @@ -33,6 +33,15 @@ sufficient detail. Nevertheless, it is hoped that the exposure will prompt the users to improve their GMT and UNIX skills after completion of this short tutorial. +See the :doc:`install guide ` +for instructions and to make sure you have all required dependencies installed. +Alternatively, you can build GMT from source by following the +`building guide `_. + +In addition, we recommend access to any flavor of the UNIX operating system +(UNIX, Linux, macOS, Cygwin, MinGW, etc.). +We do not recommend using the DOS command window under Windows. + .. note:: This tutorial is for GMT 6 modern mode only. Looking for the classic mode tutorial? Since classic mode commands haven't changed since GMT 5, please visit @@ -41,7 +50,6 @@ after completion of this short tutorial. .. toctree:: :maxdepth: 1 - intro session-1 session-2 session-3 diff --git a/doc/rst/source/tutorial/julia/index.rst b/doc/rst/source/tutorial/julia/index.rst index 0c7738f29a9..10890b9104d 100644 --- a/doc/rst/source/tutorial/julia/index.rst +++ b/doc/rst/source/tutorial/julia/index.rst @@ -25,10 +25,22 @@ still redirect to the hard-core GMT man pages, whilst others direct users to Jul the translated GMT manuals. A *lost case* is the GMT Technical Reference that is so big/complete that it will take long time to see a Julia version of it. +See the :doc:`install guide ` +for instructions and to make sure you have all required dependencies installed. +Alternatively, you can build GMT from source by following the +`building guide `_. + +See also the general information about `Julia `_ +as well as the introduction to the Julia wrapper at +`Introduction `_ +and the very recommendable +`Quick Learn `_. +Complement with the instructions on how to +install `GMT.jl `_ + .. toctree:: :maxdepth: 1 - intro session-1 session-2 session-3 diff --git a/doc/rst/source/tutorial/julia/intro.rst b/doc/rst/source/tutorial/julia/intro.rst deleted file mode 100644 index dbd02bac639..00000000000 --- a/doc/rst/source/tutorial/julia/intro.rst +++ /dev/null @@ -1,40 +0,0 @@ -Introduction -============ - -Historical highlights ---------------------- - -The GMT system was initiated in late 1987 at Lamont-Doherty Earth Observatory, Columbia University by graduate students -Paul Wessel and Walter H. F. Smith. Version 1 was officially introduced to Lamont scientists in July 1988. GMT 1 -migrated by word of mouth (and tape) to other institutions in the United States, UK, Japan, and France and attracted -a small following. Paul took a Post-doctoral position at SOEST in December 1989 and continued the GMT development. -Version 2.0 was released with an article in EOS, October 1991, and quickly spread worldwide. Version 3.0 in 1993 -which was released with another article in EOS on August 15, 1995. A major upgrade to GMT 4.0 took place in Oct 2004. -Finally, in 2013 we released the new GMT 5 series and we have updated this tutorial to reflect the changes in style -and syntax. However, GMT 5 is generally backwards compatible with GMT 4 syntax. In October 2019 we released the current -version GMT 6. GMT is used by tens of thousands of users worldwide in a broad range of disciplines. - -Philosophy ----------- - -GMT is written in the ANSI C programming language (very portable), is POSIX compliant, and is independent of hardware -constraints (e.g., memory). GMT was deliberately written for command-line usage, not a windows environment, in order -to maximize flexibility. We standardized early on to use PostScript output instead of other graphics formats. Apart -from the built-in support for coastlines, GMT completely decouples data retrieval from the main GMT modules. GMT uses -architecture-independent file formats. - -GMT installation considerations -------------------------------- - -See the :doc:`install guide ` -for instructions and to make sure you have all required dependencies installed. -Alternatively, you can build GMT from source by following the -`building guide `_. - -See also the general information about `Julia `_ -as well as the introduction to the Julia wrapper at -`Introduction `_ -and the very recommendable -`Quick Learn `_. -Complement with the instructions on how to -install `GMT.jl `_