From 853270b34dd1b29f520d18a2be4ae5b509385dd7 Mon Sep 17 00:00:00 2001 From: subarutaro Date: Sat, 1 Aug 2020 15:19:00 +0900 Subject: [PATCH] modify README.md --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 30fac71..ae06af6 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,14 @@ -# PIKG +# PIKG (Ver 0.0) 本プロジェクトは,FDPS( https://github.com/FDPS/FDPS )およびその他の粒子系シミュレータの粒子間相互作用カーネル関数の自動ジェネレータである. 粒子間相互作用をDSLで記述し,パラメータを指定すると,任意のアーキテクチャ(Intel CPU, Fujitsu A64FX, NVIDIA GPU, PEZY-SC2, etc.)向けのカーネルを生成する. +# 動作環境 +Ruby環境が必要.ruby 2.3.7で動作確認. + # 言葉の定義 +## 粒子系シミュレータ +粒子が互いに作用しながら時間発展するような系を扱うシミュレーションプログラム.分子動力学,N体,SPHシミュレーションプログラムなどがこれにあたる. + ## カーネル 2粒子間の相互作用を計算する関数. 相互作用を受ける粒子のインデックスを*i*,相互作用を与える粒子のインデックスを*j*とすると, @@ -28,7 +34,7 @@ $(PIKG_DIR)/bin/pikg -i (input_file) -o (output_file) [options] ``` output_fileにC++のヘッダーファイルができるので相互作用計算の構造体(デフォルトclass名Kernel)を利用する 生成されたヘッダーファイルを利用してコンパイルする際には./inc/pikg_vetor.hppに宣言されている型が使われているのでインクルードする -詳細についてはdoc/kernel_generator_spec/pdfを参照ください. +詳細についてはdoc/kernel_generator_spec.pdfを参照ください. 現在参照できるサンプルは以下のとおりです. > ./sample/LennardJones @@ -37,7 +43,7 @@ output_fileにC++のヘッダーファイルができるので相互作用計算 それぞれに関しては,各ディレクトリのREADME.mdをご参照ください. -# 目標ターゲット命令セット +# 目標とする最適化可能な命令セット - AVX2 - AVX-512 - ARM SVE