貢献者ガイド

CoFEA計画への貢献を開始する方法を簡単に紹介します。最初に、私たちが従うべきルールを自分自身に認めてください:

  • プログラミングやコンパイルなどに慣れていない場合は、メイン環境としてUbuntu 18.0 (またはDebianベースのLinux) を使用することをお勧めします。私たちはこのディストリビューションを使う傾向があり、この文書で紹介されているすべてのガイドラインはこのOSで検証されています。

  • コードやドキュメントなどを保存する場所としてGitHubのウェブサイトを使っています。その結果、CoFEAに投稿したい場合は、 CoFEA repository をフォークし、変更を加え、変更したバージョンを送り返すことができるように、このプラットフォームのアカウントを持っている必要があります。 また、あなたは git のバージョン管理システムとGitHubで使われている命名法(たとえば、プル要求、フォークなどです。)の基本を理解している必要があります。

  • Python 3.xのみを使用すると便利ですが、一部のFEコード (たとえば、Salome) はまだPythonバージョン2.7を使用しています。そのため、開発されるすべてのスクリプトは、2.xおよび3.xバージョンとほぼ互換性のある方法で開発する必要があります。

  • 私たちが現在取り組んでいるすべてのタスクは、 CoFEA Github issues に提示されています。

  • 新しく整備する場合は、camelCaseルールまたは他の任意のルールの代わりにsnake_caseを使用して命名してください

ドキュメントの貢献

コントリビューターとしての旅は、CoFEA文書のコピーをハードドライブに保存することから始める必要があります。Webサイトをローカルに再作成するのは非常に簡単です。これを行うには、ターミナルから次のコマンドを実行します。

# Install python3.7 version; skip the step if you have it
sudo apt install python3.7
# Install virtualenv module for python3.7
python3.7 -m pip install virtualenv
# Download CoFEA repo
git clone https://github.com/spolanski/CoFEA.git
# open CoFEA folder
cd CoFEA/
# set up python virtualenv
python3.7 -m venv cofea_env
# activate the virtualenv
source cofea_env/bin/activate
# install all the modules which are required by CoFEA
python3.7 setup.py install
# go to docs folder
cd docs/
# execute sphinx to compile the website
make html
# open the local website in firefox
firefox _build/html/index

以上です! 上記の手順に従うと、Webサイトをローカルでコンパイルできます。その後、ファイルを変更し、git pushコマンドを使用してCoFEA githubに送ることができます。私たちはあなたの貢献を楽しみにしています!

ヒント

やるべき仕事を探している? CoFEAドキュメントのissue を確認してください。これには、実装したいいくつかのものが含まれています。一つ選んで Github issueを作成してください、誰かが取り組んでいることがわかります。 その後プルリクエストを送信すると、作業はすぐにマージされます。

FE作業の貢献

ドキュメントが機能したら、シミュレーション環境を設定できます。共同作成者が現在使用しているCoFEAワークフローは次のとおりです:

  1. Salome_Meca 2019.3を使用して形状とメッシュを作成/インポートします

  2. 確立されたモデルはCode_Asterでテストされます

  3. メッシュは、CalculixおよびElmerで解析を実行するのに適した形式に変換されます。

  4. オプションとして、同じセットアップが、フリーでオープンソースの異なるコードでテストされます。

貢献する最善の方法は、Code_Aster、Calculix、およびElmerとともにSalome_Mecaをインストールし、独自のモデルを構築してCoFEAイニシアチブに貢献できるようにすることです。貢献する最善の方法は、Code_Aster、Calculix、およびElmerとともにSalome_Mecaをインストールし、独自のモデルを構築してCoFEA計画に貢献できるようにすることです。

ヒント

やるべき仕事を探している? FEA作業のissue を確認してください。これには、テストしたいいくつかの例が含まれています。一つ選んで Github issueを作成してください、誰かが取り組んでいることがわかります。 その後プルリクエストを送信すると、作業はすぐにマージされます。

重要

FEコード開発者で、独自のサンプルを提出したり、既存のベンチマークの結果を表示したい場合は、Benchmarksフォルダに自由に投稿を追加してプルリクエストを送信してください。

Pythonスクリプトの貢献

現在のところ、ほとんどの作業は Meshpresso Mesh Converter 上で行われています。どのように貢献するかについての詳細は、まもなく提供される予定です。