=================================================================== Windows用バイナリ版インストール手引書 =================================================================== :著者: 稲村 泰弘 :最終更新日: Jul. 13th, 2021 :対応空蟬リリース: 4.0 or later .. contents:: 目次 :depth: 3 インストールが可能なWindowsとユーザー名 ========================================= 以下の条件を満たす必要がある。 Windowsの種類 Windows 10の **64bit版** でのみ動作する。 それ以外の環境（32bit版も含め）は今後もサポートする予定はない。 アカウント名 インストールするWindowsの管理者ユーザーのアカウント名が **英数字** でなければならない。 もし日本語を利用していた場合、新たに英数字のアカウント名でユーザーを作成し、そちらでログインしてからインストールする必要がある。新たにアカウントを作成する方法などは省略する。 +------------------------+---------+-----------+ |アカウント名の条件 |良い例 |悪い例 | +========================+=========+===========+ |英数字であること |Inamura |稲村 | +------------------------+---------+-----------+ インストール ===================== インストール前の確認事項 -------------------------- インストールを行う前に、Windowsの **Python** をインストールする必要がある。これは、 https://www.python.org/ などから行えるが、インストールするPythonのバージョンに注意すること。また64bit版しか動作しないことに注意。なお、Python 2.x や32bit版の対応はしない。 WindowsにインストールできるPython環境は様々に存在するが、現状、空蟬が動作することを確認できたものは以下の２種類であるので注意すること。 +-------------------+--------------------------------------------+----------------+ |Python環境 |URL |対応バージョン | +===================+============================================+================+ |Anaconda |https://www.anaconda.com/products/individual|2021.05, 2020.11| | | +----------------+ | | |2019.03 | +-------------------+---------------+----------------------------+----------------+ |python.org（本家） |https://www.python.org/downloads/windows/ |3.7のみ対応 | +-------------------+--------------------------------------------+----------------+ インストール手順 -------------------------- Anaconda版とPython.org版で、インストールの手順が若干異なる。それぞれの環境に応じ、下記のリンクからインストールを行うこと。 .. toctree:: :maxdepth: 2 BinaryInstaller_win_anaco.rst BinaryInstaller_win_pyorg.rst インストールされるアプリケーション ---------------------------------- 空蟬ソフトウェア群は、インストール時に指定した場所（C:¥¥Program Files¥Utsusemi¥）にある。 また、アプリケーションへのショートカットが、以下の場所に作成される。 「スタート」メニュー >> Utsusemi |image08| ここには以下のプログラムが準備されている。詳細は後で述べる。 +-----------------------------+--------------------------------------------+ |Utsusemiアプリケーション |説明 | +=============================+============================================+ |D4MatSlicer |D4MatSlicerを起動する | +-----------------------------+--------------------------------------------+ |D4Mat2Slicer |D4Mat2Slicerを起動する | +-----------------------------+--------------------------------------------+ |M2PlotPlus |M2Plotを起動する | +-----------------------------+--------------------------------------------+ |MPlot |MPlotを起動する | +-----------------------------+--------------------------------------------+ |SequenceEditorQ |SequenceEditorを起動する | +-----------------------------+--------------------------------------------+ |Utsusemi Environment Settings|【環境設定】空蟬のフォルダ環境変数を設定する| +-----------------------------+--------------------------------------------+ |Utsusemi Shell |Utsusemi環境が設定されたターミナルを起動する| +-----------------------------+--------------------------------------------+ 初期設定 ========= 前準備（必要なフォルダの作成） -------------------------------- 空蟬Win版では、まず解析用データの置き場所と一時ファイル保存場所をフォルダとして準備する必要がある。 .. table:: データ保存場所 :widths: 30 70 +--------------------------+---------------------------------------------------------------------------------------------------+ |設定（環境変数名） |役割 | +==========================+===================================================================================================+ |データフォルダ (DATA_DIR) |イベントデータなどRAWデータを格納するフォルダ。（Linux版では"/data"） | +--------------------------+---------------------------------------------------------------------------------------------------+ |解析用フォルダ (USR_DIR) |空蟬が作成する一時ファイルを保存先するana/tmpなどのフォルダを置く場所である。（Linux版では"$HOME"）| +--------------------------+---------------------------------------------------------------------------------------------------+ この二つのフォルダは、どこにあっても良いが、例えば下記のような感じで作成する。 +--------------+-------------------------------------------------+ |設定 |デフォルトフォルダ | +==============+=================================================+ |データフォルダ|C:¥ユーザー¥ユーザー名¥ドキュメント¥Utsusemi¥DATA| +--------------+-------------------------------------------------+ |解析用フォルダ|C:¥ユーザー¥ユーザー名¥ドキュメント¥Utsusemi¥HOME| +--------------+-------------------------------------------------+ |image09| 環境設定 ----------- 次に空蟬の環境の設定を **Utsusemi Environment Settings** で行う。 .. warning:: この作業は、インストール後に１回は必ず行う必要がある。 このアプリケーションで設定できる内容は以下の通りである。 - 使用する装置環境（BL01, BL11, BL14, BL15） - データフォルダと解析フォルダの設定 - ログを残すかどうか - 高速化のための並列計算の数 - デバッグモードのオン・オフ よって、違う装置（BeamLine）のデータを解析する場合は、この環境設定で装置環境を切り替える必要がある。 環境設定の起動 ^^^^^^^^^^^^^^^^^^^ 「スタート」メニュー >> Utsusemi |image08| から、**Utsusemi Environment Settings** を起動する。 |image10| 設置項目 ^^^^^^^^^^^^^ 1. **Instrument** 解析に使用するデータの装置の選択を行う。これにより、使用するRAWデータフォルダ、使用できるコマンドなどが変化する。 2. **Log quiet** 解析コマンドのログを減らす場合に使用する。普段はYESで良い。 3. **Utsusemi_debugmode** 空蟬のデバッグモード。普段はNO（チェックボックスオフ）で良い。 3. **Number of thread** 一部の解析コマンドが使用するマルチスレッドの最大値を設定する（通常は実行するPCのコアの数程度を設定すると良い） 4. **DATA_DIR** 及び **USR_DIR** ここで必要な設定は、前節で作成した二つのフォルダを指定することである。 .. table:: 環境変数 :widths: 20 80 +----------------+---------------------------------------------------------------------------------------------------+ |設定（環境変数）|役割 | +================+===================================================================================================+ |DATA_DIR |イベントデータなどRAWデータを格納するフォルダ。（Linux版では"/data"） | +----------------+---------------------------------------------------------------------------------------------------+ |USR_DIR |空蟬が作成する一時ファイルを保存先するana/tmpなどのフォルダを置く場所である。（Linux版では"$HOME"）| +----------------+---------------------------------------------------------------------------------------------------+ 設定後 ^^^^^^^^^^^^^ 設定項目を反映するために **OK** ボタンを押す。正しく設定されれば、確認のダイアログが表示される。 |image11| このダイアログが出ずにエラーのダイアログが出た場合は、特に指定した **DATA_DIR** と **USR_DIR** のフォルダがあるかどうかを確認すること。この設定により、 **USER_DIR** の下に - **ana** フォルダ - この下に **tmp** フォルダ、および **xml** フォルダ がなければ自動的に作成される。 |image12| .. warning:: もし、**ana** フォルダや、**tmp** **xml** フォルダが見つからないようなら設定を見直すか、自分で作成しておくこと。 **そうでないと空蟬は落ちます** 。 一方、*DATA_DIR* で設定した場所には、次節にて述べるルールで、データ（イベントデータなど）を配置する。 データの配置ルール -------------------- 環境変数 *DATA_DIR* で指定したフォルダに、以下のようなルールで配置する。 1. 装置コードと同じ名前のフォルダを作成する 四季（BL01）なら "SIK"、アマテラス（BL14）なら "AMR" 2. 装置コードのフォルダに、その装置でのRun Noのついたデータのフォルダを置く 四季（BL01）なら、例えば "SIK012345_20150301" など +---------------+----------+---------------------------+ |BL |装置コード|配置例 | +===============+==========+===========================+ |BL01 四季 |SIK |DATA/SIK/SIK012345_20160401| +---------------+----------+---------------------------+ |BL11 PLANET |HPN |DATA/HPN/HPN012345_20160401| +---------------+----------+---------------------------+ |BL14 アマテラス|AMR |DATA/AMR/AMR012345_20160401| +---------------+----------+---------------------------+ |BL15 大観 |SAS |DATA/SAS/SAS012345_20160401| +---------------+----------+---------------------------+ |BL19 匠 |ENG |DATA/ENG/ENG012345_20160401| +---------------+----------+---------------------------+ 解析の開始 ============== 環境設定が終了し、解析するデータの配置も終わったなら、アプリケーションから解析が行えるようになる。 空蟬のインストールにより、以下のアプリケーションが「スタート」メニューから使用できる。簡単な説明を行う。 **Utsusemi Environment Settings** 【環境設定】空蟬の環境変数を設定する。詳細は上記の「環境設定と初回起動時の注意点」以下を参照のこと。 **MPlot**, **M2PlotPlus** 空蟬で使用されるデータ可視化ソフトウェアである。それぞれ、1次元プロッタ、2次元プロッタである。詳細は空蟬ユーザーマニュアルを参照のこと。Linux版と同じ。 **D4MatSlicer**, **D4Mat2Slicer** D4MatSlicer、およびD4Mat2Slicerを起動する。あとはLinux版と同じ。 **SequenceEditorQ** SequenceEditorを起動する。 **Utsusemi Shell** 空蟬環境で、Shell（コマンドライン）を起動する。この上で環境設定で指定したビームラインに応じたコマンドを呼び出すことができる。よって、自作のスクリプトを走らせることもできる。 解析に使用するアプリケーションの詳細な説明は、空蟬ユーザーズマニュアルを参照のこと。 コマンドプロンプトからの使用 ============================== アプリケーションを利用せずに、例えば自分で作成したPythonスクリプトを実行することも可能である。特に現場で作成したスクリプト、新しい解析のアイデアを形にしたものなどを自由に実行するためには、コマンドプロンプト上で空蟬環境を利用する必要がある。その方法を以下に示す。 1. **Utsusemi Shell** を起動する 2. 空蟬の設定が有効な状態でコマンドプロンプトが立ち上がる。 3. そのままPythonを起動するなり、他のインタプリタ（例えば *iPython* など）を利用する。また実行フォルダを変更しフォルダの移動、インタプリタの起動、スクリプトの実行を行うことができる。 バージョンの確認 =================== インストールされた空蟬のバージョンを確認するには、以下の方法がある。バグなどの報告や、アップデートする際の目安となる。 1. インストーラーのファイル名 インストーラーファイル名には、数字が２種類ある。リリース番号は比較的大きなバージョンアップ（機能追加）の時に付与される。同じリリース番号でもマイナーなアップデート（バグフィックス）の場合は最終アップデート日付のみ変更される。 +------+---------------------+ |例 |Utsusemi.X.Y.Z.yymmdd| +======+=====================+ |X.Y.Z |リリース番号 | +------+---------------------+ |yymmdd|最終アップデート日付 | +------+---------------------+ 2. **Utsusemi Shell** からコマンド十国 **Utsusemi Shell** を起動し以下のコマンドを打つ。 .. code-block:: python >>> import utsusemi >>> utsusemi.__version__ '4.0.0' もしくは .. code-block:: python >>> import UtsusemiInfo すると、以下のような情報が表示される。 .. code-block:: shell --------------------------------------------- Utsusemi Info --------------------------------------------- version : X.Y.Z Contact person : Yasuhiro Inamura e-mail : xxxxx.yyyyy@j-parc.jp --------------------------------------------- ファイル名と同様、X.Y.Zがリリース番号である。 |image13| アンインストール ==================== Windowsデフォルトのアンインストール（スタートメニュー >> コントロールパネル >> プログラム >> プログラムのアンインストール）や、空蟬パッケージインストーラーを起動しアンインストールを選択する。 ただし、完全には消去されず、幾つかフォルダやファイルが残される。それらは手動で消去して良い。 +--------------------------------------+ |C:¥¥Program Files¥Utsusemi（フォルダ）| +--------------------------------------+ また、幾つかの設定ファイルがフォルダに入って残されている。次回インストールした時に初期設定として呼び出されるが、消去しても良い。 +---------------------------------------------------------------+ |C:¥¥Users¥"ユーザーネーム"¥AppData¥Roaming¥Utsusemi（フォルダ）| +---------------------------------------------------------------+ 問題が発生した場合 ====================================== 問題が発生する場合、以下の二つの場面が考えられる。 インストール直後の問題 インストールしたのにアプリが起動しない、といったインストール直後に発生している問題の大部分は、インストールに失敗しているか、環境設定が適切になされていないか、のどちらかの原因が濃厚である。 一度アンインストールし、再度インストール、環境設定を行うこと。 それでもエラーなどが出る場合、その状況を担当者に伝えること。 過去によくあったのが、 - 空蟬の条件（Python 3.7.x, 64bit）に合致していないPythonがインストールされている - Pythonが２種類以上インストールされている などである。なお、2種類インストールされていた場合、大抵どちらかが壊れている可能性が高く、正しくアンインストールできないことがある。その場合は、 1. アンインストールできるPythonは、アンインストールする。 2. 壊れてアンインストールできない方は、そのバージョンをインストールしたPythonインストーラを起動し、インストールではなく「修復」を選択し、正しくインストールされた状態にする。 3. 改めて修復したPythonをアンインストールする。 4. 最後に正しいPythonをインストールする。 コマンド実行中の問題もしくは可視化ソフトウェア実行中の問題 想定とは異なる事象、例えばデータ処理が進まない、GUIのソフトウェアが想定される動作をしない（ボタンが効かない）などあった場合、症状とターミナルに表示されたログを担当者に送付すること。 症状に関しては、 - 何をしようとして - どのコマンド（ソフトウェア）を使用して - 何をしたら - どうなった の情報を担当者に報告・送付すること。 .. |image08| image:: media/win_Utsusemi4Install08.png :width: 200px .. |image09| image:: media/win_Utsusemi4Install09.png :width: 400px .. |image10| image:: media/win_Utsusemi4Install10.png :width: 400px .. |image11| image:: media/win_Utsusemi4Install11.png :width: 150px .. |image12| image:: media/win_Utsusemi4Install12.png :width: 400px .. |image13| image:: media/win_Utsusemi4Install13.png :width: 400px .. |image14| image:: media/win_Utsusemi4Install14.png :width: 140px .. |image15| image:: media/win_Utsusemi4Install15.png :width: 400px .. |image16| image:: media/win_Utsusemi4Install16.png :width: 400px .. |image17| image:: media/win_Utsusemi4Install17.png :width: 400px .. |image18| image:: media/win_Utsusemi4Install18.png :width: 400px