From 6cb8344941eb0b988b6d3d9ef25c513617adbe83 Mon Sep 17 00:00:00 2001 From: Takuya Miyashita Date: Wed, 4 Mar 2020 19:02:42 +0900 Subject: [PATCH] update README.md --- README.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 0ca18ff..ebaf97f 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,12 @@ VisClaw.jl is a Julia package of the Clawpack visualization tools (see http://ww This allows to draw figures and animations using the Julia language. Please note that this package is unofficial and the author is not engaged in the Clawpack Development Team. -# Requirements +## Requirements - [Julia](https://github.com/JuliaLang/julia) v1.3.0 or later - [GMT](https://github.com/GenericMappingTools/gmt) (Generic Mapping Tools) -# Installation -- If you want to plot using [GMT.jl](https://github.com/GenericMappingTools/GMT.jl), +## Installation +- If you want to plot using [GMT.jl](https://github.com/GenericMappingTools/GMT.jl), install the [GMT](https://github.com/GenericMappingTools/gmt) in advance. Note that GMT.jl does NOT install the GMT program. @@ -22,7 +22,7 @@ Note that GMT.jl does NOT install the GMT program. pkg> add VisClaw ``` -# Usage +## Usage - In preparation, run some of the Clawpack numerical simulations (e.g., chile2010 `$CLAW/geoclaw/examples/tsunami/chile2010` and ike `$CLAW/geoclaw/examples/storm-surge/ike`). @@ -44,70 +44,70 @@ julia> plt = plotstopo(topo) See [Examples_using_Plots.ipynb](https://github.com/hydrocoast/VisClaw.jl/blob/master/Examples_using_Plots.ipynb) and [Examples_using_GMT.ipynb](https://github.com/hydrocoast/VisClaw.jl/blob/master/Examples_using_GMT.ipynb) for more information. -# Plot gallery +## Plot gallery The following figures are generated with the Julia scripts in `example/` . -## using GMT.jl +### using GMT.jl -### sea surface elevation +#### sea surface elevation

-### topography and bathymetry +#### topography and bathymetry

-### seafloor deformation (dtopo) +#### seafloor deformation (dtopo)

-### wind and pressure fields +#### wind and pressure fields

-## using Plots.jl +### using Plots.jl -### sea surface elevation +#### sea surface elevation

-### flow velocity +#### flow velocity

-### topography and bathymetry +#### topography and bathymetry

-### wave gauge +#### wave gauge

-### fixed grid monitoring (fgmax) +#### fixed grid monitoring (fgmax)

-# License +## License BSD 3-Clause -# Author +## Author [Takuya Miyashita](https://hydrocoast.jp) -Disaster Prevention Research Institute, Kyoto University \ No newline at end of file +Disaster Prevention Research Institute, Kyoto University