Command-line Interface (CLI)

CLFF provides command-line interface (CLI) to run the CLFF processes:

• Concurrent learning process
• generate data for training ML forcefields
• convert MPtrj files to XYZ datasets.
• etc.

CLFF concurrent learning

Run the main CLFF concurrent learning process.

clff_cl PARAM.yml MACHINE.yml

• PARAM.yml: The parameters of the generator.
• MACHINE.yml: The settings of the machines running the generator.

Data generator

Generate data for training ML forcefields.

clff_gendata PARAM.yml MACHINE.yml

• PARAM.yml: The parameters of the generator.
• MACHINE.yml: The settings of the machines running the generator.

Phonon calculation

Perform the phonon calculation.

clff_phonon PARAM.yml MACHINE.yml

• PARAM.yml: The parameters of the generator.
• MACHINE.yml: The settings of the machines running the generator.

Dataset tools

Convert MPtrj to XYZ

chgnet_to_xyz MPtrj.json

• MPtrj.json: The MPtrj file to be converted to XYZ dataset.