diff --git a/docs/source/Tutorial/dynamic/index.rst b/docs/source/Tutorial/dynamic/index.rst new file mode 100644 index 00000000..b34beaca --- /dev/null +++ b/docs/source/Tutorial/dynamic/index.rst @@ -0,0 +1,9 @@ +计算动态全波解 +===================== + +.. toctree:: + :maxdepth: 1 + + gfunc + syn + strain_stress \ No newline at end of file diff --git a/docs/source/Tutorial/index.rst b/docs/source/Tutorial/index.rst deleted file mode 100644 index 6acd5726..00000000 --- a/docs/source/Tutorial/index.rst +++ /dev/null @@ -1,112 +0,0 @@ -简易教程 -============= - -:Author: Zhu Dengda -:Email: zhudengda@mail.iggcas.ac.cn - ------------------------------------------------------------ - -**PyGRT** 程序包由C和Python两个编程语言的代码组成，目的是兼并高效性和便捷性。 -底层复杂运算由C语言编写，编译链接成动态库 ``libgrt.so`` 供Python调用。Python通过 ``ctypes`` 库导入动态库以使用外部函数，以此兼并了C语言的高效和Python语言的便捷。 - -除了Python脚本式运行， **PyGRT** 保留传统命令行式运行C程序 :command:`grt` 。 -受 `GMT `_ 的启发， :command:`grt` 程序对多个计算功能使用模块化管理， -可使用类似于以下格式来运行程序。每个模块可使用 ``-h`` 查看帮助。 - -.. code-block:: C - - grt [] - -**C程序的运行独立于Python，不需要Python环境，从而满足了更多计算场景。** - -计算 **动态解** 的主要计算流程如下： - -+ Python - -.. mermaid:: - :zoom: - - flowchart TB - - GG(["compute_grn()"]) - SS(["gen_syn_from_gf_*()"]) - EE(["compute_strain()"]) - RR(["compute_rotation()"]) - TT(["compute_stress()"]) - - G["Compute Green's Functions - (and its Spatial Derivatives)"] - S["Compute displacements with focal mechanism - (and its Spatial Derivatives)"] - E["Compute Strain Tensor"] - R["Compute Rotation Tensor"] - T["Compute Stress Tensor"] - - GG --> G - G --> SS --> S - S --> EE --> E - S --> RR --> R - S --> TT --> T - - classDef cmdcls fill:#f9f2d9,stroke:#e8d174,stroke-width:2px,color:#333; - class GG,SS,EE,RR,TT cmdcls - -+ C (module name) - -.. mermaid:: - :zoom: - - flowchart TB - - GG(["greenfn"]) - SS(["syn"]) - EE(["strain"]) - RR(["rotation"]) - TT(["stress"]) - - G["Compute Green's Functions - (and its Spatial Derivatives)"] - S["Compute displacements with focal mechanism - (and its Spatial Derivatives)"] - E["Compute Strain Tensor"] - R["Compute Rotation Tensor"] - T["Compute Stress Tensor"] - - GG --> G - G --> SS --> S - S --> EE --> E - S --> RR --> R - S --> TT --> T - - classDef cmdcls fill:#f9f2d9,stroke:#e8d174,stroke-width:2px,color:#333; - class GG,SS,EE,RR,TT cmdcls - -计算 **静态解** 的过程相同，只是在名称上有如下区别： - -+ Python 函数名称增加 "static\_" ，例如 :func:`compute_static_grn() ` 。 -+ C 程序模块名增加 "static\_" 前缀，例如 :command:`static_greenfn` ；或者在 :command:`grt` 与无 "static\_" 前缀的模块名之间增加 "static" 命令， - 即支持以下两种方式（以 :command:`greenfn` 模块为例）： - - .. code-block:: bash - - grt static_greenfn [] - grt static greenfn [] - ------------------ - -以下是一些简易教程，可快速上手。Github主页的 :rst:dir:`example/` 文件夹中有更多示例，可在 `Github Releases `_ 中下载。 - - -.. toctree:: - :maxdepth: 1 - - prepare - dynamic/gfunc - dynamic/syn - static/static_gfunc - static/static_syn - dynamic/strain_stress - static/static_strain_stress - - - diff --git a/docs/source/Tutorial/prepare.rst b/docs/source/Tutorial/prepare.rst index c78d5a4c..2d8a198a 100644 --- a/docs/source/Tutorial/prepare.rst +++ b/docs/source/Tutorial/prepare.rst @@ -6,11 +6,95 @@ ----------------------------------------------------------- +**PyGRT** 程序包由C和Python两个编程语言的代码组成，目的是兼并高效性和便捷性。 +底层复杂运算由C语言编写，编译链接成动态库 ``libgrt.so`` 供Python调用。Python通过 ``ctypes`` 库导入动态库以使用外部函数，以此兼并了C语言的高效和Python语言的便捷。 -安装 **PyGRT** --------------------- +除了Python脚本式运行， **PyGRT** 保留传统命令行式运行C程序 :command:`grt` 。 +受 `GMT `_ 的启发， :command:`grt` 程序对多个计算功能使用模块化管理， +可使用类似于以下格式来运行程序。每个模块可使用 ``-h`` 查看帮助。 + +.. code-block:: C + + grt [] + +**C程序的运行独立于Python，不需要Python环境，从而满足了更多计算场景。** + +计算 **动态解** 的主要计算流程如下： + ++ Python + +.. mermaid:: + :zoom: + + flowchart TB + + GG(["compute_grn()"]) + SS(["gen_syn_from_gf_*()"]) + EE(["compute_strain()"]) + RR(["compute_rotation()"]) + TT(["compute_stress()"]) + + G["Compute Green's Functions + (and its Spatial Derivatives)"] + S["Compute displacements with focal mechanism + (and its Spatial Derivatives)"] + E["Compute Strain Tensor"] + R["Compute Rotation Tensor"] + T["Compute Stress Tensor"] + + GG --> G + G --> SS --> S + S --> EE --> E + S --> RR --> R + S --> TT --> T + + classDef cmdcls fill:#f9f2d9,stroke:#e8d174,stroke-width:2px,color:#333; + class GG,SS,EE,RR,TT cmdcls + ++ C (module name) + +.. mermaid:: + :zoom: + + flowchart TB + + GG(["greenfn"]) + SS(["syn"]) + EE(["strain"]) + RR(["rotation"]) + TT(["stress"]) + + G["Compute Green's Functions + (and its Spatial Derivatives)"] + S["Compute displacements with focal mechanism + (and its Spatial Derivatives)"] + E["Compute Strain Tensor"] + R["Compute Rotation Tensor"] + T["Compute Stress Tensor"] + + GG --> G + G --> SS --> S + S --> EE --> E + S --> RR --> R + S --> TT --> T + + classDef cmdcls fill:#f9f2d9,stroke:#e8d174,stroke-width:2px,color:#333; + class GG,SS,EE,RR,TT cmdcls + +计算 **静态解** 的过程相同，只是在名称上有如下区别： + ++ Python 函数名称增加 "static\_" ，例如 :func:`compute_static_grn() ` 。 ++ C 程序模块名增加 "static\_" 前缀，例如 :command:`static_greenfn` ；或者在 :command:`grt` 与无 "static\_" 前缀的模块名之间增加 "static" 命令， + 即支持以下两种方式（以 :command:`greenfn` 模块为例）： + + .. code-block:: bash + + grt static_greenfn [] + grt static greenfn [] + +----------------- -详见 :doc:`/install` 。 +入门部分包含一些示例与说明，可快速上手。Github主页的 :rst:dir:`example/` 文件夹中有更多示例，可在 `Github Releases `_ 中下载。 建立模型文件 diff --git a/docs/source/Tutorial/static/index.rst b/docs/source/Tutorial/static/index.rst new file mode 100644 index 00000000..986f8743 --- /dev/null +++ b/docs/source/Tutorial/static/index.rst @@ -0,0 +1,9 @@ +计算静态位移 +===================== + +.. toctree:: + :maxdepth: 1 + + static_gfunc + static_syn + static_strain_stress \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index b97b5773..396185b7 100755 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -100,7 +100,9 @@ :maxdepth: 1 install - Tutorial/index + Tutorial/prepare + Tutorial/dynamic/index + Tutorial/static/index .. toctree::