Ubuntu 14.04 LTS 及び 16.04 LTSへの簡易インストール

著者

稲村泰弘

最終更新日

2018/02/21

概要

空蟬はLinux上で開発されており、本来Linux上でのみ動作するものである。基本的な関数は万葉ライブラリを利用して作成しており、C++コードで書かれている。またGUIや可視化のソフトウェアに必要となるwxPythonやmatplotlibといったPythonに関連するライブラリが必要である。よって空蟬のインストールにはそれぞれ必要となるライブラリを別途インストールする必要があり、困難な作業である。 そこで、ソースコードのコンパイル、必要なライブラリの別途インストールなどを簡単に行うためのスクリプトを準備している。その簡易インストールの手順を示す。

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

BL(code)

注意点

BL01(SIK)

特になし

BL02(DNA)

QENSfitは含まず

BL14(AMR)

特になし

BL11(HPN)

Teuseは含まず

BL15(SAS)

Dviewは含まず

対象とするOS

本稿での対象OSは Ubuntu 14.04 LTSおよび 16.04 である。

Ubuntuは、もっとも導入が優しいLinuxディストリビューションの一つであり、必要なライブラリが全てパッケージ化されていることから選択された。

また、 Ubuntuは目的のPCに既に導入されていることを想定 している。また極力OSに付属するパッケージを利用するため、そのOSに対応したインストール用レポジトリにアクセスできる、つまりPCがネットに接続された状態にしておくこと。

他のOS（CentOSなど）にインストールしたい場合は、開発マニュアルを参照のこと。

求められるハードウェア環境

快適な解析環境のために、ある程度の性能のPCを準備すべきである。

表：推奨PC環境

推奨するスペック

CPU

Core2 Duo以上

メモリ

最低4GB、多ければ多いほどよい。

ハードディスク

ソフトウェア自体は100MB程度であるが、扱いたいデータに依存する。

ネットワーク

インストールには、インターネットへの接続は必須

OSは、先に述べたようにLinuxの Ubuntu Linux 14.04 LTS および16.04 LTS である。ただし、Ubuntu自体のインストールに関しては本稿では触れない。

Ubuntu Linuxは既にPCにインストール済みであるとする。

用意するファイル

Ubuntuに空蟬環境をコンパイル・インストールするためのスクリプト、およびソースコードは一つの圧縮ファイルで存在する。

Utsusemi_0.3.6_r1136_180221_Ubuntu_1404_1604LTS.tar.gz Utsusemi_0.3.6_r1136_180221_Ubuntu_1404_1604LTS.zip

ファイル名の0.3.5.1はリリース番号と呼ばれ、比較的大きなバージョンアップがあった場合に新たに付与される。r1131はソースコードのバージョンでリリース番号とは独立にコードのアップデートとともに増加する。そのあとの171108はパッケージの作成日付を表しており、従って入手時期により変動する。入手方法は、当面装置責任者かソフトウェア担当者に直接尋ねること。

手順

主な手順としては、以下の通りである。

  1. インストールするPCのインターネットへの接続確認

  2. 圧縮ファイルの展開

  3. インストールスクリプトの実行

以降の手順では、圧縮ファイルはユーザーのホームディレクトリに存在するものとする。

インターネットへの接続確認

インストール途中でインターネットへの接続を行うので、インターネットに接続していることを確認する。Webブラウザなどで確認する程度でよい。ネットワークの設定や、確認方法は割愛する。

圧縮ファイルの展開

$ tar xzvf Utsusemi_0.3.6_r1136_180221_Ubuntu_1204_1404LTS.tar.gz

…（ログ）

結果として、Utsusemi_0.3.6_r1136_180221_Ubuntu_1204_1404LTSという名前のディレクトリが作成される。以下のように確認できる。

$ ls -F Utsusemi_0.3.6_r1136_180221_Ubuntu_1204_1404LTS/

Utsusemi_0.3.6_r1136_180221_Ubuntu_1204_1404LTS.tar. gz

なお、Utsusemi_0.3.6_r1136_xxxディレクトリには以下のファイルやディレクトリが存在する。

$ ls –F Utsusemi_0.3.6_r1136_180221_Ubuntu_1204_1404LTS

Install.py src/

インストールスクリプトの実行

まず、先ほど展開したディレクトリへ移動する。

$ cd Utsusemi_0.3.6_r1136_180221_Ubuntu_1204_1404LTS

インストールスクリプトを下記のように実行する

$ python Install.py

すると、以下のようなメインメニューが現れる。

$ python Install.py

=================================================================
     Welcome to Utsusemi software installer (ver.C0.3.6)
=================================================================

----------------------------------------------------------
 Install Directories
    MLF software root (Manyo, Utsusemi): /opt/mlfsoft
    User's home directory : /home/yinamura
    RAW data Directory : /data
----------------------------------------------------------


-----------------------------------------------------------------
       Utsusemi Install Main Menu for Debian or Ubuntu
-----------------------------------------------------------------

  0... Install ALL modules for an instrument

           note: this will DELETE all of modules installed before.

  ----------------------------------------------------
  1... Required Ubuntu Packages
  2... Utsusemi software (Manyo-lib and common code)
  3... Utsusemi software for each BL

  7... Change Install Directories

  9... Uninstall

others.. exit
-----------------------------------------------------------------
>> Which ?

ここで、行いたい作業の数字を打ち込む。

なお、メニューの頭に表示されているインストール先となるディレクトリは、メニュー７で変更可能である。初期状態では、MLF計算環境公式の場所である。もしユーザーのホームディレクトリにインストールしたい場合は、７を選ぶこと（詳細は2-6節）。

表：メニュー番号とその動作

番号

動作

０

全てのインストールを自動で行う。全く最初のインストールの時や、新しいバージョンにすべて置き換えるとき等に使用する。 これは以下にあるメニュー番号1,2,3,4を順次実行することと同等である。

１

空蟬環境をインストールするために必要なUbuntuのパッケージを自動でインストールする。Ubuntu自身の機能を用いるため、 インターネットに接続している必要がある。

２

Manyo-lib＋空蟬の自動インストールを行う。この過程ではソースコードからのコンパイルが入るため、少々時間がかかる。

３

空蟬の装置依存コードのインストールと設定を自動で行う。装置ごとに設定が異なるため、インストール時に装置を選択する 必要があるが、別の装置の環境をインストールしたいときに使用する。

７

インストール先を変更する。（詳細は2-6節）

９

インストールされた空蟬環境を取り除くのに使用する。

例として、０を選び、すべてをインストールする。

>> Which ? 0 [リターン]

この後さらに、Manyo-libのマルチスレッド対応のために動作させる最大スレッドの数を入力する。通常はそのPCのコア数でよいだろう。

Please input the number of threads, which is required to use
Manyo-lib with multi-threads.

>> How many threads? [>=1, default=1]

これらの質問に答えると、実際のコンパイルやインストール作業に入る。その際、システム管理者の権限(root)が必要となるので、以下のようにパスワードが聞かれることがある。そのユーザーのパスワードを打ち込むこと。

[sudo] password for hoge:

これらの後、自動的にコンパイルやインストール、必要なディレクトリの作成、コードのコピー、環境の設定などが行われる。大量のログが流れる。大まかな順序は、メニューにあった項目の順である。具体的に何をやっているか知りたい場合は4章以降を参照のこと。

特に問題がなければ、数分で終了する。最後に

-----------------------------------------------
  Install of
       - manyo-core
       - manyo-utsusemi
       - python-utsusemi
       - python-utsusemi-SIK
       - python-utsusemi-AMR
       - python-utsusemi-HPN
       - python-utsusemi-SAS
       - manyo-SAS
       - manyo-TKtools
       - python-utsusemi-TKtools
                               were completed.
-----------------------------------------------


-------------------------------------------------------
  Utsusemi Base Environment Setting has been completed.
-------------------------------------------------------

----------------------------------------------------------
  Utsusemi Environment Setting for SIK has been completed.
----------------------------------------------------------

----------------------------------------------------------
  Utsusemi Environment Setting for AMR has been completed.
----------------------------------------------------------

----------------------------------------------------------
  Utsusemi Environment Setting for HPN has been completed.
----------------------------------------------------------

----------------------------------------------------------
  Utsusemi Environment Setting for SAS has been completed.
----------------------------------------------------------

----------------------------------------------------------
  Utsusemi Environment Setting for TKtools has been completed.
----------------------------------------------------------

Utsusemi Default Install was completed.
>> Back to Main Menu? [Y/n]

と表示されて終了する。

>> Back to Main Menu?[Y/n]

と聞かれるので、終わるならnを入力すること。リータンだけやyを入力すると、先のメインメニューへ戻る。

メニューで2を選んだ場合

Manyoライブラリのインストールを行う。

選択後に、Manyo-libのマルチスレッド対応のために動作させる最大スレッドの数を入力する。通常はそのPCのコア数でよいだろう。

Please input the number of threads, which is required to use
Manyo-lib with multi-threads.

>> How many threads? [>=1, default=1]

これらの質問に答えると、実際のコンパイルやインストール作業に入る。その際、システム管理者の権限(root)が必要となるので、以下のようにパスワードが聞かれることがある。そのユーザーのパスワードを打ち込むこと。

[sudo] password for hoge:

メニューで3を選んだ場合

BL毎に個別にインストールを行う。

選択後に、メニュー2を実行したか聞かれるので、確認すること。

>> Have you installed ManyoLib and Utsusemi Base system ( menu number 2 ) [y/N]?

続けて以下のようにインストールするビームラインの選択が行われる。

---------------------------------
  Select Beam Lines you install
---------------------------------
 [ 1] BL01 4SEASONS (SIK)
 [ 2] BL02 DNA (DNA)
 [14] BL14 AMATERAS (AMR)
 [11] BL11 PLANET (HPN)
 [15] BL15 Taikan (SAS)
 [TK] TKtools
 [-1] Exit menu
---------------------------------

>> Which Package?

必要な数字を打ち込んでリターンする。四季(BL01)なら１を、アマテラス(BL14)なら１４を入力する。もし-1であれば、このメニューから抜ける。

空蟬環境の有効化

必要なソフトウェアはすべてインストールされている。空蟬環境を実行するための設定（~/.bashrcに書かれている）を有効にするために、以下のようにコマンドを打つ。

$ source ~/.bashrc

もしくは、ターミナルを閉じて、再度開くと有効となっている。

環境が有効になったかどうかは、それぞれの分光器の環境へ移るためのキーワードを打ち込む。キーワードは、各分光器の略称である。

装置

キーワード

四季(BL01)

SIK

DNA(BL02)

DNA

アマテラス(BL14)

AMR

大観(BL15)

SAS

例えば四季の場合なら

$ SIK
===========================================
 Welcome to Utsusemi Environment for SIK
===========================================
 Ana : Sequencer
 D4mat : D4MatSlicer
 Inv : MethodAssistant
===========================================
$

と表示されて、空蟬環境への移行が完了したことがわかる。 以降は次章の「起動の確認」へ。

アンインストール

主な手順としては、インストールスクリプトを起動し、メニューから

9..... Uninstall

を選択する。

なお、まだいくつかの設定ファイルが残っている。これの消去はまた別項で述べる（予定）。

インストール先のディレクトリについて

デフォルトのインストール先

デフォルトのインストール先は、下記のようになっている。

表現

デフォルト場所

説明

MLF (Utsusemi) software directory

/opt/mlfsoft/

Manyo-lib、空蟬用Manyoライブラリをインストールする場所。

RAW data directory

/data

各分光器のイベントデータディレクトリが置かれる場所。 この場所に 解析に必要となる各装置のデータを置くためのフォルダ

SIK/

AMR/

などが作成される。

Users' home directory

/home/XXXXX

( ~/ )

一時保管用の解析用パラメータファイル等が置かれるディレクトリ

ana/

exp/

などが置かれる場所。

以上の場所は、MLFの標準に近いものとなっている。

ただし、インストール先が/opt/mlfsoftなど他のユーザーにも影響がないとも限らない場所であるため、個人のディレクトリにインストールも可能となっている。その変更はインストールメニュー７で行うことができる。

個人のディレクトリへのインストール

個人のディレクトリにインストールする際のデフォルトは以下のようになっている。

場所

MLF (Utsusemi) software directory

~/mlfsoft

RAW data directory

~/mlfsoft/RAWDATA

Users’ home directory

~/

この場合、ソフトウェアのアンインストールは、ほぼ~/mlfsoftディレクトリを削除するだけでほぼ終了する。

インストールメニュー７を選ぶと

------------------------------------------------
Install Directories Menu
----------------
1..... Change Directories to private area
2..... Return Directories to MLF default
3..... Load Previous Install Directories
4..... Show Present Setting

0..... Exit
>> Which?

というメニューが現れる。ここで１を入力すると、以下のようにデフォルト設定の個人用インストール先が示される。

============================================================
                 Set your install paths
============================================================
 1. Path to install Utsusemi software
   --> /home/yinamura/mlfsoft

 2. Path to Event data directory
   --> /home/yinamura/mlfsoft/RAWDATA

3. Path to user directory (for ana/xml or exp/xml)
   --> /home/yinamura
============================================================

>> Which do you change ? [1 to 3. 0 to exit]

もしさらに変更を加えたいならその番号を入力する。変更が不要であれば０を入力すると一つ前の「Install Directories Menu」に戻るので、そこでさらに０を入力するとメインメニューへ戻る。なお、元のMLF計算環境準拠の設定に戻る場合は「Install Directories Menu」で２を選ぶとよい。

メインメニューへ戻ると、メニュー上部にあるInstall Directoriesの情報が変更されているはずである。

空蟬のバージョン確認

前節の空蟬環境の有効化を済ませたのちに下記のコマンドを入力する。

$ python
>>> import UtsusemiInfo
---------------------------------------------
               Utsusemi Info
---------------------------------------------
         version : 0.3.6(r1136)
  Contact person : Yasuhiro Inamura
      e-mail : yasuhiro.inamura@j-parc.jp
---------------------------------------------

Manyo>>>

ソースコードのリリース番号とバージョン番号が表示される。何か空蟬で問題が発生した場合はこの情報も一緒に連絡していただきたい。