Skip to content

Commit 9266117

Browse files
committed
fix docs
1 parent e684c6c commit 9266117

File tree

3 files changed

+12
-4
lines changed

3 files changed

+12
-4
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,16 @@
1717
<img src="./figs/output3.png" alt="Image 3" width="42%" />
1818
</p>
1919

20-
<!-- ![图片](./figs/output.png)
21-
![图片](./figs/output2.png) -->
20+
**欢迎Star!**
2221

2322
**PyFMM**是一个基于Fast Marching Method求解程函方程 $|\nabla T|^2 = s^2$ 的C/Python程序包,包括示例和注释。
2423
**PyFMM** is a C/Python package for solving eikonal equation using Fast Marching Method, with examples and annotations.
2524

25+
我主要使用该代码计算地震波从震源出发在复杂介质中传播形成的初至波走时场,
26+
并使用梯度下降获得满足费马原理的射线路径,故代码中的一些术语偏专业性。
27+
类似的原理也可用于其它方面,如计算点到曲线/面的距离,或光学、电磁学等。
28+
29+
2630
+ **Python语言的便携、可扩展性与C语言的计算高效特点结合**
2731
C程序被编译链接成动态库 *libfmm.so***PyFMM** 再基于Python的 [ctypes](https://docs.python.org/3/library/ctypes.html)
2832
标准库实现对C库函数的调用。再基于第三方库 [NumPy](https://numpy.org/)

docs/source/index.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,11 @@
2020

2121

2222
**PyFMM** : 基于Fast Marching Method求解程函方程 :math:`|\nabla T|^2 = s^2` 的程序包。
23-
代码根据 :ref:`主要参考 <main_ref>` 中详述的原理进行实现。
23+
代码根据 :ref:`主要参考 <main_ref>` 中详述的原理进行实现。
24+
25+
我主要使用该代码计算地震波从震源出发在复杂介质中传播形成的初至波走时场,
26+
并使用梯度下降获得满足费马原理的射线路径,故代码中的一些术语偏专业性。
27+
类似的原理也可用于其它方面,如计算点到曲线/面的距离,或光学、电磁学等。
2428

2529

2630
+ **Python语言的便携、可扩展性与C语言的计算高效特点结合**。

pyfmm/_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = '0.2.1'
1+
__version__ = '0.2.2-dev'

0 commit comments

Comments
 (0)