Windows用バイナリ版インストール#

著者:

稲村 泰弘

最終更新日:

May. 19th, 2025

対応空蟬リリース:

4.0 or later

概要#

本章では空蟬をWindows環境にバイナリパッケージでインストールする方法を示す。

なお、2023年4月現在で、対応しているMLFにおけるビームラインは以下の通りである。

Available beam lines for Utsusemi on Windows#

BL(code)

注意点

状況

BL01(SIK)

特になし

対応済み

BL14(AMR)

特になし

対応済み

BL15(SAS)

Dviewは含まず

対応済み

動作環境#

本章で動作を保証するWindowsは以下の通りである。

Available Windows version#

Windows

Architecture

11

x86_64 (amd64)

これら以外の環境(32bit版も含め)は今後もサポートする予定はない。

事前の確認事項#

アカウント名やフォルダ名に関して注意すべき点がある。 空蝉ソフトウェアで使用するデータを置いておくフォルダが日本語であったり、途中のパスに日本語が含まれていると動作しないことがある。

これにはアカウント名も含まれるため、まずインストールするWindowsの管理者ユーザーのアカウント名が 英数字 でなければならない。

既にアカウント名に日本語を利用していた場合、新たに英数字のアカウント名でユーザーを作成し、そちらでログインしてからインストールする必要がある。新たにアカウントを作成する方法などは省略する。

Account name examples#

条件

良い例

悪い例

アカウント名が英数字

Inamura

稲村

パスに含まれるフォルダ名が英数字

C:¥¥data¥Inamura¥run1234

C:¥¥data¥稲村¥run1234

手順の概要#

  1. 環境構築(Minimumタイプのみ必要)

  2. インストーラによるインストール(All-in-one、Minimumタイプ)

  3. 環境設定

インストール#

インストーラのタイプ#

Windows版には、以下の2種類のインストーラがあるので、環境に合わせて利用すること。

Type of installation#

タイプ

説明

ファイル名の例

All-in-one

Python含め全て同梱されている。(推奨)

Utsusemi.4.0.230403.x86_64.msi

Minimum

Python環境はない最小限のインストーラ。Python3.9.xのみ対応。 Pythonの環境は自分で構築する必要がある。中・上級者向け。

Utsusemi_minimum.4.0.230403.x86_64.msi

空蟬本体のインストール#

ここでは、All-in-oneタイプのインストーラでのインストールを示す。なお、MinimumタイプにはあらかじめPython環境が必要であるが、要件は次節にて示す。

空蟬パッケージインストーラをダブルクリックしてインストールを行う。

../../_images/win_UtsusemiInstallIcon.png

なお、既に以前のバージョンの空蟬が入っている場合、一旦以前の空蟬をアンインストールしてから行うこと。

  1. インストールウィザードが現れるので、以降は基本的に「 Next 」で進めて行く。

../../_images/win_UtsusemiInstall01.png
  1. 使用許諾書の表示が表示されるので、同意して「 Next 」ボタンを押す。

../../_images/win_UtsusemiInstall02.png
  1. インストール先の確認が出る。よければ「 Next 」ボタンを押す。(デフォルトでは “C:¥¥Program Files¥Utsusemi¥”)

../../_images/win_UtsusemiInstall03.png
  1. インストール準備完了の表示が出るので、「 Install 」ボタンを押す。

../../_images/win_UtsusemiInstall04.png
  1. 途中でユーザーのアカウント制御のダイアログが出た場合、「Yes」を押す。

../../_images/win_UtsusemiInstall05.png
  1. おおよそインストールに2〜3分程度かかる。

../../_images/win_UtsusemiInstall06.png
  1. 以下のようにダイアログが出ると正常に終了している。「 Finish 」ボタンを押して終了する。

../../_images/win_UtsusemiInstall07.png
  1. スタートメニューからインストールされた Utsusemi ソフトウェアを確認できる。

../../_images/win_UtsusemiInstall08.png

Minimumタイプの場合#

Minimumタイプは、Python3.9(2023年4月現在)の環境にのみ対応している。

インストール前に必要なことは以下であるが、詳細は述べない(本章末尾のAppendix参照のこと)。

  • Python3.9及び、必要なパッケージのインストール

  • コマンドプロンプトからPython3.9が実行でき、パッケージのimportもできるようにしておく

なお、Pythonと必要なパッケージを以下に示す。

list of the packages required by a minimum BinaryInstaller for win#

Python

3.9.x

Packages

numpy, scipy, matplotlib, PySide6

結局のところ必要となる環境は、起動したコマンドプロンプト内でPython3.9インタプリタから下記のようなコマンドを実行してエラーが出ない環境である。

C:\Users\hoge>python
Python 3.9.16 (main, Mar  8 2023, 10:39:24) [MSC v.1916 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information
>>> import numpy
>>> import scipy
>>> import matplotlib
>>> import PySide6

インストールされるアプリケーション#

空蟬ソフトウェア群は、インストール時に指定した場所(C:¥¥Program Files¥Utsusemi¥)にある。 また、アプリケーションへのショートカットが、以下の場所に作成される。

「スタート」メニュー >> Utsusemi

../../_images/win_UtsusemiInstall08.png

ここには以下のプログラムが準備されている。詳細は後で述べる。

List of Utsusemi Applications installed#

Utsusemiアプリケーション

説明

D4MatSlicer

D4MatSlicerを起動する。

D4Mat2Slicer

D4Mat2Slicerを起動する。

M2PlotPlus

M2Plotを起動する。

MPlot

MPlotを起動する。

SequenceEditorQ

SequenceEditorを起動する。

Utsusemi Environment Settings

【環境設定】空蟬のフォルダ環境変数を設定する。

Utsusemi Shell

Utsusemi環境が設定されたターミナルを起動する。

アンインストール#

空蟬のアンインストールを行う場合、Windowsデフォルトのアンインストール(スタートメニュー >> コントロールパネル >> プログラム >> プログラムのアンインストール)や、空蟬パッケージインストーラを起動しアンインストールを選択する。

ただし、完全には消去されず、幾つかフォルダやファイルが残される。それらは手動で消去して良い。

C:¥¥Program Files¥Utsusemi(フォルダ)

また、幾つかの設定ファイルがフォルダに入って残されている。次回インストールした時に初期設定として呼び出されるが、消去しても良い。

C:¥¥Users¥”ユーザーネーム”¥AppData¥Roaming¥Utsusemi(フォルダ)

問題が発生した場合#

問題が発生する場合、以下の二つの場面が考えられる。

インストール直後の問題#

インストールしたのにアプリが起動しない、といったインストール直後に発生している問題の大部分は、インストールに失敗しているか、環境設定が適切になされていないか、のどちらかの原因が濃厚である。 一度アンインストールし、再度インストール、環境設定を行うこと。 それでもエラーなどが出る場合、その状況を担当者(著者)に伝えること。

過去によくあったのが、

  • 空蟬の条件(Python 3.7.x, 64bit)に合致していないPythonがインストールされている。

  • Pythonが2種類以上インストールされている。

などである。なお、2種類インストールされていた場合、大抵どちらかが壊れている可能性が高く、正しくアンインストールできないことがある。その場合は以下のような対応を行うこと。

  1. アンインストールできるPythonは、アンインストールする。

  2. 壊れてアンインストールできない方は、そのバージョンをインストールしたPythonインストーラを起動し、インストールではなく「修復」を選択し、正しくインストールされた状態にする。

  3. 改めて修復したPythonをアンインストールする。

  4. 最後に正しいPythonをインストールする。

コマンド実行中もしくは可視化ソフトウェア実行中の問題#

想定とは異なる事象、例えばデータ処理が進まない、GUIのソフトウェアが想定される動作をしない(ボタンが効かない)などあった場合、環境と空蟬のバージョン、及び症状とターミナルに表示されたログを担当者(著者)に送付すること。

症状の報告について#

症状に関しては、

  • 何をしようとして

  • どのコマンド(ソフトウェア)を使用して

  • 何をしたら

  • どうなった

の情報を担当者(著者)に報告・送付すること。

Appendix#

Minimum install用環境作成例#

Python.org利用#

Python.org (https://www.python.org/) のPythonインストーラーを利用して構築する例を簡便に示す。

  • Python.orgのDownloads (https://www.python.org/downloads/)から、python3.9.13(3.9系列でWindowsバイナリ配布されている最新版)をダウンロードしインストール。

  • インストールダイアログで Add Python to PATH にチェックを入れて環境変数PATHに設定されるようにしておく。

  • Pythonのインストール終了後、Command Promptアプリから、pipで numpy, scipy, matplotlib, PySide6をインストールする。

python -m pip install scipy
python -m pip install matplotlib
python -m pip install PySide6
  • Minimum Installerで空蝉をインストールする。(これからは All-in-oneと同じ)

Anaconda利用#

Anacondaを利用して環境を構築する例を簡便に示す。

Warning

AnacondaでPython環境を作ると一部のパッケージ(PySide6)がcondaで入れられずpipで入れることになるので、両者が混在(conda + pip)することで問題が発生する可能性もあるので注意

最新のAnacondaではPython3.10が使用されるので、Python3.9を使用する環境を作成する必要がある。その過程も含めて示す。

  • Anacondaをインストールする。

  • Python3.9環境を作成する。

    1. “Anaconda Navigator”を起動する。

    2. 左の欄にある”Environments”を選ぶ。

    3. “base(root)”や”Anaconda3”などが並んでいるが、下にある”Create”ボタンで新しい環境(本節では以降、”Python3.9”)を作成、その際に目的のPythonのバージョン3.9を選択する。

  • Python3.9環境の有効化

    1. “Anaconda prompt”起動する。

    2. conda info -e を実行し、新しい環境(環境名 “Python3.9”)があることを確認する。

    3. conda active Python3.9 を実行し、新しい環境に切り替える。

  • パッケージのインストール

    1. “Anaconda Navigator”の”Environments”から新しい環境”Python3.9”を選択する。

    2. 左の欄を用いて、 “numpy”, “scipy”, “matplotlib” をインストールする。

    3. ただし、”PySide6”は存在しないので、別途pipをインストールし、適当なコマンドプロンプト上で、python -m pip install PySide6を実行した。

  • コマンドプロンプトから上記のPython3.9環境を利用できるようにする。

    1. pathを通すために、環境の場所を確認する(通常 ホームフォルダの下の”Anaconda3\envs”の中にある C:UsershogeAnaconda3envsPython3.9 )。

    2. 環境変数PATHに、確認したPython3.9環境のパスや、その下のパスを以下のように追加する。

C:\Users\hoge\Anaconda3\envs\Python3.9\
C:\Users\hoge\Anaconda3\envs\Python3.9\Scripts
C:\Users\hoge\Anaconda3\envs\Python3.9\Library\bin