Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion client/src/components/common/NavigationDrawer.vue
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
prepend-icon="mdi-cog-outline"
variant="text"
class="text-capitalize"
text="Manage remotehost"
text="Remotehost editor"
data-cy="navigation-manage_remote_host-btn"
@click="$emit('open-remotehost-manager')"
/>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 12 additions & 17 deletions documentMD/user_guide/_for_admins/how_to_boot/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,13 +143,9 @@ WHEELは、sshでログインした先の計算サーバ上でタスクを実行
### バッチシステムがない場合
まず、WHEELにアクセスし、画面右上のハンバーガーメニューをクリックします。

{% include annotated-img.html
src="./img/hamburger_menu.png"
markers="top:20.5,left:80.4,type:rect,width:23.8,height:25.4"
%}
![hamburger menu](img/hamburger_menu.png "hamburger menu")


表示されたメニュー内の __Remotehost editor__ をクリックします。リモートホスト設定画面が別タブで表示されます。
表示されたメニュー内の __Remotehost editor__ をクリックします。リモートホスト設定ダイアログが表示されます。

![img](./img/remotehost_editor_button.png "リモートホストエディタリンク")

Expand Down Expand Up @@ -177,6 +173,13 @@ Host work dir

例えば、 `foo.example.com` ホストに対して、ユーザー `bar` で接続しタスクの実行を `/home/users/bar/baz` ディレクトリ以下で行なう設定を`example` という名前で作成する場合、入力内容は次のようになります。

入力フィールド | 入力値
--- | ---
1 | example
2 | foo.example.com
3 | bar
4 | /home/users/bar/baz

![img](./img/new_remotehost.png "新規ホスト情報設定")


Expand Down Expand Up @@ -214,24 +217,16 @@ __リモートホストへの接続に公開鍵認証を使用する場合__

![img](./img/edit_remotehost_setting.png "ホスト情報編集ダイアログ")

リモートホストで使われているバッチシステムの種類を、 __job scheduler__ の欄(1)から選びます。
リモートホストで使われているバッチシステムの種類を、 __job scheduler__ の欄から選びます。
現在設定可能な値は次の6種類です。

- PBSPro
- PBSProWithoutHistory
- SLURM
- Fugaku
- TCS (Technical Computing Suite)
- UGE (Univa Grid Engine)

__PBSProWithoutHistoryについて__
PBSProには、バッチシステムの設定で実行終了したジョブの情報を保存しないものがあります。
この場合 __PBSPro__ ではなく __PBSProWithoutHistory__ を使用してください。
{: .notice--info}

__Fugakuについて__
富岳では、TCSが採用されていますが他サイトとは一部挙動が違うため、富岳専用の設定(Fugaku)を用意しています。
富岳を使用する場合は、__TCS (Technical Computing Suite)__ ではなく __Fugaku__ を選択してください。
富岳では、Technical Computing Suite (TCS) 上でジョブ管理が行われています。同じジョブスケジューラを導入している他システムでは
動作確認を行なっていないため、富岳専用の設定(Fugaku)として用意しています
{: .notice--info}

__バッチシステムの設定について__
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentMD/user_guide/_reference/1_home_screen/img/export.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentMD/user_guide/_reference/1_home_screen/img/home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentMD/user_guide/_reference/1_home_screen/img/new.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentMD/user_guide/_reference/1_home_screen/img/open.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 27 additions & 12 deletions documentMD/user_guide/_reference/1_home_screen/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,23 @@ permalink: /reference/1_home_screen/
---

新規プロジェクトの作成や既存プロジェクトの編集はホーム画面で行います。
ホーム画面の構成は以下のとおりです
ホーム画面は大きく3つのエリアに分かれています

![img](./img/home.png "home")

①メニューエリアの構成は以下のとおりです。

![img](./img/menu_area.png "menu area")

|| 構成要素 | 説明 |
||---------------------------|-------------------------------------------------------------------------------------------------------|
|1| ハンバーガーメニュー | ユーザガイド、リモートホスト設定画面へのリンクを含むドロワーを開きます |
|2| 接続状態表示アイコン | サーバとの接続状態を表示します。接続が切れた場合は再接続を試みます|

② ボタンエリアの構成は以下のとおりです。

![img](./img/button_area.png "button area")

|| 構成要素 | 説明 |
||-----------------------------|-------------------------------------------------------------------------------------------------------|
|1| OPEN ボタン | 既存プロジェクトを開きます |
Expand All @@ -18,8 +31,10 @@ permalink: /reference/1_home_screen/
|5| REMOVE ボタン | プロジェクトを削除します |
|6| EXPORT ボタン | プロジェクトアーカイブをエクスポートします |
|7| BATCH MODE スイッチ | 複数プロジェクトの一括削除モードへの切り替えます。有効にした場合、複数プロジェクトが選択可能となります|
|8| ハンバーガーメニュー | ユーザガイド、リモートホスト設定画面へのリンクを含むドロワーを開きます |
|9| プロジェクト一覧表示エリア | 過去に開いたプロジェクトがリスト表示されます |


③プロジェクト一覧表示エリアには、過去に開いたプロジェクトがリスト表示されます。



プロジェクト一覧表示エリアには、以下の項目が表示されます。
Expand Down Expand Up @@ -89,9 +104,13 @@ __プロジェクト名について__
1. __REMOVE__ ボタンをクリックすると、選択したプロジェクトが削除されます。
このとき、代わりに __REMOVE FROM LIST__ ボタンをクリックすると、プロジェクト一覧表示エリアからは削除されますが、プロジェクトの実体となるファイルはサーバ側に残すことができます。

## 複数プロジェクトの一括削除
![img](./img/remove.png "remove project")

__複数プロジェクトの一括削除について__
__BATCH MODE__ スイッチを有効にすると、複数のプロジェクトを選択できるようになります。
この状態で、__REMOVE__ または __REMOVE FROM LIST__ ボタンをクリックすると複数プロジェクトを一括で削除することができます。
{: .notice--info}


## プロジェクトのエクスポート
次の手順でプロジェクトをエクスポートします。
Expand All @@ -110,14 +129,10 @@ __BATCH MODE__ スイッチを有効にすると、複数のプロジェクト
|memo | プロジェクトの内容に関するメモ |


全ての項目はプロジェクト内のJSONファイルに書き込まれます。WHEELのプロジェクトファイルはgitリポジトリとして管理されているため
後から削除しても記入した内容を復元できることに留意してください。

これらの情報は、インポートを行なう時に意図したアーカイブファイルかどうかを
ユーザが確認するためにのみ使われます。

WHEELのシステム上は全ての項目が空欄となっていても、動作に影響は無いので
特にプロジェクトの作成者に関する情報を入力するかどうかは慎重に判断してください。
これらの情報はインポート時に表示されて、意図したアーカイブファイルかどうかを確認するためだけに使われます。
しかし、WHEELのプロジェクトファイルはgitリポジトリとして管理されているため
一度入力してexportしてしまうと、後から削除しても記入した内容を復元できることに留意してください。
WHEELのシステム上は全ての項目が空欄となっていても、動作に影響は無いので、特にプロジェクト作成者の個人情報を入力するかどうかは慎重に判断してください。

__OK__ ボタンをクリックすると `WHEEL_project_***.tgz` というファイル名でプロジェクトアーカイブが生成され
ブラウザのデフォルトのダウンロード先に保存されます。
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 13 additions & 14 deletions documentMD/user_guide/_reference/2_remotehost_screen/index.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,32 @@
---
title: リモートホスト設定画面
title: リモートホスト設定ダイアログ
lang: ja
permalink: /reference/2_remotehost_screen/
---
ワークフロー内でWHEELサーバ外の計算環境(以下、リモートホスト)を用いる場合、対象とするリモートホストにSSH接続し処理を実行します。
ワークフロー作成時に使用するリモートホスト情報、およびリモートホストにSSH接続時に使用するユーザ情報は、リモートホスト設定画面にて登録します
ワークフロー作成時に使用するリモートホスト情報、およびリモートホストにSSH接続時に使用するユーザ情報は、リモートホスト設定ダイアログにて登録します

## リモートホスト設定画面の表示
リモートホスト設定画面は、画面右上のハンバーガーメニューをクリックし、表示された __Remotehost editor__ リンクをクリックして表示します。
## リモートホスト設定ダイアログの表示
リモートホスト設定ダイアログは、画面右上のハンバーガーメニューをクリックし、表示された __Remotehost editor__ リンクをクリックして表示します。

![img](./img/drawer.png "drawer.png")
![img](./img/remotehost_editor_button.png "drawer.png")


## リモートホスト設定画面
リモートホスト設定画面の構成は、以下のとおりです。
## リモートホスト設定ダイアログの構成
リモートホスト設定ダイアログの構成は、以下のとおりです。

![img](./img/remotehost.png "remotehost")

||構成要素|説明|
|----------|----------|---------------------------------|
|1|タイトル(WHEEL) ボタン | ホーム画面へ遷移します |
|2|NEW REMOTE HOST SETTING ボタン | リモートホストへの接続情報を新規作成します |
|3|リモートホストリスト | 登録済みリモートホスト情報がリスト表示されます |
|4|TEST ボタン | 設定した接続情報でリモートホストにアクセスできるかどうかを確認します|
|5|編集 ボタン | 入力済の接続情報を編集します |
|6|削除 ボタン | 入力済の接続情報を削除します |
|1|NEW REMOTE HOST SETTING ボタン | リモートホストへの接続情報を新規作成します |
|2|リモートホストリスト | 登録済みリモートホスト情報がリスト表示されます |
|3|TEST ボタン | 設定した接続情報でリモートホストにアクセスできるかどうかを確認します|
|4|編集 ボタン | 入力済の接続情報を編集します |
|5|削除 ボタン | 入力済の接続情報を削除します |

## 新規リモートホスト設定の作成
__NEW REMOTE HOST SETTING__ ボタンをクリックすると、新規リモートホスト設定画面が表示されます
__NEW REMOTE HOST SETTING__ ボタンをクリックすると、新規リモートホスト設定ダイアログが表示されます

![img](./img/new_remotehost.png "new_remotehost")

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ permalink: /reference/3_workflow_screen/1_graphview.html
| 8|階層表示・遷移ボタン    |現在表示中のコンポーネントの階層が表示されます       |
| 9|環境変数エディタ表示ボタン |環境変数設定画面が表示されます                    |
|10|コンポーネントライブラリ  |ワークフローの構成要素であるコンポーネントを追加するためのパレットです|
|11|ログ表示ボタン       |ワークフローの作成、実行に関するログが表示されます          |
|11|パンズームコントロール   |ワークフロー作成用エリアのズームイン、ズームアウト、パン操作ができます|
|12|ログ表示ボタン       |ワークフローの作成、実行に関するログが表示されます          |

__接続状態アイコンについて__
画面右上のハンバーガーメニューの隣に、サーバとの接続状態を示すアイコンが表示されます。
Expand Down Expand Up @@ -104,7 +105,6 @@ git操作の詳細については開発者向けドキュメント[詳細設計
|----------|----------|---------------------------------|
|1|graph view ボタン |グラフビュー画面に切り替えます。グラフビュー画面は初期表示される画面です|
|2|list view ボタン |リストビュー画面に切り替えます|
|3|text editor ボタン |テキストエディタ画面に切り替えます|

__テキストエディタ画面への遷移について__
テキストエディタ画面への遷移は、ファイルの選択状態やプロジェクトの選択状態によって制限されています。
Expand Down Expand Up @@ -193,12 +193,16 @@ __name__ に環境変数名、__value__ に値を入力して、__+__ ボタン
|1|clear all log ボタン|それまでに表示された全てのログが消去されます|
|2|category ボタン|表示するログのカテゴリをフィルタリングできます|
|3|download debug ボタン|デバッグ用のログファイルをダウンロードします|
|4|log display area|ログが表示されます|

#### カテゴリフィルタ
__category__ ボタンをクリックすると、表示するログのカテゴリを選択できます。
カテゴリは以下のように分類されています。

- __system__: info, warn, error - システムメッセージやプロジェクトの実行状況に関する情報
- __system__: システムメッセージやプロジェクトの実行状況に関する情報
- info: 一般的な情報メッセージ
- warn: 警告メッセージ
- error : エラーメッセージ
- __script__: stdout, stderr, sshout - スクリプトの実行結果
- stdout: ローカルホストで実行されたタスクの標準出力
- stderr: ローカルホストで実行されたタスクの標準エラー出力
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions documentMD/user_guide/_reference/4_component/00_common.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,16 @@ permalink: /reference/4_component/00_common.html

## プロパティの表示
ワークフロー作成用エリアに表示されているコンポーネントをシングルクリックすると、そのコンポーネントの設定値(プロパティ)を編集する領域が表示されます。
設定された値は、一部項目を除いてこの領域を閉じた時点で保存されます。

コンポーネントの種類毎にこの領域に表示される内容は異なります。

![img](./img/component_property.png "component_property")

||構成要素|説明|
|----------|----------|---------------------------------|
|1|close ボタン |プロパティ表示を閉じます|
|2|clean ボタン |コンポーネント(もしあれば下位コンポーネントも)の状態を最新の保存状態に巻き戻します|
|1|close ボタン |変更を破棄しプロパティ表示を閉じます|
|2|disableスイッチ |コンポーネント(もしあれば下位コンポーネントも)を無効化します|
|3|詳細表示 ボタン|プロパティの設定項目の表示/非表示をグループ毎に切り替えます|

### コンポーネントの右クリックメニュー
Expand Down Expand Up @@ -47,7 +48,7 @@ WHEELでは、個別のコンポーネント(およびその下位コンポー
- アーカイブにはそのコンポーネントとすべての下位コンポーネントが含まれます

__エクスポートされるもの__
- コンポーネント設定(component.jsonファイル)
- コンポーネント設定(component.wheel.jsonファイル)
- コンポーネント内のすべてのファイルとディレクトリ
- すべての下位(子)コンポーネント(再帰的に)
- コンポーネントの状態は "not-started" にリセットされます
Expand Down Expand Up @@ -159,8 +160,6 @@ output filesに指定されたファイルまたはディレクトリへのシ
## ファイル操作エリア
Filesグループの __∨(詳細表示)__ ボタンをクリックすると、ファイル操作エリアが表示されます。

![img](./img/open_files_erea.png "open files erea")

![img](./img/file_area.png "file area")

||構成要素|説明|
Expand Down Expand Up @@ -196,6 +195,7 @@ __連番を持つファイルやディレクトリの表示について__
|5|upload file ボタン|表示されている階層にファイルをアップロードします|
|6|download ボタン|選択中のファイル、ディレクトリをダウンロードします|
|7|share file ボタン|選択中のファイル、ディレクトリのパスを表示します|
|8|edit file ボタン|選択中のファイルをテキストエディタで編集します|

__選択中のファイル、ディレクトリを操作対象とするボタンについて__
選択中のファイル、ディレクトリを操作対象とする操作は、非対応の時はボタンが無効化されます。
Expand Down
Loading