.. _Top:

Welcome to M-DaC Tutorial（日本語）   
=======================================

:ref:`English`

| NIMS_ では計測機器メーカーなどと協力して材料データに関する各種変換ツール(Materials Data Conversion Tools( **M-DaC** )を開発しています。
| **M-DaC** では、これらのツールを **MITライセンス** のもとで公開しています。
| これらのツールは `Jupyter Notebook`_ でも実行できます。

News
-----

| [2020/04/15] version 1.2 released. 2D-XRD(リガク)のツールを公開しました。
| [2020/04/10] version 1.1 released. AES(JEOL、ULVAC PHI)のツールを公開しました。
| [2019/01/30] version 1.0 released. XPS(ULVAC-PHI対応)、XRD(Rigaku対応)のツールを公開しました。


Quick Start【XPSを事例に】
-----------------------------

 リポジトリをクローンまたはzipでダウンロードします。   :: 
          

	git clone https://github.com/nims-dpfc/M-DaC_XPS.git myproject
	cd myproject

.. index::
	single: proxy(git)

.. note::

	fatal: unable to access 'https://github.com/...': Couldn't resolve host 'github.com' のエラーが出た場合はプロキシの設定を行ってください。  


	プロキシの設定は以下のように行います。  ::

		git config --global http.https://github.com/nims-dpfc/M-DaC_XPS.git.proxy http://[proxy]:[port]

	[proxy],[port]は使用環境に合わせて設定します。



ツールディレクトリに移動します。  ::

	cd PHI_XPS_survey_narrow_tools

コマンドを実行します。  ::

	MPExport.exe -Filename:"..\source\XPS_PHI_QUANTERA_survey.spe" -TSV

	python txt2csv.py "XPS_PHI_QUANTERA_survey.txt"

	python csv2graph.py "XPS_PHI_QUANTERA_survey.csv"

	python txt2raw_XPS_survey.py "XPS_PHI_QUANTERA_survey.txt" xps_raw_template.xml raw.xml

	python raw2primary_XPS_survey.py raw.xml xps_primary_template.xml primary.xml

カレントディレクトリに各種変換されたファイルが作成されます。 

`Jupyter Notebook`_ で実行する場合は jupyter notebook を立ち上げます。  ::

	jupyter notebook

チュートリアルにある「 `Jupyter Notebookでの実行`_ 」を参考に各種コマンドを実行します。
``xps_survey.ipynb`` を使用すると簡単に実行できます。

XPS_surveyの実行方法についての動画です。 

.. raw:: html

    <div style="text-align: center; margin-bottom: 2em;">
    <iframe width="100%" height="350" src="https://www.youtube.com/embed/Y5supLBk3kY?rel=0" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
    </div>




.. _English:

Welcome to M-DaC Tutorial Page. (in English)
===============================================
:ref:`Top`


| In NIMS_, we are developing various conversion tools called **M-Dac** (Materials Data Conversion Tools)for material data in cooperation with measurement equipment manufacturers.
| **M-DaC** is releasing these tools under **MIT license**. 
| It is possible to run these tools by `Jupyter Notebook`_ .

News
-----
| [2020/04/15] version 1.2 released. Release of 2D-XRD(Rigaku) tools.
| [2020/04/10] version 1.1 released. Release of AES(JEOL,ULVAC PHI) tools.
| [2019/01/30] version 1.0 released. Release of XPS(ULVAC-PHI compliant) and XRD(Rigaku complliant) tools.


Quick Start【Example for XPS case.】
----------------------------------------


Download the repository via git clone or zip.    :: 
    
    git clone https://github.com/nims-dpfc/M-DaC_XPS.git myproject
    cd myproject

.. index::
	single: proxy(git)

.. note::

    In case an error message 'fatal: unable to access 'https://github.com/...': Couldn't resolve host 'github.com' appears, you need proxy setting.  

    Proxy setting can be done as follows.     ::

        git config --global http.https://github.com/nims-dpfc/M-DaC_XPS.git.proxy http://[proxy]:[port]

    You need to configure [proxy],and [port] according to your environment.

Move to tool directory.   ::

    cd PHI_XPS_survey_narrow_tools

Execute the commands.          ::

    MPExport.exe -Filename:"..\source\XPS_PHI_QUANTERA_survey.spe" -TSV

    python txt2csv.py "XPS_PHI_QUANTERA_survey.txt"

    python csv2graph.py "XPS_PHI_QUANTERA_survey.csv"

    python txt2raw_XPS_survey.py "XPS_PHI_QUANTERA_survey.txt" xps_raw_template.xml raw.xml

    python raw2primary_XPS_survey.py raw.xml xps_primary_template.xml primary.xml

Each transformed file is created in the current directory. 

In case you use `Jupyter Notebook`_, first launch it as follows.  ::

    jupyter notebook

Execute each command refering to tutorial "`Jupyter Notebookでの実行`_" . Or you can use ``xps_survey.ipynb`` from jupyter notebook. This makes it a lot easier to execute these.

This video shows how to execute XPS_survey. (no Eng. captions)

.. raw:: html

    <div style="text-align: center; margin-bottom: 2em;">
    <iframe width="100%" height="350" src="https://www.youtube.com/embed/Y5supLBk3kY?rel=0" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
    </div>
























Online documentation (and example of use)
=========================================
    https://nims-dpfc.github.io/M-DaC_doc/

Source code repository
======================
**XPS:** https://github.com/nims-dpfc/M-DaC_XPS

**XRD:** https://github.com/nims-dpfc/M-DaC_XRD

**AES:** https://github.com/nims-dpfc/M-DaC_AES

Contents
========
.. toctree::
    :maxdepth: 3

    About
    Installation
    FAQ <faq>
    License <LICENSE>
    Terms of Service <terms_of_service>
    Tutorial


License
=======
    MIT -- see the file ``LICENSE_MIT.txt`` for details.

.. _NIMS: https://www.nims.go.jp/
.. _Jupyter Notebook: http://jupyter.org/
.. _Jupyter Notebookでの実行: xps_survey.ipynb



Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


.. |br| raw:: html

  <br/>