Added some initial information giving an overview of the flow of the code.

这个提交包含在:
Craig Warren
2017-12-06 12:32:59 +01:00
父节点 085476d3f2
当前提交 67a72d1d28
共有 3 个文件被更改,包括 20 次插入1 次删除

19
docs/source/coding.rst 普通文件
查看文件

@@ -0,0 +1,19 @@
.. _coding:
*************
Code Overview
*************
This section aims to provide information and advice for developers who want to
get started using and modifying the gprMax code.
The code has been written in Python (3.x) with performance-critical parts, i.e.
the FDTD solver, written using Cython (for CPU) or the NVIDIA CUDA programming
model (for GPU). Cython allows the CPU-based solver to be parallelised using
OpenMP which enables it to run on multi-core CPUs. gprMax also features a
Messaging Passing Interface (MPI) task farm, which can operate with CPU nodes or
multiple GPUs.
.. figure:: images/code_overview.png
Basic, high-level overview of the flow of control (operation) of the code.