Getting Started
User Guide
--retry-mode
--mq-ensemble
mq.yaml
--hybrid-ensemble
hybrid.yaml
final_opt
analysis
seed
Tutorials
Validation
API Reference
get_calculator()
list_models()
backend_available()
available_backends()
require_backend()
LennardJonesCalculator
LennardJonesCalculator.implemented_properties
LennardJonesCalculator.calculate()
BuckinghamCalculator
BuckinghamCalculator.implemented_properties
BuckinghamCalculator.calculate()
get_mace_calculator()
generate_random()
batch_random()
random_gen_dir_hint()
MeltQuenchPipeline
MeltQuenchPipeline.STAGE_NAMES
MeltQuenchPipeline.STAGE_CHECKPOINTS
MeltQuenchPipeline.run()
run()
batch_optimize()
run_torchsim()
StructureAnalyser
StructureAnalyser.__init__()
StructureAnalyser.screen()
StructureAnalyser.screened()
StructureAnalyser.total_coordination()
StructureAnalyser.density()
StructureAnalyser.coordination()
StructureAnalyser.cutoff_robustness()
StructureAnalyser.dimer_report()
StructureAnalyser.bond_order()
StructureAnalyser.bond_distances()
StructureAnalyser.bond_angles()
StructureAnalyser.angle_distribution()
StructureAnalyser.rdf()
StructureAnalyser.structure_factor()
StructureAnalyser.structure_factor_direct()
StructureAnalyser.total_correlation()
StructureAnalyser.xrd_pattern()
StructureAnalyser.compare_experiment()
StructureAnalyser.averaged_rdf()
StructureAnalyser.ring_statistics()
StructureAnalyser.polyhedral_connectivity()
StructureAnalyser.voronoi()
StructureAnalyser.void_distribution()
StructureAnalyser.oxygen_speciation()
StructureAnalyser.elastic_moduli()
StructureAnalyser.vibrational_dos()
StructureAnalyser.energy_ranking()
StructureAnalyser.averaged_cn()
StructureAnalyser.convergence_report()
StructureAnalyser.summary()
StructureAnalyser.per_structure_summary()
StructureAnalyser.save_report()
StructureAnalyser.plot()
validate_screening_config()
screen_structures()
mark_screening_analysed()
format_screening_report()
write_screening_outputs()
format_cutoff_robustness()
save_cutoff_robustness()
load_experiment()
compare_experiment()
format_experiment_report()
save_experiment_comparison()
compute_xrd_pattern()
save_xrd_pattern()
compute_bond_order()
compute_void_distribution()
compute_oxygen_speciation()
compute_elastic_moduli()
compute_vibrational_dos()
compute_melt_memory()
format_melt_memory()
convergence_report()
format_convergence_report()
save_convergence_report()
validate_against_reference()
format_validation_report()
compute_energy_ranking()
rank_from_log()
format_log_ranking()
EnsembleSpec
EnsembleSpec.label
EnsembleSpec.files
EnsembleSpec.color
EnsembleSpec.cutoff
EnsembleSpec.resolve_files()
EnsembleSpec.analyser()
EnsembleSpec.from_analyser()
compare_ensembles()
parse_args()
main()
compute_density_gcm3()
DivergenceError
assert_finite()
resolve_device()
make_cubic()
cubic_cell_filter()
calculator_supports_stress()
require_stress()
build_md_dynamics()
parse_index_spec()
stage_rng()
scoped_run_index()
run_index_from_cwd()
run_index_for()
resolve_ramp()
MDLogger
MDLogger.log()
MDLogger.close()
TrajectoryWriter
TrajectoryWriter.write()
TrajectoryWriter.close()
attach_outputs()
read_md_checkpoint()
resume_md_stage()
needs_velocity_init()
ramp_resume_position()
set_md_temperature()
merge_config()
stage_file()
extract_snapshots()
infer_oxidation_state()
cation_nonmetals()
auto_target_cn()
classify_bond()
get_ionic_radius()
get_metallic_radius()
get_effective_radius()
default_minsep()
estimate_density()
get_packing_factor()
anion_elements()
estimate_cell_length()
format_auto_derive_summary()
convert()
parse_md_log()
running_average()
extract_energies()
plot_energy_convergence()
block_average_test()
plot_block_averages()
compute_msd()
plot_msd()
plot_temperature()
plot_rdf_time_windows()
compute_cn_vs_time()
plot_cn_vs_time()
Methodology
Development