Quick Installation Guide of Utsusemi4 for Windows

Author

Yasuhiro Inamura, Ryoichi Kajimoto

Last update

Jul. 13rd, 2021

Utsusemi version

4.0 or later

Requirements for Windows

  1. Utsusemi4 works on only Windows 10 64bit version. We never support 32bit version.

  2. Account name of Windows must be constructed of English and numerical characters . If you use other character type ( Japanese, Chinese and so on ), you must create new accounts.

Preparation for installations

Confirmation before Utsusemi4 installation

Before installations, Python3 must be installed into Windows.

  • Python 3.7.x 64bit Only

  • Now Python 2.x is not supported.

Currently we’ve confirmed only the python environment for Utsusemi4 working as below.

Python Environment

URL

Available version

Anaconda

https://www.anaconda.com/products/individual

2021.05, 2020.11

2019.03

python.org

https://www.python.org/downloads/windows/

Only 3.7

Applications to be installed

You will find a set of Utsusemi software in the folder given during installation ( default is C:¥¥Program Files¥Utsusemi¥ ). And a shortcut is made at

“Start” menu -> All programs -> Utsusemi

image08

Here, the following programs will be prepared. The details will be described later.

Application

Description

D4MatSlicer

Launch D4MatSlicer

D4Mat2Slicer

Launch D4Mat2Slicer

M2PlotPlus

Launch M2PlotPlus

MPlot

Launch MPlot

SequenceEditorQ

Launch SequenceEditor

Utsusemi Environment Setting

[Environment setting] Set the environment valuables for Utsusemi

Utsusemi Shell

Launch “Terminal” with Utsusemi environment

Set up

Preparation (Creation of necessary folders)

The following two folders must be prepared. These folders store raw data and temporary files.

Folder (Environment valuable)

Description

Data folder (DATA_DIR)

Folder to store raw data (Same as “/data” in the Linux version.)

Analysis folder (USR_DIR)

Folder to include ana and tmp folders in which temporary files are stored (Same as “$HOME” in the Linux version)

The above two folders can be prepared in arbitrary places. For example,

Folder

Example

Data folder

C:¥User¥UserAccount¥Documents¥Utsusemi¥DATA

Analysis folder

C:¥User¥UserAccount¥Documents¥Utsusemi¥HOME

image09

Environment setting and requirements

The initial setting of Utsusemi must be done by using Utsusemi Environment Setting .

Warning

This setting must be done at least once after the installation.

Setting items are below.

  • The instrument environment

  • Two folders to store raw data and analysis temporal information.

  • Logging

  • The number of processers for high performance on analysis

  • Switching debug mode

If you analyze raw data set obtained from other instrument, you must change the instrument environment in this setting.

Launch Environment Setting

Launch Utsusemi Environment Settings from “Start” menu >> Utsusemi

image10

Setting Items

  1. Instrument

    Choose the instrument for data analysis. Raw data folder and executable commands are changed to suitable ones.

  2. Log quiet

    Turn on to decrease logs of analysis commands

Warning

All logs write in a file /tmp/mlfsoft.log. If something wrong happens on using Utsusemi, you should check this file.

  1. Number of thread

    Some analysis commands are affected by this value. Normally you set the number of CPUs in your PC.

  2. DATA_DIR and USR_PRIV_HOME

    modify or confirm the initial setting for two folders (setting of the environment valuables) described in previous section. Push Brows button opens small dialog to choose a folder for each.

    Environment valuable

    Purpose

    Example

    DATA_DIR

    Folder to store raw data (Same as “/data” in the Linux version)

    Documents/Utsusemi/DATA

    USR_DIR

    Place to locate “ana” and “tmp” folders for temporary files are stored (Same as “$HOME” in the Linux version)

    Documents/Utsusmei/HOME

Finishing Setting

After setting, push OK button. Then you see confirmation dialog as below.

image11

If you meet an error dialog instead of this, check whether the given path to two folders are existed or not.

After closing this dialog, following folders are automatically created in the folder specified by USR_DIR.

  • ana folder

  • tmp folder and xml folder under ana folder

    image11

If there is no folder above, Utsusemi Environment Settings makes these folders automatically.

Warning

If you cannot find these folders, you must make them by yourself to avoid the failure of Utsusemi launch.

On the other hand, you make folders to store raw data DATA_DIR according to a rule described in next section.

Rule for data location

Raw data should be stored in the folder specified by DATA_DIR according to the following rule.

  1. Create a folder who has the same name as the instrument code.

    For example, “SIK” for 4SEASONS (BL01) and “AMR” for AMATERAS (BL14).

  2. Place the data folder of corresponding instrument in this folder. The name of the data folder must include each Run No.

    For example, “SIK012345_20150301” for 4SEASONS.

    BL

    Instrument code|Example of data folder

    BL01 4SEASONS

    SIK

    DATA/SIK/SIK012345_20160401

    BL11 PLANET

    HPN

    DATA/HPN/HPN012345_20160401

    BL14 AMATERAS

    AMR

    DATA/AMR/AMR012345_20160401

    BL15 TAIKAN

    SAS

    DATA/SAS/SAS012345_20160401

    BL19 TAKUMI

    ENG

    DATA/ENG/ENG012345_20160401

Data analysis

After completing the environment setting and preparing raw data, you can perform data analysis.

The following applications are available from “Start” menu.

Utsusemi Environment Setting

[Environment setting] Set and confirm the environment valuables for Utsusemi. Refer to “Launch Environment Setting” section.

MPlot, M2PlotPlus, SliceViewer

Launch Utsusemi Plotters. Same as ones in Linux version.

MPlot

1-dimentional data plotter

M2Plot

2-dimentional data plotter and slicer
D4MatSlicer , D4Mat2Slicer

Launch D4MatSlicer or D4Mat2Slicer, same as one in Linux version.

SequenceEditorQ

Launch SequenceEditor, same as one in Linux version.

Utsusemi Shell

Launch CommandPrompt under Utsusemi environment. In this terminal, you can execute commands defined on the selected instrument environment and any script made by yourself.

For details of each application, please refer to Utsusemi Users’ Manual.

Running Utsusemi on CommandPrompt

Python scripts including Utsusemi commands can be run without utilizing the above applications. In particular, if you try any new idea of data analysis, you need to utilize the Utsusemi environment on the CommandPrompt app. The following is the procedure.

  1. Launch Utsusemi Shell by click its icon.

  2. Command Prompt is running with Utsusemi environments. Then you can change current working directory.

  3. You can launch python interpreter on Command Prompt to execute any script.

Version number confirmation

Utusemi version can be seen in the following ways. It is useful when you report bugs or update Utsusemi.

  1. Installer file name

    Installer file name consists of two sets of numbers.

    Example

    MLFSOFT.X.Y.Z.yymmdd

    X.Y.Z

    Release number

    yymmdd

    Last update date
  2. Execute command in Utsusemi Shell

    Launch Utsusemi Shell, and run the following command.

    >>> import utsusemi
>>> utsusemi.__version__
'4.0.0'

    or

    >>> import UtsusemiInfo

    Then, the following information is displayed.

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

    X.Y.Z is the release number.

Uninstall

To uninstall Utsusemi, allow the default uninstall way on Windows.

  1. “Start” menu -> Control Panel -> Programs -> Uninstall

  2. Launch Utsusemi installer and choose “Uninstall” button.

However, this does not completely all the relevant files, and some folders show below are remained. Delete them manually is you want.

C:¥¥Program Files¥Utsusemi (folder)

In addition, several configuration files are remained. Although these files will be used when you re-install Utsusemi, you may delete them.

C:¥¥Users¥UserAccount¥AppData¥Roaming¥Utsusemi (folder)

Troubleshooting

Mainly troubles cause at two situations as below.

The problem happened just after installation

After installation, the applications are not launched, almost of such troubles cause from a failure of installation or from incorrect environment settings. Once you should uninstall and install again at first. Then do environment settings. If trouble comes though re-installation, please tell us a report.

In past, we’ve met these troubles

  • version of the installed Python is invalid. ( python 32bit installed )

  • two or more Pythons are installed.

  • Add python.exe to Path setting is skipped at the installation of Python.

To solve of multiple python installations, following is the procedure.

  1. Try uninstall for each python.

  2. Some python will be not uninstalled because of the broken python program. At that time, find and launch the python installer of broken version and choose “Repair” instead of “Install” to fix the program.

  3. Try uninstall again.

  4. At last, install correct version of python.

Error happens during executing commands

If you feel something wrong on Utsusemi works, for example no progress of commands steps, please send a report about your situations and a log shown in CommandPrompt window.

About situations of troubles

To report your trouble, you include the information as below :

  • What you are going to

  • Which software or command you are using

  • What you did

  • What happened