Git Product home page Git Product logo

gmt_docs's Introduction

GMT 中文手册

All Contributors

Deploy Documentation version Repository size License: CC BY-NC 4.0

在线阅读 | PDF 下载 | 文档源码 | GMT 中文社区 | GMT 官方网站 | GMT 官方文档 | GMT 官方论坛

GMT/China logo

欢迎来到 Generic Mapping Tools (GMT) 的世界。 GMT 是地球科学使用最广泛的制图软件之一。

本文档是由 GMT 中文社区 维护整理的 GMT 中文手册。 手册详尽地介绍了 GMT 的用法并提供了大量的实用示例。 其既可以作为初学者的入门读物,也可以作为日常使用的参考书。

文档维护

本文档尚有很多不完善之处,欢迎 GMT 用户参与到 GMT 中文手册的维护与更新之中。 详情见贡献指南

一个人可以走得很快,但是一群人却可以走得更远。

许可协议

本作品采用知识共享署名-非商业性使用 4.0 国际许可协议。 任何人都可以自由地分享、修改本作品,但必须遵循如下条件:

  • 署名:必须提到原作者,提供指向此许可协议的链接,表明是否有做修改
  • 非商业性使用:不能对本作品进行任何形式的商业性使用

贡献者 ✨

GMT 中文手册由以下贡献者维护:

Dongdong Tian
Dongdong Tian

🤔 🚧 🐛 📖 💡 👀 🔣 🎨
Xiaohan Chen
Xiaohan Chen

🐛 📖 💡 👀 📹
Yao Jiayuan
Yao Jiayuan

🐛 🔣 📖 🎨 🤔 👀
Mao Zhou
Mao Zhou

📖 👀 💡 🤔 🐛
王亮
王亮

💡 🤔 📖 👀
sqdeng
sqdeng

💡
liuzhumei
liuzhumei

🐛 💡
赵志远
赵志远

🐛
Xiao Xiao
Xiao Xiao

💡
Fei Chen
Fei Chen

🐛
Tche LIU
Tche LIU

🐛
lxrat
lxrat

🐛
Liming Li
Liming Li

📖
Xiao-Le Deng
Xiao-Le Deng

🐛
dihuizhe
dihuizhe

🐛
Yuechu Wu
Yuechu Wu

📖
H.F.
H.F.

🐛
Bojun
Bojun

🐛

不同的 Emoji 所代表的贡献类型如下表所示:

Emoji 类型 说明
🐛 bug 报告 Bug
🔣 data 整理数据
📖 doc 撰写文档
🎨 design 网页设计
💡 example 增添示例
🤔 ideas 建议与想法
🚧 maintenance 底层维护
👀 review 审核文档
📹 video 录制视频教程

gmt_docs's People

Contributors

allcontributors[bot] avatar berginjay avatar core-man avatar covmat avatar cugliming avatar dependabot[bot] avatar dihuizhe avatar jiangxl avatar liuzhumei avatar lxrat avatar ohaiyofei avatar seisman avatar seispiano avatar seispider avatar sqdeng avatar tchel avatar wangliang1989 avatar xiaoledeng avatar zhaozhiyuan1989 avatar zmalt avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

gmt_docs's Issues

确定GMT文档的发布方式

  1. 文档如何发布?
  2. 发布的HTML版和PDF版文档如何提供下载链接?
  3. 旧版本的HTML和PDF如何处理?

自定义sphinx的LaTeX模板

  1. sphinx自带的模板比较符合英文的书籍,对于中文并不特别合适
  2. 由于Python2的中文编码问题,latex_elements中的preamble中若含有中文,则需要使用类似ur'''xxx'''的语法,似乎Python2不支持
  3. 自定义的模板可以更符合项目的需求

将所有示例中的中文字体编号修改为中文字体名

需要注意:

Linux和macOS下字体名为:

39 STSong-Light-UniGB-UTF8-H
40 STFangsong-Light-UniGB-UTF8-H
41 STHeiti-Regular-UniGB-UTF8-H
42 STKaiti-Regular-UniGB-UTF8-H

Windows下字体名为:

39 STSong-Light-GB-EUC-H
40 STFangsong-Light-GB-EUC-H
41 STHeiti-Regular-GB-EUC-H
42 STKaiti-Regular-GB-EUC-H

Histogram Gallery

#125 adds some histogram plots to gallery. However, the horizontal histogram example doesn't work for GMT 6.0.0.

示例测试工具

目前文档中有很多示例,某些示例是以脚本的形式给出的,这种示例可以直接运行以进行测试。而某些示例是直接以单行代码的形式出现在文档中的,这些示例在最初是经过测试的,但是一旦GMT版本有更新,这些示例能否正常运行则无法确认。

两种解决办法:

  1. 所有示例均写到脚本中,不管是一行还是两行
  2. 写一个单独的脚本,搜索文档中的所有示例,然后依次执行这些示例

重命名脚本和图片

source/scripts 目录下几乎所有脚本的文件名都是以 GMT_ 开头,这是完全没有必要的,可以全部重命名,删除开头的 GMT_。由于脚本生成的图片要与脚本同名,所以,脚本内部的图片名也需要修改。同时 rst 文件中插入脚本及图片的地方也需要修改。

  • 重命名所有脚本
  • 重命名所有图片
  • 更正正文中的脚本和图片名

GMT中文支持可移植性测试

需要测试在不同机器下的可移植性。

  1. 已经支持GMT中文的Linux机器
  2. 尚未支持GMT中文的Linux机器
  3. 已经支持GMT中文的Windows机器
  4. 尚未支持GMT中文的Windows机器
  5. 已经支持GMT中文的macOS机器
  6. 尚未支持GMT中文的macOS机器

需要做如下测试:

  1. gs是否可以正常查看PS文件
  2. 系统常用PDF阅读器是否可以正常查看PS文件
  3. Windows下Adobe Illustrator是否能够正常打开PDF文件

鉴于需要测试的情况较多,可以考虑在将带有中文的PS、PDF文件上传到群中,由大家帮助测试。

投影方式

  1. 介绍如何选择投影方式
  2. 整理各个投影方式的说明文档

macOS下homebrew安装GMT的方法需要更新

  1. gmt已经从homebrew/science中移到了 homebrew/core 中
  2. homebrew的gmt4和gmt不再存在冲突,但安装两个之后只能使用GMT5版本
  3. 是否可能修改gmt的formulae使得其安装时支持额外的选项

GMT6待完善列表

这里是文档更新到 GMT6 的待完善列表。需要在6正式发布后,6版本的文档最终发布前,最后写的内容列举如下:

修改所有图片的宽度

目前源码中指定的是图片的绝对大小,例如 900px,这样做在生成PDF时会有较多问题,应改为相对大小,比如 90%

整理**构造线

  • 联系数据发布者,确认是否可以公开以及是否有数据来源(比如从哪篇文章中的图数字化得到)
  • 整理数据,删除不需要的部分,修改使之符号GMT要求
  • 数据段中加入地块名称信息,使得数据本身更加完整
  • 写脚本展示其用法,以及绘图效果
  • 写博文

安装教程的完善

目前,安装教程还不够完整,至少缺乏以下三点:
1.构建 GMT 数据库的指引
2. 常见问题的预防针(紫斑兔用户的阅读器显示倒转等问题)
3. Mac 的中文支持

对于以上三点,我目前只掌握 Linux 系统的数据库构建 http://seisman.info/gmt-setup-database.html
Mac 的中文支持最近会研究。

我已經开了新分支fixinstall

change modules' names for gmt6

need to change modules' names for @gmt6.

All works about it please try to merge into #82

  • psxy => plot
  • psxyz => plot3d
  • psscale => colorbar
  • pscoast => coast
  • psconvert
  • ps2raster
  • pssolar
  • psbasemap
  • psclip
  • pshistogram
  • pstext
  • pslegend
  • psrose
  • pssac
  • psmeca
  • pspolar
  • psvelo
  • pscoupe
  • psimage
  • pscontour
  • pssegy
  • pssegyz
  • pswiggle

文档多版本问题

在GMT6发布之后,将会有若干年的时间存在GMT5和GMT6共存的情况,这涉及到文档的多版本问题。可能的处理方式列举如下。

只保留GMT6最新版

此做法比较激进,GMT_docs, GMT_modules, gmt-china.org 三者均完全使用 GMT6 的最新语法。此做法也是最为简单的办法。

保留GMT5和GMT6两个版本

保留多个版本有两个方式:

  1. 多repo,GMT5和GMT6分别位于不同的repo,问题在于需要同时维护两个版本的文档,较为复杂;
  2. 多分支,GMT6位于master分支,GMT5位于gmt5分支;

保留多个版本后需要考虑的主要问题有两点:

  1. 如何同时维护两个版本的文档;
  2. 两个版本或多个版本如何设置网址;

关于网址的几种选择:

  1. GMT6使用docs.gmt-china.org;GMT5使用某个任意网址,例如 gmt5-docs.gmt-china.org
  2. 统一使用 docs.gmt-china.org,链接风格为 docs.gmt-china.org/VERSION/xxx,其中VERSION 可以取 5.4.3, 6.0.0, latest 或者为空,其中 VERSION 取 latest 或空都指向最新版本的文档。其效果类似于 READTHEDOCS这个网站提供的 http://gmt-docs.readthedocs.io/zh_CN/latest/ http://gmt-docs.readthedocs.io/zh_CN/5.3.3/ ,唯一的区别在于链接中没有语言 zh_CN 的信息

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.