aiida-reoptimize
Algorithms for external optimization of crystal structures
General information
Registry checks
Plugins provided
Entry points
-
reoptimize.AdamFleurRelaxOptimizer
class:aiida_reoptimize.workflows.Optimization.FleurRelax:AdamFleurRelaxOptimizerAdam optimizer registered for FLEUR relax lattice optimization.
Input Required Valid types Description parameterstrue DictOptimization parameters. get_bestfalse BoolWhether to return the best result node identifier. itmaxfalse IntMaximum number of iterations. metadatafalse structurefalse StructureData, NoneTypeChemical structure for the optimization. Output Required Valid types Description final_valuetrue FloatFinal value of the objective function. optimized_parameterstrue ListOptimized parameters. historyfalse ListOptimization history. result_node_pkfalse IntPrimary key of the best result node. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 400 Optimization did not converge within the maximum iterations. 401 Optimization failed to find a valid solution. 402 Optimizer stuck: step rate reached minimum or too many consecutive worse objectives. -
reoptimize.RMSpropFleurRelaxOptimizer
class:aiida_reoptimize.workflows.Optimization.FleurRelax:RMSpropFleurRelaxOptimizerRMSprop optimizer registered for FLEUR relax lattice optimization.
Input Required Valid types Description parameterstrue DictOptimization parameters. get_bestfalse BoolWhether to return the best result node identifier. itmaxfalse IntMaximum number of iterations. metadatafalse structurefalse StructureData, NoneTypeChemical structure for the optimization. Output Required Valid types Description final_valuetrue FloatFinal value of the objective function. optimized_parameterstrue ListOptimized parameters. historyfalse ListOptimization history. result_node_pkfalse IntPrimary key of the best result node. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 400 Optimization did not converge within the maximum iterations. 401 Optimization failed to find a valid solution. 402 Optimizer stuck: step rate reached minimum or too many consecutive worse objectives. -
reoptimize.BFGSFleurRelaxOptimizer
class:aiida_reoptimize.workflows.Optimization.FleurRelax:BFGSFleurRelaxOptimizerBFGS optimizer registered for FLEUR relax lattice optimization.
Input Required Valid types Description parameterstrue DictOptimization parameters. get_bestfalse BoolWhether to return the best result node identifier. itmaxfalse IntMaximum number of iterations. metadatafalse structurefalse StructureData, NoneTypeChemical structure for the optimization. Output Required Valid types Description final_valuetrue FloatFinal value of the objective function. optimized_parameterstrue ListOptimized parameters. historyfalse ListOptimization history. result_node_pkfalse IntPrimary key of the best result node. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 400 Optimization did not converge within the maximum iterations. 401 Optimization failed to find a valid solution. 402 Optimizer stuck: step rate reached minimum or too many consecutive worse objectives. -
reoptimize.PyMOOFleurRelaxOptimizer
class:aiida_reoptimize.workflows.Optimization.FleurRelax:PyMOOFleurRelaxOptimizerPyMOO-backed optimizer registered for FLEUR relax lattice optimization.
Input Required Valid types Description algorithm_nametrue StrAlgorithm name. itmaxtrue IntMaximum number of iterations. parameterstrue DictOptimization parameters including bounds, optional tol, and algorithm settings. get_bestfalse BoolWhether to return the best result node identifier. itminfalse IntMaximum number of iterations. metadatafalse structurefalse StructureData, NoneTypeChemical structure for the optimization. Output Required Valid types Description final_valuetrue FloatFinal value of the objective function. optimized_parameterstrue ListOptimized parameters. historyfalse ListOptimization history. result_node_pkfalse IntPrimary key of the best result node. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 401 Optimization failed to find a valid solution. -
reoptimize.G3PCXFleurRelaxOptimizer
class:aiida_reoptimize.workflows.Optimization.FleurRelax:G3PCXFleurRelaxOptimizerFixed G3PCX PyMOO optimizer for FLEUR relax lattice optimization.
Input Required Valid types Description algorithm_nametrue StrFixed PyMOO algorithm name (G3PCX). itmaxtrue IntMaximum number of iterations. parameterstrue DictOptimization parameters including bounds, optional tol, and algorithm settings. get_bestfalse BoolWhether to return the best result node identifier. itminfalse IntMaximum number of iterations. metadatafalse structurefalse StructureData, NoneTypeChemical structure for the optimization. Output Required Valid types Description final_valuetrue FloatFinal value of the objective function. optimized_parameterstrue ListOptimized parameters. historyfalse ListOptimization history. result_node_pkfalse IntPrimary key of the best result node. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 401 Optimization failed to find a valid solution. -
reoptimize.NRBOFleurRelaxOptimizer
class:aiida_reoptimize.workflows.Optimization.FleurRelax:NRBOFleurRelaxOptimizerFixed NRBO PyMOO optimizer for FLEUR relax lattice optimization.
Input Required Valid types Description algorithm_nametrue StrFixed PyMOO algorithm name (NRBO). itmaxtrue IntMaximum number of iterations. parameterstrue DictOptimization parameters including bounds, optional tol, and algorithm settings. get_bestfalse BoolWhether to return the best result node identifier. itminfalse IntMaximum number of iterations. metadatafalse structurefalse StructureData, NoneTypeChemical structure for the optimization. Output Required Valid types Description final_valuetrue FloatFinal value of the objective function. optimized_parameterstrue ListOptimized parameters. historyfalse ListOptimization history. result_node_pkfalse IntPrimary key of the best result node. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 401 Optimization failed to find a valid solution. -
reoptimize.CDGFleurRelaxOptimizer
class:aiida_reoptimize.workflows.Optimization.FleurRelax:CDGFleurRelaxOptimizerConjugate-gradient optimizer registered for FLEUR relax lattice optimization.
Input Required Valid types Description parameterstrue DictOptimization parameters. get_bestfalse BoolWhether to return the best result node identifier. itmaxfalse IntMaximum number of iterations. metadatafalse structurefalse StructureData, NoneTypeChemical structure for the optimization. Output Required Valid types Description final_valuetrue FloatFinal value of the objective function. optimized_parameterstrue ListOptimized parameters. historyfalse ListOptimization history. result_node_pkfalse IntPrimary key of the best result node. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 400 Optimization did not converge within the maximum iterations. 401 Optimization failed to find a valid solution. 402 Optimizer stuck: step rate reached minimum or too many consecutive worse objectives. -
reoptimize.AdamFleurSCFOptimizer
class:aiida_reoptimize.workflows.Optimization.FleurSCF:AdamFleurSCFOptimizerAdam optimizer registered for FLEUR SCF lattice optimization.
Input Required Valid types Description parameterstrue DictOptimization parameters. get_bestfalse BoolWhether to return the best result node identifier. itmaxfalse IntMaximum number of iterations. metadatafalse structurefalse StructureData, NoneTypeChemical structure for the optimization. Output Required Valid types Description final_valuetrue FloatFinal value of the objective function. optimized_parameterstrue ListOptimized parameters. historyfalse ListOptimization history. result_node_pkfalse IntPrimary key of the best result node. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 400 Optimization did not converge within the maximum iterations. 401 Optimization failed to find a valid solution. 402 Optimizer stuck: step rate reached minimum or too many consecutive worse objectives. -
reoptimize.RMSpropFleurSCFOptimizer
class:aiida_reoptimize.workflows.Optimization.FleurSCF:RMSpropFleurSCFOptimizerRMSprop optimizer registered for FLEUR SCF lattice optimization.
Input Required Valid types Description parameterstrue DictOptimization parameters. get_bestfalse BoolWhether to return the best result node identifier. itmaxfalse IntMaximum number of iterations. metadatafalse structurefalse StructureData, NoneTypeChemical structure for the optimization. Output Required Valid types Description final_valuetrue FloatFinal value of the objective function. optimized_parameterstrue ListOptimized parameters. historyfalse ListOptimization history. result_node_pkfalse IntPrimary key of the best result node. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 400 Optimization did not converge within the maximum iterations. 401 Optimization failed to find a valid solution. 402 Optimizer stuck: step rate reached minimum or too many consecutive worse objectives. -
reoptimize.BFGSFleurSCFOptimizer
class:aiida_reoptimize.workflows.Optimization.FleurSCF:BFGSFleurSCFOptimizerBFGS optimizer registered for FLEUR SCF lattice optimization.
Input Required Valid types Description parameterstrue DictOptimization parameters. get_bestfalse BoolWhether to return the best result node identifier. itmaxfalse IntMaximum number of iterations. metadatafalse structurefalse StructureData, NoneTypeChemical structure for the optimization. Output Required Valid types Description final_valuetrue FloatFinal value of the objective function. optimized_parameterstrue ListOptimized parameters. historyfalse ListOptimization history. result_node_pkfalse IntPrimary key of the best result node. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 400 Optimization did not converge within the maximum iterations. 401 Optimization failed to find a valid solution. 402 Optimizer stuck: step rate reached minimum or too many consecutive worse objectives. -
reoptimize.PyMOOFleurSCFOptimizer
class:aiida_reoptimize.workflows.Optimization.FleurSCF:PyMOOFleurSCFOptimizerPyMOO-backed optimizer registered for FLEUR SCF lattice optimization.
Input Required Valid types Description algorithm_nametrue StrAlgorithm name. itmaxtrue IntMaximum number of iterations. parameterstrue DictOptimization parameters including bounds, optional tol, and algorithm settings. get_bestfalse BoolWhether to return the best result node identifier. itminfalse IntMaximum number of iterations. metadatafalse structurefalse StructureData, NoneTypeChemical structure for the optimization. Output Required Valid types Description final_valuetrue FloatFinal value of the objective function. optimized_parameterstrue ListOptimized parameters. historyfalse ListOptimization history. result_node_pkfalse IntPrimary key of the best result node. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 401 Optimization failed to find a valid solution. -
reoptimize.G3PCXFleurSCFOptimizer
class:aiida_reoptimize.workflows.Optimization.FleurSCF:G3PCXFleurSCFOptimizerFixed G3PCX PyMOO optimizer for FLEUR SCF lattice optimization.
Input Required Valid types Description algorithm_nametrue StrFixed PyMOO algorithm name (G3PCX). itmaxtrue IntMaximum number of iterations. parameterstrue DictOptimization parameters including bounds, optional tol, and algorithm settings. get_bestfalse BoolWhether to return the best result node identifier. itminfalse IntMaximum number of iterations. metadatafalse structurefalse StructureData, NoneTypeChemical structure for the optimization. Output Required Valid types Description final_valuetrue FloatFinal value of the objective function. optimized_parameterstrue ListOptimized parameters. historyfalse ListOptimization history. result_node_pkfalse IntPrimary key of the best result node. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 401 Optimization failed to find a valid solution. -
reoptimize.NRBOFleurSCFOptimizer
class:aiida_reoptimize.workflows.Optimization.FleurSCF:NRBOFleurSCFOptimizerFixed NRBO PyMOO optimizer for FLEUR SCF lattice optimization.
Input Required Valid types Description algorithm_nametrue StrFixed PyMOO algorithm name (NRBO). itmaxtrue IntMaximum number of iterations. parameterstrue DictOptimization parameters including bounds, optional tol, and algorithm settings. get_bestfalse BoolWhether to return the best result node identifier. itminfalse IntMaximum number of iterations. metadatafalse structurefalse StructureData, NoneTypeChemical structure for the optimization. Output Required Valid types Description final_valuetrue FloatFinal value of the objective function. optimized_parameterstrue ListOptimized parameters. historyfalse ListOptimization history. result_node_pkfalse IntPrimary key of the best result node. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 401 Optimization failed to find a valid solution. -
reoptimize.CDGFleurSCFOptimizer
class:aiida_reoptimize.workflows.Optimization.FleurSCF:CDGFleurSCFOptimizerConjugate-gradient optimizer registered for FLEUR SCF lattice optimization.
Input Required Valid types Description parameterstrue DictOptimization parameters. get_bestfalse BoolWhether to return the best result node identifier. itmaxfalse IntMaximum number of iterations. metadatafalse structurefalse StructureData, NoneTypeChemical structure for the optimization. Output Required Valid types Description final_valuetrue FloatFinal value of the objective function. optimized_parameterstrue ListOptimized parameters. historyfalse ListOptimization history. result_node_pkfalse IntPrimary key of the best result node. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 400 Optimization did not converge within the maximum iterations. 401 Optimization failed to find a valid solution. 402 Optimizer stuck: step rate reached minimum or too many consecutive worse objectives. -
reoptimize.AdamCrystalOptimizer
class:aiida_reoptimize.workflows.Optimization.Crystal:AdamCrystalOptimizerAdam optimizer registered for CRYSTAL lattice optimization.
Input Required Valid types Description parameterstrue DictOptimization parameters. get_bestfalse BoolWhether to return the best result node identifier. itmaxfalse IntMaximum number of iterations. metadatafalse structurefalse StructureData, NoneTypeChemical structure for the optimization. Output Required Valid types Description final_valuetrue FloatFinal value of the objective function. optimized_parameterstrue ListOptimized parameters. historyfalse ListOptimization history. result_node_pkfalse IntPrimary key of the best result node. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 400 Optimization did not converge within the maximum iterations. 401 Optimization failed to find a valid solution. 402 Optimizer stuck: step rate reached minimum or too many consecutive worse objectives. -
reoptimize.CDGCrystalOptimizer
class:aiida_reoptimize.workflows.Optimization.Crystal:CDGCrystalOptimizerConjugate-gradient optimizer registered for CRYSTAL lattice optimization.
Input Required Valid types Description parameterstrue DictOptimization parameters. get_bestfalse BoolWhether to return the best result node identifier. itmaxfalse IntMaximum number of iterations. metadatafalse structurefalse StructureData, NoneTypeChemical structure for the optimization. Output Required Valid types Description final_valuetrue FloatFinal value of the objective function. optimized_parameterstrue ListOptimized parameters. historyfalse ListOptimization history. result_node_pkfalse IntPrimary key of the best result node. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 400 Optimization did not converge within the maximum iterations. 401 Optimization failed to find a valid solution. 402 Optimizer stuck: step rate reached minimum or too many consecutive worse objectives. -
reoptimize.RMSpropCrystalOptimizer
class:aiida_reoptimize.workflows.Optimization.Crystal:RMSpropCrystalOptimizerRMSprop optimizer registered for CRYSTAL lattice optimization.
Input Required Valid types Description parameterstrue DictOptimization parameters. get_bestfalse BoolWhether to return the best result node identifier. itmaxfalse IntMaximum number of iterations. metadatafalse structurefalse StructureData, NoneTypeChemical structure for the optimization. Output Required Valid types Description final_valuetrue FloatFinal value of the objective function. optimized_parameterstrue ListOptimized parameters. historyfalse ListOptimization history. result_node_pkfalse IntPrimary key of the best result node. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 400 Optimization did not converge within the maximum iterations. 401 Optimization failed to find a valid solution. 402 Optimizer stuck: step rate reached minimum or too many consecutive worse objectives. -
reoptimize.BFGSCrystalOptimizer
class:aiida_reoptimize.workflows.Optimization.Crystal:BFGSCrystalOptimizerBFGS optimizer registered for CRYSTAL lattice optimization.
Input Required Valid types Description parameterstrue DictOptimization parameters. get_bestfalse BoolWhether to return the best result node identifier. itmaxfalse IntMaximum number of iterations. metadatafalse structurefalse StructureData, NoneTypeChemical structure for the optimization. Output Required Valid types Description final_valuetrue FloatFinal value of the objective function. optimized_parameterstrue ListOptimized parameters. historyfalse ListOptimization history. result_node_pkfalse IntPrimary key of the best result node. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 400 Optimization did not converge within the maximum iterations. 401 Optimization failed to find a valid solution. 402 Optimizer stuck: step rate reached minimum or too many consecutive worse objectives. -
reoptimize.PyMOOCrystalOptimizer
class:aiida_reoptimize.workflows.Optimization.Crystal:PyMOOCrystalOptimizerPyMOO-backed optimizer registered for CRYSTAL lattice optimization.
Input Required Valid types Description algorithm_nametrue StrAlgorithm name. itmaxtrue IntMaximum number of iterations. parameterstrue DictOptimization parameters including bounds, optional tol, and algorithm settings. get_bestfalse BoolWhether to return the best result node identifier. itminfalse IntMaximum number of iterations. metadatafalse structurefalse StructureData, NoneTypeChemical structure for the optimization. Output Required Valid types Description final_valuetrue FloatFinal value of the objective function. optimized_parameterstrue ListOptimized parameters. historyfalse ListOptimization history. result_node_pkfalse IntPrimary key of the best result node. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 401 Optimization failed to find a valid solution. -
reoptimize.G3PCXCrystalOptimizer
class:aiida_reoptimize.workflows.Optimization.Crystal:G3PCXCrystalOptimizerFixed G3PCX PyMOO optimizer for CRYSTAL lattice optimization.
Input Required Valid types Description algorithm_nametrue StrFixed PyMOO algorithm name (G3PCX). itmaxtrue IntMaximum number of iterations. parameterstrue DictOptimization parameters including bounds, optional tol, and algorithm settings. get_bestfalse BoolWhether to return the best result node identifier. itminfalse IntMaximum number of iterations. metadatafalse structurefalse StructureData, NoneTypeChemical structure for the optimization. Output Required Valid types Description final_valuetrue FloatFinal value of the objective function. optimized_parameterstrue ListOptimized parameters. historyfalse ListOptimization history. result_node_pkfalse IntPrimary key of the best result node. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 401 Optimization failed to find a valid solution. -
reoptimize.NRBOCrystalOptimizer
class:aiida_reoptimize.workflows.Optimization.Crystal:NRBOCrystalOptimizerFixed NRBO PyMOO optimizer for CRYSTAL lattice optimization.
Input Required Valid types Description algorithm_nametrue StrFixed PyMOO algorithm name (NRBO). itmaxtrue IntMaximum number of iterations. parameterstrue DictOptimization parameters including bounds, optional tol, and algorithm settings. get_bestfalse BoolWhether to return the best result node identifier. itminfalse IntMaximum number of iterations. metadatafalse structurefalse StructureData, NoneTypeChemical structure for the optimization. Output Required Valid types Description final_valuetrue FloatFinal value of the objective function. optimized_parameterstrue ListOptimized parameters. historyfalse ListOptimization history. result_node_pkfalse IntPrimary key of the best result node. Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. 401 Optimization failed to find a valid solution. -
reoptimize.FleurSCFLatticeProblem
class:aiida_reoptimize.workflows.Evaluation.fleur_evaluators:FleurSCFLatticeProblemEvaluate lattice perturbations with the FLEUR SCF workchain. The workflow accepts the generic static evaluator inputs and forwards the resolved builder parameters to ``FleurScfWorkChain``.
Input Required Valid types Description calculator_parameterstrue DictParameters for the calculator workchain structuretrue StructureDataStructure to evaluate with the workchain targetstrue ListList of structural parameter sets to evaluate metadatafalse structure_keywordfalse ListPath to the structure input in the calculator builder. Output Required Valid types Description evaluation_resultstrue ListList of evaluation results for each target Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. -
reoptimize.FleurRelaxLatticeProblem
class:aiida_reoptimize.workflows.Evaluation.fleur_evaluators:FleurRelaxLatticeProblemEvaluate lattice perturbations with the FLEUR relax workchain. The workflow accepts the generic static evaluator inputs and forwards the resolved builder parameters to ``FleurRelaxWorkChain``.
Input Required Valid types Description calculator_parameterstrue DictParameters for the calculator workchain structuretrue StructureDataStructure to evaluate with the workchain targetstrue ListList of structural parameter sets to evaluate metadatafalse structure_keywordfalse ListPath to the structure input in the calculator builder. Output Required Valid types Description evaluation_resultstrue ListList of evaluation results for each target Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output. -
reoptimize.CrystalLatticeProblem
class:aiida_reoptimize.workflows.Evaluation.crystal_evaluation:CrystalLatticeProblemEvaluate lattice perturbations with the CRYSTAL base workchain. Inputs inherited from :class:`StaticEvalLatticeProblem`: - ``structure``: source crystal structure. - ``targets``: list of lattice parameter perturbations. - ``calculator_parameters``: inputs forwarded to CRYSTAL. - ``structure_keyword``: path to the structure input in the builder.
Input Required Valid types Description calculator_parameterstrue DictParameters for the calculator workchain structuretrue StructureDataStructure to evaluate with the workchain targetstrue ListList of structural parameter sets to evaluate metadatafalse structure_keywordfalse ListPath to the structure input in the calculator builder. Output Required Valid types Description evaluation_resultstrue ListList of evaluation results for each target Exit status Message 1 The process has failed with an unspecified error. 2 The process failed with legacy failure mode. 10 The process returned an invalid output. 11 The process did not register a required output.