Skip to content

STYLE: rename b2a and k2a, and move their .c files to src/tools/ directory #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 16, 2025
Merged

STYLE: rename b2a and k2a, and move their .c files to src/tools/ directory #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
75486bf
STYLE: rename grt_b2a.c, grt_k2a.c files
Dengda98 Sep 16, 2025
4149bf1
STYLE: rename `b2a` to `sac2asc`, `k2a` to `ker2asc`
Dengda98 Sep 16, 2025
c029c0e
STYLE: move `ker2asc` and `sac2asc` to `src/tools/` dir
Dengda98 Sep 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/source/Advanced/integ_converg/integ_converg.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@ C和Python导出的核函数文件是一致的，底层调用的是相同的函

.. group-tab:: C

:command:`k2a` 模块可将单个核函数文件转为文本格式。
:command:`ker2asc` 模块可将单个核函数文件转为文本格式。

.. literalinclude:: run/run.sh
:language: bash
:start-after: BEGIN grt.k2a
:end-before: END grt.k2a
:start-after: BEGIN grt.ker2asc
:end-before: END grt.ker2asc

输出的文件如下，

Expand Down Expand Up @@ -143,12 +143,12 @@ C和Python导出的核函数文件是一致的，底层调用的是相同的函

.. note::

:command:`k2a` 模块也支持将 ``PTAM_{ir}_{dist}/PTAM_{iw}_{freq}`` 文件转为文本格式，
:command:`ker2asc` 模块也支持将 ``PTAM_{ir}_{dist}/PTAM_{iw}_{freq}`` 文件转为文本格式，

.. literalinclude:: run/run.sh
:language: bash
:start-after: BEGIN grt.k2a ptam
:end-before: END grt.k2a ptam
:start-after: BEGIN grt.ker2asc ptam
:end-before: END grt.ker2asc ptam

输出的文件如下，

Expand Down
18 changes: 9 additions & 9 deletions docs/source/Advanced/integ_converg/run/run.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ grt greenfn -Mmilrow -D2/0 -N500/0.02 -OGRN -R5,8,10 -S50,100
# -------------------------------------------------------------------

# -------------------------------------------------------------------
# BEGIN grt.k2a
grt k2a GRN_grtstats/milrow_2_0/K_0050_5.00000e+00 > stats
# END grt.k2a
# BEGIN grt.ker2asc
grt ker2asc GRN_grtstats/milrow_2_0/K_0050_5.00000e+00 > stats
# END grt.ker2asc
# -------------------------------------------------------------------

head -n 10 stats > stats_head
Expand All @@ -23,15 +23,15 @@ echo "..." >> stats_head
# -------------------------------------------------------------------
# BEGIN DEPSRC 0.0 DGRN
grt greenfn -Mmilrow -D0/0 -N500/0.02 -OGRN -R5,8,10 -S50,100
grt k2a GRN_grtstats/milrow_0_0/K_0050_5.00000e+00 > stats
grt ker2asc GRN_grtstats/milrow_0_0/K_0050_5.00000e+00 > stats
# 绘制图像部分见Python
# END DEPSRC 0.0 DGRN
# -------------------------------------------------------------------

# -------------------------------------------------------------------
# BEGIN grt.k2a ptam
grt k2a GRN_grtstats/milrow_0_0/PTAM_0002_1.00000e+01/PTAM_0050_5.00000e+00 > ptam_stats
# END grt.k2a ptam
# BEGIN grt.ker2asc ptam
grt ker2asc GRN_grtstats/milrow_0_0/PTAM_0002_1.00000e+01/PTAM_0050_5.00000e+00 > ptam_stats
# END grt.ker2asc ptam
# -------------------------------------------------------------------

head -n 10 ptam_stats > ptam_stats_head
Expand All @@ -48,8 +48,8 @@ echo "..." >> ptam_stats_head
# -S 表示输出核函数文件
grt static greenfn -Mmilrow -D0.1/0 -X2/2/1 -Y2/2/1 -S > grn

# grt.k2a 也可以读取静态解输出的核函数文件，格式一致
grt k2a stgrtstats/milrow_0.1_0/K > static_stats
# grt.ker2asc 也可以读取静态解输出的核函数文件，格式一致
grt ker2asc stgrtstats/milrow_0.1_0/K > static_stats

# 绘制图像部分见Python
# END SGRN
Expand Down
6 changes: 3 additions & 3 deletions docs/source/Tutorial/dynamic/gfunc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,12 @@ Python中计算动态格林函数的主函数为 :func:`compute_grn() <pygrt.pym
.. literalinclude:: run/travt
:language: text

+ 如果你没有安装SAC软件，可以使用Python的ObsPy库读取生成的SAC数据，或者使用 :command:`b2a` 模块临时将SAC格式文件转为如下的文本文件：
+ 如果你没有安装SAC软件，可以使用Python的ObsPy库读取生成的SAC数据，或者使用 :command:`sac2asc` 模块临时将SAC格式文件转为如下的文本文件：

.. literalinclude:: run/run.sh
:language: bash
:start-after: BEGIN grt.b2a
:end-before: END grt.b2a
:start-after: BEGIN grt.sac2asc
:end-before: END grt.sac2asc

输出的文本文件如下，两列分别为时间点和幅值。这种输出仅保留波形信息，缺失SAC文件中的头段变量。

Expand Down
6 changes: 3 additions & 3 deletions docs/source/Tutorial/dynamic/run/run.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ grt travt -Mmilrow -D2/0 -R5,8,10 > travt


# -----------------------------------------------------------------------------------
# BEGIN grt.b2a
grt b2a GRN/milrow_2_0_10/HFZ.sac > HFZ
# END grt.b2a
# BEGIN grt.sac2asc
grt sac2asc GRN/milrow_2_0_10/HFZ.sac > HFZ
# END grt.sac2asc
# -----------------------------------------------------------------------------------
head -n 10 HFZ > HFZ_head
echo "..." >> HFZ_head
Expand Down
4 changes: 2 additions & 2 deletions pygrt/C_extension/include/grt.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@
X(static_strain) \
X(static_stress) \
/* other */ \
X(k2a) \
X(b2a) \
X(ker2asc) \
X(sac2asc) \
X(travt) \
// ------------------------------------------------------

Expand Down
8 changes: 4 additions & 4 deletions pygrt/C_extension/src/common/grt_k2a.c → pygrt/C_extension/src/tools/grt_ker2asc.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @file grt_k2a.c
* @file grt_ker2asc.c
* @author Zhu Dengda (zhudengda@mail.iggcas.ac.cn)
* @date 2025-03-27
*
Expand Down Expand Up @@ -32,13 +32,13 @@ static void free_Ctrl(GRT_MODULE_CTRL *Ctrl){
/** 打印使用说明 */
static void print_help(){
printf("\n"
"[grt k2a] %s\n\n", GRT_VERSION);printf(
"[grt ker2asc] %s\n\n", GRT_VERSION);printf(
" Convert a binary stats file generated during wavenumber integration\n"
" into an ASCII file, write to standard output.\n"
"\n\n"
"Usage:\n"
"----------------------------------------------------------------\n"
" grt k2a <statsfile>\n"
" grt ker2asc <statsfile>\n"
"\n\n\n"
);
}
Expand Down Expand Up @@ -98,7 +98,7 @@ static void print_PTAM(FILE *fp){


/** 子模块主函数 */
int k2a_main(int argc, char **argv){
int ker2asc_main(int argc, char **argv){
GRT_MODULE_CTRL *Ctrl = calloc(1, sizeof(*Ctrl));
Ctrl->name = strdup(argv[0]);

Expand Down
8 changes: 4 additions & 4 deletions pygrt/C_extension/src/common/grt_b2a.c → pygrt/C_extension/src/tools/grt_sac2asc.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* @file grt_b2a.c
* @file grt_sac2asc.c
* @author Zhu Dengda (zhudengda@mail.iggcas.ac.cn)
* @date 2025-03-27
*
Expand Down Expand Up @@ -31,13 +31,13 @@ static void free_Ctrl(GRT_MODULE_CTRL *Ctrl){
/** 打印使用说明 */
static void print_help(){
printf("\n"
"[grt b2a] %s\n\n", GRT_VERSION);printf(
"[grt sac2asc] %s\n\n", GRT_VERSION);printf(
" Convert a binary SAC file into an ASCII file, \n"
" write to standard output (ignore header vars).\n"
"\n\n"
"Usage:\n"
"----------------------------------------------------------------\n"
" grt b2a <sacfile>\n"
" grt sac2asc <sacfile>\n"
"\n\n\n"
);
}
Expand All @@ -60,7 +60,7 @@ static void getopt_from_command(GRT_MODULE_CTRL *Ctrl, int argc, char **argv){


/** 子模块主函数 */
int b2a_main(int argc, char **argv){
int sac2asc_main(int argc, char **argv){
GRT_MODULE_CTRL *Ctrl = calloc(1, sizeof(*Ctrl));
Ctrl->name = strdup(argv[0]);

Expand Down