识别相似结构
=============

#. 功能介绍
 
    识别相似的晶体结构，可以选择是否加入额外比较准则：原子类型、原子占据率、原子氧化态、原子磁矩信息，若选择某比较准则，则计算相似度时考虑该准则
    
#. 操作流程

    **依次按照以下步骤创建计算任务**

    .. figure:: ../../_static/computational_workflow.png
        :alt: computational_workflow
        :align: center

        computational_workflow

    .. raw:: html
        
        <br>
        
    +  **step 1. 新建任务**：在对应页面中输入计算任务的名称、描述信息，点击页面的“OK”按钮，完成计算任务的创建；点击“Cancel”按钮，清空输入内容。
    +  **step 2. 上传文件**：在对应页面按照页面提示上传计算输入文件。 

        .. raw:: html

            <span style="color:red">
            <b>
            Attention:
            </b>
            </span>

        + **请务必以英文命名计算输入文件！**
        + **如需上传多个计算输入文件，请将其打包为zip格式压缩包进行上传。**
    +  **step 3. 设置计算参数**：在对应页面按照页面提示设置计算参数。
    +  **step 4. 设置运行参数**：目前，运行参数无需设置，保持输入框默认参数即可
    +  **step 5. 保存计算任务**：完成计算任务的创建，并将其添加到计算项目中。在跳转的页面中，可选择：

        + **继续添加计算任务**：添加新的计算任务
        + **查看项目**：查看当前待提交的计算项目详情。


#. 参数说明

    + 输入文件：
        + 请上传至少包含两个CIF文件的压缩包，以英文命名
        + `示例文件 </example_files/prototype/example.zip>`_

    + 计算参数：
        ========================================= ========================================= =========================================
        参数名称                                    参数类型                                  说明  
        ========================================= ========================================= =========================================
        原子类型                                    布尔值[True（1）,False（0）]               是否考虑站点上的原子类型，False(0)为不考虑
        原子占据率                                  布尔值[True（1）,False（0）]               是否考虑站点上的原子占据率，False(0)为不考虑
        原子氧化态                                  布尔值[True（1）,False（0）]               是否考虑站点上的原子氧化态，False(0)为不考虑
        原子磁矩                                    布尔值[True（1）,False（0）]               是否考虑站点上的原子磁矩，False(0)为不考虑
        相似度阈值                                  浮点数（Float）                            默认参数为0.9，用于判断相似与否
        ========================================= ========================================= =========================================

    + 运行参数：
        目前无需设置，保存默认即可。

        ================= ================= =================
        参数名称          参数类型          说明  
        ================= ================= =================
        Machine Name      字符串（String ） 计算机器名称，默认为machine01 
        Number of Core    正整数（Int）     计算核数，默认为1  
        Number of Process 正整数（Int）     计算进程数，默认为1 
        ================= ================= =================

#. 计算结果文件

    计算完成会得到一个CSV格式的文件，该CSV格式文件每一列的含义为

        + **filename**:晶体结构文件名
        + **similar_group_id**:相似结构组号（在识别相似结构的功能中，若晶体结构具有相同组号，即为比较了结构框架与所选比较准则后，晶体被识别为具有相似结构） 
        + **similarity**:相似度值，与同一相似结构组中第一个结构相比的相似度 
        + **same_group_id**:相同结构组号（在识别相同结构的功能中，若晶体结构具有相同组号，即为比较了结构框架、原子类型以及原子占据率后，晶体被识别为具有相同结构）