インストール及び環境設定

インストール及び環境設定#

著者:

稲村 泰弘

最終更新日:

Jul. 3rd, 2025

対応空蟬リリース:

4.0 or later

概要#

本項では空蟬を各種OSにインストールし、環境設定を行う方法を説明する。 バイナリパッケージはWindows版とmacOS版、Ubuntu/Mint Linux版を準備している。 また、AlmaLinux8, 9には半自動的にビルドし環境構築するスクリプトを用意している。

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

Available os and beam lines for Utsusemi#

OS and versions

Architecture

Beamlines

Windows 11

x86_64(amd64)

BL01, BL11, BL14, BL15

macOS 15(Sequoia)/14(Sonoma)/13(Ventura)

Apple silicon

BL01, BL02, BL11, BL14, BL15

Ubuntu Linux 22.04/24.04

x86_64(amd64)

BL01, BL02, BL11, BL14, BL15

Mint Linux 23/22

x86_64(amd64)

BL01, BL02, BL11, BL14, BL15

AlmaLinux 8/9

x86_64(amd64)

BL01, BL02, BL11, BL14, BL15 ,BL17

各種OSにおけるインストール#

各種OSにおけるインストールは、それぞれ下記にある手順に従って行う。

上記のインストールと環境設定が終わっていれば、続けて初期設定へ進むこと。

初期設定（共通）#

空蟬における初期設定は

  1. 必要なフォルダの作成（データフォルダ、データ処理用フォルダ）

  2. 環境変数の設定（アプリを使用）

である。

必要なフォルダの作成#

空蟬では解析用データの置き場所と一時ファイル保存場所をフォルダとして準備する必要がある。

Path to folders required by Utsusemi#

設定（環境変数名）

役割

データフォルダ (DATA_DIR)

イベントデータなどRAWデータを格納するフォルダ。（Linux版では”/data”）

解析用フォルダ (USR_DIR)

空蟬が作成する一時ファイルの保存先となるana/tmpなどのフォルダを置く場所である。（Linux版では”$HOME”）

作業フォルダ (WORK_DIR)

ユーザーが作業するフォルダ（アプリケーション起動時のカレントフォルダ）

この二つのフォルダは本来どこにあっても良い。 ただmacOSの場合は、セキュリティ強化により特にデータフォルダをデスクトップや書類フォルダ、共有フォルダに置くとアクセスできないことがある。したがって空蟬のmacOS版ではデフォルトの場所はホームフォルダ直下（/Users/<user name>/）としている。環境設定 Utsusemi Environment Setting （詳細は次項）の初回起動時にこの場所に自動的に作成される。この場所で不都合がある場合は、別途用意すること。

Example of path to folders required by Utsusemi on macOS#

必要なフォルダ

デフォルトの場所

データフォルダ

ホームフォルダ/Documents/Utsusemi/DATA

解析用フォルダ

ホームフォルダ/Documents/Utsusemi/HOME

作業用フォルダ

ホームフォルダ/Documents/Utsusemi/HOME
Example of path to folders required by Utsusemi on Windows#

設定

デフォルトフォルダ

データフォルダ

C:¥ユーザー¥ユーザー名¥ドキュメント¥Utsusemi¥DATA

解析用フォルダ

C:¥ユーザー¥ユーザー名¥ドキュメント¥Utsusemi¥HOME

作業用フォルダ

C:¥ユーザー¥ユーザー名¥ドキュメント¥Utsusemi¥HOME

環境設定#

次に空蟬自体の環境の設定を Utsusemi Environment Settings で行う。

  • macOSの場合

    • 「アプリケーション」フォルダ内の「Utsusemi」フォルダ、もしくは LaunchPad から UtsusemiEnvironmentSettings を起動する

  • Windowsの場合

    • スタートメニューから Utsusemi Environment Settings を起動する

  • Linuxの場合

    • ターミナルから EnvironSetting を起動する

    $ EnvironSetting
../../_images/UtusemiEnvironSettingsDlg01.png

なお、この作業はインストール後に一度は必ず行う必要がある。

このアプリケーションで設定できる内容は以下の通りである。

  • 使用する装置環境（BL01, BL02, BL10, BL11, BL14, BL15）

  • データフォルダと解析フォルダの設定

  • ログを残すかどうか

  • GUIアプリのデフォルトフォントサイズ

  • 高速化のための並列計算の数

  • デバッグモードのオン・オフ

よって、違う装置（ビームライン, BL）のデータを解析する場合は、この環境設定を立ち上げて装置環境を切り替える必要がある。

設定項目#

UtsusemiEnvironmentSettings で設定できるものは以下のものである。

Environment variables for Utsusemi on macOs after ventura#

設定（環境変数）

役割

Instrument

解析に使用するデータの装置の選択を行う。 これにより、使用するRAWデータフォルダ、使用できるコマンドなどが変化する。

Log quiet

解析コマンドのログを減らす場合に使用する。普段はYESで良い。 なおmacOSでの空蟬の実行ログは通常あらわには表示されない。すべてのログは /tmp/mlfsoft.log に書き込まれる。

Font Size

GUIアプリのフォントサイズを定義する。通常は12で良いだろう。大きくしたり小さくしたりはできるが、 GUIパーツ（ボタンなど）やレイアウトが崩れる可能性があるので注意。

Debug mode

空蟬のデバッグモード。普段はNO（チェックボックスオフ）で良い。

Number of threads

一部の解析コマンドが使用するマルチスレッドの最大値を設定する（通常は実行するPCのコアの数程度を設定すると良い）

DATA_DIR

イベントデータなどRAWデータを格納するフォルダ。（Linux版では”/data”）

USR_DIR

空蟬が作成する一時ファイルの保存先となるana/tmpなどのフォルダを置く場所である。（Linux版では”$HOME”）

WORK_DIR

ユーザーが作業するフォルダ（アプリケーション起動時のカレントフォルダ）

設定後#

設定項目を反映するために OK ボタンを押す。正しく設定されれば、確認のダイアログが表示される。

../../_images/UtusemiEnvironSettingsDlg02.png

このダイアログが出ずにエラーのダイアログが出た場合は、特に指定した DATA_DIR と USR_DIR のフォルダがあるかどうかを確認すること。この設定により、 USER_DIR の下に

  • ana フォルダ

  • この下に tmp フォルダ、および xml フォルダ

がなければ自動的に作成される。

../../_images/UtusemiEnvironSettingsDlg03.png

なお、 ana フォルダや tmp フォルダが見つからないようなら設定を見直すか、自分で作成しておくこと。 これらのフォルダがない場合 空蟬は正しく動作しない可能性がある 。

次に、DATA_DIR で設定した場所には、次節にて述べるルールでデータ（イベントデータなど）を配置する。

データの配置ルール#

環境変数 DATA_DIR で指定したフォルダに、以下のようなルールで配置する。

  1. 装置コードと同じ名前のフォルダを作成する（”SIK”, “AMR”, “SAS”など）。

  2. 装置コードのフォルダに、その装置でのRun Noのついたデータのフォルダを置く（”SIK012345_20150301”など）。

Examples of beam line RAW data folder#

BL

装置コード

配置例

BL01 四季

SIK

DATA/SIK/SIK012345_20160401

BL02 DNA

DNA

DATA/DNA/DNA012345_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

空蟬の実行#

環境設定が終了し、解析するデータの配置も終わったなら、アプリケーションのアイコンやターミナルから解析が行えるようになる。

How to launch applications#

アイコンから起動可能

Windows, macOS

ターミナルから起動可能

Linux, macOS

アイコンから起動#

Windows, macOSであれば空蟬のインストールにより、以下のアプリケーションもアイコンのダブルクリックで起動できるようになる。

SequenceEditor

空蟬でデータ処理作業のメインとなるアプリである SequenceEditor を起動する。

UtsusemiEnvironmentSettings/EnvironSetting

【環境設定】空蟬の環境変数を設定する。詳細は前述の「環境設定」以下を参照のこと。

MPlot, M2PlotPlus

空蟬で使用されるデータ可視化ソフトウェアである。それぞれ、1次元プロッタ、2次元プロッタである。詳細は空蟬ユーザーマニュアルを参照のこと。Linux版と同じ。

D4MatSlicer, D4Mat2Slicer

D4MatSlicer、およびD4Mat2Slicerを起動する。あとはLinux版と同じ。

UtsusemiShell

空蟬環境で、Shell（コマンドライン）を起動する。この上で環境設定にて指定したビームラインに応じたコマンドを呼び出すことができる。よって、自作のスクリプトを走らせることも可能である。

解析に使用するアプリケーションの詳細な説明は、空蟬ユーザーズマニュアルを参照のこと。

Note

Windows版の全アプリやmacOS版のいくつかのアプリ（SequenceEditor, D4mat, D4mat2）を起動させる場合、コマンドプロンプトやターミナルが必ず開いてからアプリが起動する。この連動したターミナルを閉じるとアプリも落ちるので注意すること。

ターミナルから起動#

LinuxやmacOSではターミナルから各種ソフトウェアを起動することができる（Windowsでは、スクリプトの実行のみ可能）。

Linux#

Linuxではターミナル内で（インストール後の環境設定が終わっていれば）各種アプリケーションをそのターミナルから起動できる。

export PATH=/opt/mlfsoft/python-utsusemi/utsusemi/bin:$PATH
Executable application in Linux terminal#

コマンド

起動するアプリ

EnvironSetting

環境設定

SequenceEditor

空蝉標準データ処理GUI

MPlot

1次元プロッタ

M2PlotPlus

2次元プロッタ

D4MatSlicer

非弾性単結晶データ可視化アプリ

D4Mat2Slicer

非弾性単結晶データ可視化アプリ

UtsusemiShell

空蝉環境ターミナル

macOS#

UtsusemiShell から各種ソフトウェアを起動することもできる。 空蟬環境が使用できるターミナルが立ち上がるので、ここで各種空蟬のコマンドや機能を利用することが可能となる。スクリプトを走らせたり、GUIを起動したりできる。

../../_images/UtsusemiShellIconMac.png

macOSでの UtsusemiShell の起動直後のターミナルの様子は以下のとおり。

===========================================
     You are ready to use Manyo-Lib.
===========================================
AMR HPN SAS SIK DNA NBR

===========================================
  Welcome to Utsusemi Environment for SIK
===========================================
 Ana   : Sequencer
 M2Plot: M2PlotPlus
 D4mat : D4MatSlicer
 D4mat2: D4Mat2Slicer
===========================================

 ------------------------------------------------------
|        ATTENTION
 ------------------------------------------------------
| If ERROR/core dump occurs on doing Utsusemi commands,
| run a command as below to reset Utsusemi environment.
| Or add this to the end of ~/.zshrc .
|
| $ source /Applications/Utsusemi/.opt/bin/_loadenv
 ------------------------------------------------------
yinamura@inamura-studio HOME %

ここで、 Ana と打てば SequenceEdirot が起動する。他にも M2Plot や非弾性散乱装置であれば D4mat , D4mat2 なども使用可能である。

macOSでのアプリ起動時の注意#

macOSで何らかのアプリケーションを実行した場合、下記のようなダイアログが開くことがある。

../../_images/WarningDlg01_macos.png

この場合、「インストール」を選択すると、インターネットに接続していれば自動的に最小限必要なソフトウェアがダウンロードされる。「キャンセル」を選択もできるが、次回以降も同じダイアログが開くことになる。なお「Xcodeを入手」を選ぶと、MacやiPhoneのアプリを作成するキットソフトウェア一式が導入され膨大な時間がかかるので気をつけること。

空蝉用Pythonスクリプトの実行#

アプリケーションを利用せずに、自分で作成したPythonスクリプトを実行することも可能である。特に現場で作成したスクリプト、新しい解析のアイデアを形にしたものなど用途は多い。

これらを自由に実行するためには、空蝉環境が設定されたターミナルやコマンドプロンプトが必要であるが、下記のような方法がある。

  1. UtsusemiShell の利用（Linux, macOS, Windows）

  2. ターミナル上で空蟬環境の設定追加（linux, macOS）

A. UtsusemiShell の利用#

UtsusemiShell に関しては前項で少し触れたが、これを用いるとシンプルな空蝉環境の設定でターミナルやコマンドプロンプトが起動する。 起動方法は、WindowsやmacOSならアイコンによる起動、Linuxならコマンド UtsusemiShell の実行で起動する。

UtsusemiShell 内部では、空蝉の環境設定が終わっているので、Pythonを起動して、空蝉関連の関数を呼び出すことも空蝉用のスクリプトを実行することも可能である。

UtsusemiShell 起動後の Windows での例

$ cd \C:\Users\Hoge\
$ python3 sample.py

B. ターミナル上で空蝉環境の設定追加#

linuxやmacOSの環境で、既に自分でターミナルの設定を行っていて、その環境で同時に空蟬環境も利用したい場合は、B.の形で利用する必要がある。その方法を以下に示す。

  1. ターミナルを起動する。

  2. 以下のコマンドを実行する。

macOS の場合

$ source /Applications/Utsusemi/.opt/bin/_loadenv

linux の場合

$ source /opt/mlfsoft/python-utsusemi/bin/_loadenv

  1. これで直接万葉ライブラリや空蟬の関数を呼び出すことができる。

$ python3
Python 3.9.12 (main, Apr 18 2022, 11:57:03)
[Clang 13.1.6 (clang-1316.0.21.2.3)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import Manyo
Manyo>>>

バージョンの確認#

インストールされた空蟬のバージョンを確認するには、以下の方法がある。バグなどの報告や、アップデートする際の目安となる。

インストーラファイルの名前に含まれている数字で判断する場合、以下のようなルールになる。

About release number#

例

Utsusemi_X.Y.Z_nnnn

X.Y.Z

リリース番号

nnnn

最終アップデート日付

また UtsusemiShell を起動し、以下のコマンドを実行することでも情報を得られる。

import utsusemi
utsusemi.__version__

実行結果：

'4.0.0'

もしくは、以下のようなコマンドでも可能である。

import UtsusemiInfo

実行結果は以下のとおり。

---------------------------------------------
               Utsusemi Info
---------------------------------------------
         version :  X.Y.Z (rev nnnnnn)
  Contact person : Yasuhiro Inamura
          e-mail : xxxxx.yyyyy@j-parc.jp
---------------------------------------------

ファイル名と同様、X.Y.Zがリリース番号、nnnnが最終アップデート日付である。

Contents