Skip to content

Commit af1aab6

Browse files
Dengda98Dengda98
authored
DOC: update reference to module (#106)
1 parent 4a7688c commit af1aab6

File tree

18 files changed

+221
-172
lines changed

18 files changed

+221
-172
lines changed

‎docs/locales/en/LC_MESSAGES/Advanced/integ_converg/integ_converg.po‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ msgid ""
88
msgstr ""
99
"Project-Id-Version: PyGRT 0.6.1.dev1+g4641a40.d20250422\n"
1010
"Report-Msgid-Bugs-To: \n"
11-
"POT-Creation-Date: 2025-09-22 02:12+0800\n"
11+
"POT-Creation-Date: 2025-09-22 13:40+0800\n"
1212
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
1313
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
1414
"Language: en\n"
@@ -99,9 +99,9 @@ msgstr ""
9999
"provided."
100100

101101
#: ../../source/Advanced/integ_converg/integ_converg.rst:42
102-
msgid ":command:`ker2asc` 模块可将单个核函数文件转为文本格式。"
102+
msgid ":doc:`/Module/ker2asc` 模块可将单个核函数文件转为文本格式。"
103103
msgstr ""
104-
"The :command:`ker2asc` module can convert a single kernel function file "
104+
"The :doc:`/Module/ker2asc` module can convert a single kernel function file "
105105
"into text format."
106106

107107
#: ../../source/Advanced/integ_converg/integ_converg.rst:49
@@ -245,9 +245,11 @@ msgstr ""
245245
"records the peaks and troughs of the integral values."
246246

247247
#: ../../source/Advanced/integ_converg/integ_converg.rst:146
248-
msgid ":command:`ker2asc` 模块也支持将 ``PTAM_{ir}_{dist}/PTAM_{iw}_{freq}`` 文件转为文本格式，"
248+
msgid ""
249+
":doc:`/Module/ker2asc` 模块也支持将 ``PTAM_{ir}_{dist}/PTAM_{iw}_{freq}`` "
250+
"文件转为文本格式，"
249251
msgstr ""
250-
"The :command:`ker2asc` module also supports converting the "
252+
"The :doc:`/Module/ker2asc` module also supports converting the "
251253
"``PTAM_{ir}_{dist}/PTAM_{iw}_{freq}`` file into text format."
252254

253255
#: ../../source/Advanced/integ_converg/integ_converg.rst:158

‎docs/locales/en/LC_MESSAGES/Tutorial/dynamic/gfunc.po‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ msgid ""
88
msgstr ""
99
"Project-Id-Version: PyGRT 0.6.1.dev1+g4641a40.d20250422\n"
1010
"Report-Msgid-Bugs-To: \n"
11-
"POT-Creation-Date: 2025-09-22 02:12+0800\n"
11+
"POT-Creation-Date: 2025-09-22 13:40+0800\n"
1212
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
1313
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
1414
"Language: en\n"
@@ -42,11 +42,11 @@ msgstr ""
4242
#: ../../source/Tutorial/dynamic/gfunc.rst:10
4343
msgid ""
4444
"Python中计算动态格林函数的主函数为 :func:`compute_grn() "
45-
"<pygrt.pymod.PyModel1D.compute_grn>` ，C模块为 :command:`greenfn`。"
45+
"<pygrt.pymod.PyModel1D.compute_grn>` ，C模块为 :doc:`/Module/greenfn`。"
4646
msgstr ""
4747
"The main function for computing dynamic Green's functions in Python is "
4848
":func:`compute_grn() <pygrt.pymod.PyModel1D.compute_grn>`, and the "
49-
"corresponding C module is :command:`greenfn`."
49+
"corresponding C module is :doc:`/Module/greenfn` ."
5050

5151
#: ../../source/Tutorial/dynamic/gfunc.rst:12
5252
msgid ""
@@ -126,9 +126,9 @@ msgstr ""
126126
"travel times."
127127

128128
#: ../../source/Tutorial/dynamic/gfunc.rst:44
129-
msgid ":command:`travt` 模块可以显式地再计算初至波走时，"
129+
msgid ":doc:`/Module/travt` 模块可以显式地再计算初至波走时，"
130130
msgstr ""
131-
"The :command:`travt` module can explicitly recalculate the travel times "
131+
"The :doc:`/Module/travt` module can explicitly recalculate the travel times "
132132
"of the first waves."
133133

134134
#: ../../source/Tutorial/dynamic/gfunc.rst:51
@@ -137,11 +137,11 @@ msgstr "The travel time results will be output to the terminal."
137137

138138
#: ../../source/Tutorial/dynamic/gfunc.rst:56
139139
msgid ""
140-
"如果你没有安装SAC软件，可以使用Python的ObsPy库读取生成的SAC数据，或者使用 :command:`sac2asc` "
140+
"如果你没有安装SAC软件，可以使用Python的ObsPy库读取生成的SAC数据，或者使用 :doc:`/Module/sac2asc` "
141141
"模块临时将SAC格式文件转为如下的文本文件："
142142
msgstr ""
143143
"If you have not installed the SAC software, you can use Python's ObsPy "
144-
"library to read the generated SAC data, or use the :command:`sac2asc` "
144+
"library to read the generated SAC data, or use the :doc:`/Module/sac2asc` "
145145
"module to temporarily convert SAC format files into the following text "
146146
"files:"
147147

‎docs/locales/en/LC_MESSAGES/Tutorial/dynamic/index.po‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ msgid ""
88
msgstr ""
99
"Project-Id-Version: PyGRT 0.10.1.dev40+g32a0bed\n"
1010
"Report-Msgid-Bugs-To: \n"
11-
"POT-Creation-Date: 2025-09-20 11:57+0800\n"
11+
"POT-Creation-Date: 2025-09-22 13:40+0800\n"
1212
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
1313
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
1414
"Language: en\n"
@@ -23,3 +23,15 @@ msgstr ""
2323
msgid "计算动态全波解"
2424
msgstr "Compute Dynamic Full-wave solution"
2525

26+
#: ../../source/Tutorial/dynamic/index.rst:4
27+
msgid "计算 **动态全波解** 的主要计算流程如下："
28+
msgstr "Process diagram"
29+
30+
#: ../../source/Tutorial/dynamic/index.rst:6
31+
msgid "Python"
32+
msgstr ""
33+
34+
#: ../../source/Tutorial/dynamic/index.rst:35
35+
msgid "C (module name)"
36+
msgstr ""
37+

‎docs/locales/en/LC_MESSAGES/Tutorial/dynamic/syn.po‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ msgid ""
88
msgstr ""
99
"Project-Id-Version: PyGRT 0.6.1.dev1+g4641a40.d20250422\n"
1010
"Report-Msgid-Bugs-To: \n"
11-
"POT-Creation-Date: 2025-08-05 13:28+0800\n"
11+
"POT-Creation-Date: 2025-09-22 13:40+0800\n"
1212
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
1313
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
1414
"Language: en\n"
@@ -39,7 +39,7 @@ msgstr ""
3939
msgid "[email protected]"
4040
msgstr ""
4141

42-
#: ../../source/Tutorial/dynamic/syn.rst:11
42+
#: ../../source/Tutorial/dynamic/syn.rst:12
4343
msgid "**震源机制参数中（如单力源、矩张量源）Z轴取向下为正。**"
4444
msgstr ""
4545
"**In the focal mechanism parameters (e.g., single force source, moment "
@@ -48,12 +48,12 @@ msgstr ""
4848
#: ../../source/Tutorial/dynamic/syn.rst:14
4949
msgid ""
5050
"Python中合成动态位移的主函数为 :func:`gen_syn_from_gf_*() "
51-
"<pygrt.utils.gen_syn_from_gf_DC>` （\\*表示对不同震源） ，C模块为 :command:`syn`。"
51+
"<pygrt.utils.gen_syn_from_gf_DC>` （\\*表示对不同震源） ，C模块为 :doc:`/Module/syn`。"
5252
msgstr ""
5353
"The main function in Python for synthesizing dynamic displacements is "
5454
":func:`gen_syn_from_gf_*() <pygrt.utils.gen_syn_from_gf_DC>` (\\* "
5555
"represents different sources), and the corresponding C module is "
56-
":command:`syn`."
56+
":doc:`/Module/syn`."
5757

5858
#: ../../source/Tutorial/dynamic/syn.rst:16
5959
msgid "使用上节计算的格林函数，合成动态位移（理论地震图）。方便起见，这里统一使用milrow模型，震源深度2km，场点位于地表，震中距10km的格林函数，方位角30°。"
@@ -200,13 +200,12 @@ msgstr ""
200200

201201
#: ../../source/Tutorial/dynamic/syn.rst:196
202202
msgid ""
203-
"生成的时间函数会以SAC格式保存在对应路径中，文件名为 :file:`sig.sac`。 其它时间函数以及具体参数用法可使用 "
204-
":command:`grt syn -h` 查看说明。"
203+
"生成的时间函数会以SAC格式保存在对应路径中，文件名为 :file:`sig.sac`。 其它时间函数以及具体参数用法详见 "
204+
":doc:`/Module/syn` 模块。"
205205
msgstr ""
206206
"The generated time function will be saved in SAC format at the "
207207
"corresponding path, with the filename :file:`sig.sac`. For other time "
208-
"functions and specific parameter usage, refer to the instructions using "
209-
":command:`grt syn -h`."
208+
"functions and specific parameter usage, refer to the :doc:`/Module/syn` module. "
210209

211210
#: ../../source/Tutorial/dynamic/syn.rst:205
212211
msgid "其它时间函数以及具体参数用法可在 :py:mod:`pygrt.signals` 模块中查看函数参数。"

‎docs/locales/en/LC_MESSAGES/Tutorial/prepare.po‎

Lines changed: 24 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ msgid ""
88
msgstr ""
99
"Project-Id-Version: PyGRT 0.6.1.dev1+g4641a40.d20250422\n"
1010
"Report-Msgid-Bugs-To: \n"
11-
"POT-Creation-Date: 2025-09-20 11:57+0800\n"
11+
"POT-Creation-Date: 2025-09-22 13:40+0800\n"
1212
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
1313
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
1414
"Language: en\n"
@@ -59,105 +59,75 @@ msgid ""
5959
"程序对多个计算功能使用模块化管理， 可使用类似于以下格式来运行程序。每个模块可使用 ``-h`` 查看帮助。"
6060
msgstr ""
6161
"In addition to Python script execution, PyGRT retains the traditional "
62-
"command-line C program :command:`grt`. Inspired by `GMT <https://www.generic-mapping-tools.org/>`_ , the :command:`grt` program "
63-
"adopts a modular approach for its computational functions and can be executed "
64-
"using a format similar to the following. Each module's help information can "
65-
"be viewed using -h."
62+
"command-line C program :command:`grt`. Inspired by `GMT <https://www"
63+
".generic-mapping-tools.org/>`_ , the :command:`grt` program adopts a "
64+
"modular approach for its computational functions and can be executed "
65+
"using a format similar to the following. Each module's help information "
66+
"can be viewed using -h."
6667

6768
#: ../../source/Tutorial/prepare.rst:20
6869
msgid "**C程序的运行独立于Python，不需要Python环境，从而满足了更多计算场景。**"
6970
msgstr ""
70-
"**The execution of C programs is independent of Python and "
71-
"does not require a Python environment, thus enabling it to meet more computing scenarios.**"
71+
"**The execution of C programs is independent of Python and does not "
72+
"require a Python environment, thus enabling it to meet more computing "
73+
"scenarios.**"
7274

7375
#: ../../source/Tutorial/prepare.rst:22
74-
msgid "计算 **动态解** 的主要计算流程如下："
75-
msgstr ""
76-
"The main computational process for calculating **dynamic solutions** is "
77-
"as follows:"
78-
79-
#: ../../source/Tutorial/prepare.rst:24 ../../source/Tutorial/prepare.rst:125
80-
msgid "Python"
81-
msgstr ""
82-
83-
#: ../../source/Tutorial/prepare.rst:54
84-
msgid "C (module name)"
85-
msgstr ""
86-
87-
#: ../../source/Tutorial/prepare.rst:84
88-
msgid "计算 **静态解** 的过程相同，只是在名称上有如下区别："
89-
msgstr ""
90-
"The process for calculating **static solutions** is the same, only the "
91-
"function names and program names differ."
92-
93-
#: ../../source/Tutorial/prepare.rst:86
94-
msgid ""
95-
"Python 函数名称增加 \"static\\_\" ，例如 :func:`compute_static_grn() "
96-
"<pygrt.pymod.PyModel1D.compute_static_grn>` 。"
97-
msgstr ""
98-
"Add \"static\\_\" in Python function names, e.g. :func:`compute_static_grn() <pygrt.pymod.PyModel1D.compute_static_grn>`."
99-
100-
#: ../../source/Tutorial/prepare.rst:87
101-
msgid ""
102-
"C 程序模块名增加 \"static\\_\" 前缀，例如 :command:`static_greenfn` ；或者在 "
103-
":command:`grt` 与无 \"static\\_\" 前缀的模块名之间增加 \"static\" 命令， 即支持以下两种方式（以 "
104-
":command:`greenfn` 模块为例）："
105-
msgstr ""
106-
"Add \"static\\_\" at the beginning of C module names, e.g. :command:`static_greenfn` ;"
107-
"or replace the underline to a backspace, like the following."
108-
109-
#: ../../source/Tutorial/prepare.rst:97
11076
msgid ""
11177
"入门部分包含一些示例与说明，可快速上手。Github主页的 :rst:dir:`example/` 文件夹中有更多示例，可在 `Github "
11278
"Releases <https://github.com/Dengda98/PyGRT/releases>`_ 中下载。"
11379
msgstr ""
11480
"The following are some simple tutorials to help you get started quickly. "
11581
"More examples can be found in the :rst:dir:`example/` folder on the "
11682
"Github homepage, which can be downloaded from `Github Releases "
117-
"<https://github.com/Dengda98/PyGRT/releases>`_.
83+
"<https://github.com/Dengda98/PyGRT/releases>`_"
11884

119-
#: ../../source/Tutorial/prepare.rst:101
85+
#: ../../source/Tutorial/prepare.rst:26
12086
msgid "建立模型文件"
12187
msgstr "Create model file"
12288

123-
#: ../../source/Tutorial/prepare.rst:106
89+
#: ../../source/Tutorial/prepare.rst:31
12490
msgid "这里的选项卡 **C** 不代表内部是C语言代码，而是 **使用C程序** :command:`grt` 。后续的选项卡沿用此设定，不再解释。"
12591
msgstr ""
12692
"The tab **C** here does not represent C language code inside, but rather "
12793
"**an executable program :command:`grt` compiled using the C language** . "
12894
"Subsequent tabs follow this convention and will not be explained further."
12995

130-
#: ../../source/Tutorial/prepare.rst:110
96+
#: ../../source/Tutorial/prepare.rst:35
13197
msgid "C"
13298
msgstr ""
13399

134-
#: ../../source/Tutorial/prepare.rst:112
100+
#: ../../source/Tutorial/prepare.rst:37
135101
msgid "**PyGRT** 以如下自由格式定义模型中每层的物性参数，每列之间以空格隔开（最后两列的 Qp, Qs 可省略）"
136102
msgstr ""
137103
"**PyGRT** defines the physical parameters of each layer in the model "
138-
"using the following free format, with columns separated by spaces."
139-
"(The values of Qp and Qs in the last two columns can be omitted.)"
104+
"using the following free format, with columns separated by spaces.(The "
105+
"values of Qp and Qs in the last two columns can be omitted.)"
140106

141-
#: ../../source/Tutorial/prepare.rst:119
107+
#: ../../source/Tutorial/prepare.rst:44
142108
msgid "例如 :file:`milrow` 模型（假设文本文件名为 `milrow` ）"
143109
msgstr ""
144110
"For example, the :file:`milrow` model (assuming the text file is named "
145111
"`milrow`)."
146112

147-
#: ../../source/Tutorial/prepare.rst:127
113+
#: ../../source/Tutorial/prepare.rst:50
114+
msgid "Python"
115+
msgstr ""
116+
117+
#: ../../source/Tutorial/prepare.rst:52
148118
msgid "模型格式与C一致，在Python中可以使用 :code:`np.loadtxt()` 导入文本文件，或者手动定义数组"
149119
msgstr ""
150120
"The model format is consistent with C, and in Python, you can use "
151121
":code:`np.loadtxt()` to import the text file or manually define the "
152122
"array."
153123

154-
#: ../../source/Tutorial/prepare.rst:137
124+
#: ../../source/Tutorial/prepare.rst:62
155125
msgid "最后一行表示半空间，对应厚度值不会被使用。"
156126
msgstr ""
157127
"The last line represents the half-space, and the corresponding thickness "
158128
"value will not be used."
159129

160-
#: ../../source/Tutorial/prepare.rst:141
130+
#: ../../source/Tutorial/prepare.rst:66
161131
msgid "Vs 设置为 0 表示该层为液体层。"
162132
msgstr "Setting Vs to 0 indicates that this layer is a liquid layer."
163133

‎docs/locales/en/LC_MESSAGES/Tutorial/static/index.po‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ msgid ""
88
msgstr ""
99
"Project-Id-Version: PyGRT 0.10.1.dev40+g32a0bed\n"
1010
"Report-Msgid-Bugs-To: \n"
11-
"POT-Creation-Date: 2025-09-20 11:57+0800\n"
11+
"POT-Creation-Date: 2025-09-22 13:40+0800\n"
1212
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
1313
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
1414
"Language: en\n"
@@ -23,3 +23,15 @@ msgstr ""
2323
msgid "计算静态位移"
2424
msgstr "Compute Static Displacement"
2525

26+
#: ../../source/Tutorial/static/index.rst:4
27+
msgid "计算 **静态位移** 的主要计算流程如下："
28+
msgstr "Process diagram"
29+
30+
#: ../../source/Tutorial/static/index.rst:6
31+
msgid "Python"
32+
msgstr ""
33+
34+
#: ../../source/Tutorial/static/index.rst:35
35+
msgid "C (module name)"
36+
msgstr ""
37+

‎docs/locales/en/LC_MESSAGES/Tutorial/static/static_gfunc.po‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ msgid ""
88
msgstr ""
99
"Project-Id-Version: PyGRT 0.6.1.dev1+g4641a40.d20250422\n"
1010
"Report-Msgid-Bugs-To: \n"
11-
"POT-Creation-Date: 2025-09-20 11:57+0800\n"
11+
"POT-Creation-Date: 2025-09-22 13:40+0800\n"
1212
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
1313
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
1414
"Language: en\n"
@@ -43,11 +43,11 @@ msgstr ""
4343
msgid ""
4444
"Python中计算静态格林函数的主函数为 :func:`compute_static_grn() "
4545
"<pygrt.pymod.PyModel1D.compute_static_grn>` ，C模块为 "
46-
":command:`static_greenfn`。"
46+
":doc:`/Module/static_greenfn`。"
4747
msgstr ""
4848
"The main function for computing static Green's functions in Python is "
4949
":func:`compute_static_grn() <pygrt.pymod.PyModel1D.compute_static_grn>`, "
50-
"and the corresponding C module is :command:`static_greenfn`."
50+
"and the corresponding C module is :doc:`/Module/static_greenfn`."
5151

5252
#: ../../source/Tutorial/static/static_gfunc.rst:11
5353
msgid ""
@@ -83,9 +83,10 @@ msgid ""
8383
"结果输出为 `NetCDF <https://zh.wikipedia.org/wiki/NetCDF>`_ 网格格式，方便使用 GMT "
8484
"等软件处理和绘制。 如下使用 ``ncdump -h`` 命令可查看网格文件基本信息。"
8585
msgstr ""
86-
"The output is in the `NetCDF <https://zh.wikipedia.org/wiki/NetCDF>`_ grid format, "
87-
"which is convenient for processing and plotting with software such as GMT. "
88-
"The basic information of the grid file can be viewed by using the command ``ncdump -h`` ."
86+
"The output is in the `NetCDF <https://zh.wikipedia.org/wiki/NetCDF>`_ "
87+
"grid format, which is convenient for processing and plotting with "
88+
"software such as GMT. The basic information of the grid file can be "
89+
"viewed by using the command ``ncdump -h`` ."
8990

9091
#: ../../source/Tutorial/static/static_gfunc.rst:35
9192
msgid "Python"

‎docs/locales/en/LC_MESSAGES/Tutorial/static/static_syn.po‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ msgid ""
88
msgstr ""
99
"Project-Id-Version: PyGRT 0.6.1.dev1+g4641a40.d20250422\n"
1010
"Report-Msgid-Bugs-To: \n"
11-
"POT-Creation-Date: 2025-09-20 11:57+0800\n"
11+
"POT-Creation-Date: 2025-09-22 13:40+0800\n"
1212
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
1313
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
1414
"Language: en\n"
@@ -43,12 +43,12 @@ msgstr ""
4343
msgid ""
4444
"Python中合成静态位移的主函数为 :func:`gen_syn_from_gf_*() "
4545
"<pygrt.utils.gen_syn_from_gf_DC>` （\\*表示对不同震源）（与合成动态位移的函数共用） ，C模块为 "
46-
":command:`static_syn`。"
46+
":doc:`/Module/static_syn`。"
4747
msgstr ""
4848
"The main function in Python for synthesizing static displacements is "
4949
":func:`gen_syn_from_gf_*() <pygrt.utils.gen_syn_from_gf_DC>` (\\* "
5050
"represents different sources) (same as the dynamic case), and the "
51-
"corresponding C module is :command:`static_syn`."
51+
"corresponding C module is :doc:`/Module/static_syn`."
5252

5353
#: ../../source/Tutorial/static/static_syn.rst:11
5454
msgid "使用上节计算的格林函数，合成静态位移。为方便画图，以下结果都使用ZNE分量。"
@@ -66,8 +66,9 @@ msgid ""
6666
"以下绘图使用 `GMT <https://www.generic-mapping-tools.org/>`_ 绘制。这里提供计算和绘图的 "
6767
"Python 脚本和 Shell 脚本供下载参考。"
6868
msgstr ""
69-
"The following plots are drawn using `GMT <https://www.generic-mapping-tools.org/>`_ 。 "
70-
"Here provide the Python and Shell scripts of computing and drawing for reference."
69+
"The following plots are drawn using `GMT <https://www.generic-mapping-"
70+
"tools.org/>`_ 。 Here provide the Python and Shell scripts of computing "
71+
"and drawing for reference."
7172

7273
#: ../../source/Tutorial/static/static_syn.rst:17
7374
msgid ":download:`Shell Scripts <run/run.sh>`"

0 commit comments

Comments
 (0)