|
341 | 341 | 'belonging_agent': ApexAgentName, |
342 | 342 | 'scene': [SceneEnum.APEX, SceneEnum.VACANCY_FORMATION_ENERGY], |
343 | 343 | 'description': ( |
344 | | - 'What it does: Evaluate vacancy formation energies by relaxing supercells with one atom removed.\n' |
345 | | - 'When to use: When you need vacancy formation energies for materials.\n' |
346 | | - 'Prerequisites / Inputs: Structure file.\n' |
| 344 | + 'What it does: Evaluate vacancy formation energies by relaxing supercells after creating vacancies internally (removes one atom from a pristine supercell).\n' |
| 345 | + 'When to use: When you need vacancy formation energies for a material starting from a pristine crystal.\n' |
| 346 | + 'Prerequisites / Inputs: Pristine (defect-free) structure file of the bulk crystal (unit cell or supercell). Do NOT provide a structure that already contains vacancies/defects (missing atoms, partial occupancies, disordered sites), because the tool assumes a complete bulk lattice and will construct vacancies itself; defected inputs may cause errors or invalid energies.\n' |
347 | 347 | 'Outputs: Vacancy formation energies.\n' |
348 | | - 'Cannot do / Limits: DFT-based.\n' |
| 348 | + 'Cannot do / Limits: DFT-based.; does not accept pre-defected structures.\n' |
349 | 349 | 'Cost / Notes: DFT calculation cost.' |
350 | 350 | ), |
351 | 351 | 'alternative': ['abacus_vacancy_formation_energy'], |
|
369 | 369 | 'belonging_agent': ApexAgentName, |
370 | 370 | 'scene': [SceneEnum.APEX, SceneEnum.INTERSTITIAL_FORMATION_ENERGY], |
371 | 371 | 'description': ( |
372 | | - 'What it does: Insert interstitial atoms into a host lattice to compute formation energies across candidate sites.\n' |
373 | | - 'When to use: When you need interstitial formation energies.\n' |
374 | | - 'Prerequisites / Inputs: Host lattice structure and interstitial atoms.\n' |
375 | | - 'Outputs: Formation energies for candidate sites.\n' |
376 | | - 'Cannot do / Limits: DFT-based.\n' |
| 372 | + 'What it does: Insert interstitial atoms into a host lattice to compute formation energies across candidate sites (generated internally).\n' |
| 373 | + 'When to use: When you need interstitial formation energies starting from a defect-free bulk crystal.\n' |
| 374 | + 'Prerequisites / Inputs: Pristine (defect-free) host lattice structure and interstitial atoms.\n The host structure must be a complete bulk lattice (no vacancies/antisites/substitutions, no missing atoms, no partial occupancies/disordered sites). Do NOT provide a structure that already contains defects or extra atoms; the tool assumes a pristine lattice and will place interstitials itself—defected inputs may cause errors or invalid energies.\n' |
| 375 | + 'Outputs: Interstitial formation energies for candidate sites.\n' |
| 376 | + 'Cannot do / Limits: DFT-based. Not intended for pre-defected host structures.\n' |
377 | 377 | 'Cost / Notes: DFT calculation cost.' |
378 | 378 | ), |
379 | 379 | 'alternative': [], |
|
397 | 397 | 'belonging_agent': ApexAgentName, |
398 | 398 | 'scene': [SceneEnum.APEX, SceneEnum.SURFACE_ENERGY], |
399 | 399 | 'description': ( |
400 | | - 'What it does: Execute a workflow of surface energy calculation.\n' |
401 | | - 'When to use: When you need surface energy.\n' |
402 | | - 'Prerequisites / Inputs: Structure file.\n' |
| 400 | + 'What it does: Execute a workflow of surface energy calculation using a pristine Bulk crystal as input.\n' |
| 401 | + 'When to use: When you need surface energy starting from a Bulk structure.\n' |
| 402 | + 'Prerequisites / Inputs: Bulk structure file. \n' |
403 | 403 | 'Outputs: Surface energy.\n' |
404 | | - 'Cannot do / Limits: Cannot build slab structures; DFT-based.\n' |
405 | | - 'Cost / Notes: DFT calculation cost.' |
| 404 | + 'Cannot do / Limits: Do NOT provide an already-cut slab/surface structure as input. Slab inputs can cause errors or lead to invalid surface energies.; DFT-based.\n' |
| 405 | + 'Cost / Notes: DFT calculation cost.ensure the input is a complete bulk lattice.' |
406 | 406 | ), |
407 | 407 | 'alternative': [], |
408 | 408 | 'self_check': False, |
|
0 commit comments