Available Features

主要功能

HitDIC软件的可执行文件是hitdic_opt。hitdic_opt的命令行功能如下所示:

所有hitdic_opt的选项

Compiled at Jun 25 2023, 17:49:51
Utilities from hitdic_toolbox.
Usage:
  hitdic_opt [OPTION...]

  -h, --help           Help
      --example        Print example of utilities
      --debug          Activte debug mode
      --logfile arg    path to logfile
      --rand_seed arg  random seed number
      --max_threads    Use maximum threads
      --threads arg    Number of threads to be employed

 Basic Optimization options:
      --start                   Start optimization
      --strategy arg            Set strategy (default: auto)
      --use_result arg          Using result from precedent algorithm 
                                (default: default)
      --sweep_zero_params       Sweep parameters with zero values in 
                                precedent result
      --list_strategy_registry  List all global registry for optimization 
                                strategies
      --targets arg             Set targets to be considered during 
                                optimization (default: all)
      --submit_params           Submit optimized parameters in workspace 
                                record

 Export Properties options:
      --export    Enable exporting properties
      --task arg  task input file (default: task.input)

 Mocking Options options:
      --mock              Mock tdb parameters
      --tdb arg           TDB file
      --output arg        Output file
      --phase arg         Phase Name
      --elements arg      Elements
      --binary arg        Binary Options
      --crossbinary arg   Cross Binary Options
      --ternary arg       Ternary Options
      --crossternary arg  Cross Ternary Options

 Post Processing options:
      --report          Activate report generation
      --with_solvent    Plot composition profiles with solvent
      --report_dir arg  Assign name of directory for report (default: "")

 Pre-Processing options:
      --check                  Check the project setting
      --check_result_file arg  Assign result file (default: record.json)
      --dump                   Dump project setting json file to hitdic 
                               project

 Project Setting options:
      --project arg       Project setting file (default: project.input)
      --project_json arg  Project setting json file, alternative option
      --work_dir arg      Working directory of the project (default: ./)
      --cache arg         Cache directory name (default: .cache)
      --workspace arg     Workspace file name (default: workspace.json)

 System Diagnosis options:
      --list_options_registry   List all global registry for algorithm 
                                options
      --listing_strategy_registry
                                List all global registry for optimization 
                                strategies

检查工程文件的正确性

如果需要激活检查功能，使用--check选项。

该功能将会执行以下操作:

检查工程文件project.input或project.json（如果使用了--project_json选项）是否正确。如果工程文件不正确，程序将会退出并给出错误信息。
尝试评估初始数据库设置的预测性能。使用--check_result_file选项来指定需要检查的结果文件。如果结果文件没有被指定，程序将会使用工作目录下的默认结果文件record.json。很多与数据集和预测性能相关的信息将会被写入结果文件。
如果工程文件正确，project.json将会被生成在工作目录下。project.json文件用于存储工程设置信息，可以在以后使用。

检查时调用优化策略对应的优化结果

hitdic_opt --check --check_result_file=record.json --use_result=ga

检查时调用现有的优化结果

hitdic_opt --check --check_result_file=record.json --use_result=stored_parameters

基本优化选项

--start 如果需要激活优化功能，使用--start选项。

优化功能将会执行以下操作:

使用指定的优化策略来优化数据库中的参数。优化结果将会被存储在工作目录下的workspace.json文件中。优化参数的存储将取决于所使用的优化策略。
如果使用了--submit_params选项，优化后的参数将会被提交到工作空间记录中。相关的类别是parameters。
如果使用了--use_result选项，历史优化结果将会被使用，用作当前指定优化策略的初始值。--use_result选项的默认值是default，这意味着优化过程将会寻找由相同的优化策略产生的结果。如果相关的结果不可用，优化过程将会从初始数据库设置开始。其他可用的选项有ga，varselga，rega，nsga3，stored_parameters和none，以及工作空间记录中result类别中列出的其他选项。

不基于已有优化结果进行优化

hitdic_opt --start --strategy=varselga --use_result=none

基于已有优化结果进行优化

hitdic_opt --start --strategy=ga --use_result=varselga --sweep_zero_params

--sweep_zero_params用于清除优化历史中值为零的参数，这些参数在当前的优化过程中将不会被优化，并继续保持为零。

优化结束后将优化结果提交到工作空间的parameters中

hitdic_opt --start --strategy=rega --use_result=ga --submit_params

--submit_params用于将优化后的参数提交到工作空间记录中，并存储在parameters类别中。

后处理选项

如果需要激活报告生成功能，使用--report选项。

报告生成功能将会执行以下操作:

对数据集中的所有实验数据进行预测。预测可以使用优化结果或初始数据库设置。
生成预测结果的报告。报告将会被存储在工作目录下的results文件夹中。报告是一个html项目，可以被任何浏览器打开。

生成初始的报告

hitdic_opt --report --use_result=none --report_dir=results/init

--report_dir 用于指定报告的目录名称。默认值是results/report。 --use_result=none用于生成初始报告。

生成优化后的报告

hitdic_opt --report --use_result=varselga

--report_dir 用于指定报告的目录名称。默认值是results/report。 --use_result=varselga用于生成varselga优化后的报告。

模拟参数生成选项

:: tip --mock 如果需要激活模拟参数生成功能，使用--mock选项。 ::

Things to be done is: Mocking parameters of interest in the database. An initial tdb file with or without the parameters of interest is required, assigned by --tdb option. The output tdb file is assigned by --output option. --phase and --elements options are used to assign the phase name and elements of system being considered, respectively.

该功能主要用于在初始tdb文件中加入不同类别的待优化参数。--tdb选项用于指定初始tdb文件，--output选项用于指定输出的tdb文件。--phase和--elements选项用于指定系统中的相名称和元素列表。

模拟参数生成过程有两种行为:

使用--binary，--crossbinary，--ternary和--crossternary选项来模拟待优化参数。例如，--binary=A,B,2用于模拟二元交互参数，其中包括温度独立和温度相关参数，而最大的参数阶数为2。
如果初始tdb文件中已经包含了待优化参数，可以使用--use_result选项来将优化结果填充到初始tdb文件中。可用的选项有ga，varselga，rega，nsga3，stored_parameters和none，以及工作空间记录中result类别中列出的其他选项。

加入温度独立和温度的二元相互作用参数

hitdic_opt --mock --tdb=initial.tdb --output=mocked.tdb --binary=A,B,2

加入温度独立和温度的三元相互作用参数

hitdic_opt --mock --tdb=initial.tdb --output=mocked.tdb --ternary=A,B,2

使用ga优化结果填充初始tdb文件中的待优化参数

hitdic_opt --mock --tdb=initial.tdb --output=fill.tdb --use_result=ga

hitdic_opt --mock --tdb=initial.tdb --output=fill.tdb --use_result=stored_parameters

数据输出及后处理

HitDIC能够输出随扩散偶距离变化的通量、扩散系数等信息。HitDIC提供基于`tdb`文件对互扩散系数、示踪扩散系数、热力学因子等扩散相关信息的输出功能。HitDIC能够生成与数据集相关的统计信息，如平均值、方差、标准差等。

算法说明