Skip to content

Commit

Permalink
Add GMT description
Browse files Browse the repository at this point in the history
  • Loading branch information
joa-quim committed Nov 3, 2017
1 parent a23e0f9 commit afc3a15
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,21 @@ Julia wrapper for the Generic Mapping Tools [GMT](http://gmt.soest.hawaii.edu)
[pkg-0.7-img]: http://pkg.julialang.org/badges/GMT_0.7.svg
[pkg-0.7-url]: http://pkg.julialang.org/?pkg=GMT&ver=0.7

The Generic Mapping Tools, **GMT**, is an open source collection of tools for manipulating geographic
and Cartesian data sets (including filtering, trend fitting, gridding, projecting, etc.) and producing
PostScript illustrations ranging from simple x–y plots via contour maps to artificially illuminated
surfaces and 3D perspective views.

This wrapper works only with GMT5.3.1 and above

Install
=======

Pkg.add("GMT")

On OSX, with a manual GMT build and dependencies obtained with Homebrew (that are installed at /user/local/lib), I had to help
Julia finding MY *libgmt.dylib*, with (this line should than be added to the ~/.juliarc.jl file)
On OSX, with a manual GMT build and dependencies obtained with Homebrew (that are installed at
/user/local/lib), I had to help Julia finding MY *libgmt.dylib*, with (this line should than be
added to the ~/.juliarc.jl file)

push!(Libdl.DL_LOAD_PATH, "/Users/j/programs/gmt5/lib")

Expand All @@ -55,11 +61,11 @@ However, we also acknowledge that not every one is comfortable with the *GMT* sy
needed to accommodate the immense pool of options that let you control all details of a figure but that
also makes it harder to read/master.

To make life easier for simple plots we provide also a more limited sub-set of commands that use the *GMT*
module name directly and where the image details are set via keyword arguments. While the monolotic way
of using this package is robust and keeps being updated to latestes *GMT* developments, this *By modules*
alternative is a very Work In Progress and many things may not work yet. So all help is most than
wellcome.
To make life easier for simple plots we provide also a more limited sub-set of commands that use the
**GMT** module name directly and where the image details are set via keyword arguments. While the
monolotic way of using this package is robust and keeps being updated to latestes **GMT** developments,
this *By modules* alternative is a very Work In Progress and many things may not work yet. So all help is
most than wellcome.

Documentation
=============
Expand Down

0 comments on commit afc3a15

Please sign in to comment.