matador package¶
matador package performs, aggregates, and analyses high-throughput electronic structure calculations, primarily for crystal structure prediction, leveraging CASTEP and Quantum Epsresso as density-functional theory compute engines.
Subpackages¶
- matador.battery package
- matador.calculators package
- matador.cli package
- matador.compute package
- matador.config package
- matador.crystal package
CrystalCrystal.elemsCrystal.cellCrystal.update()Crystal.print_sites()Crystal.set_positions()Crystal.atom_typesCrystal.num_atomsCrystal.num_elementsCrystal.positions_fracCrystal.positions_absCrystal.site_occupanciesCrystal.stoichiometryCrystal.num_fuCrystal.concentrationCrystal.get_concentration()Crystal.formulaCrystal.formula_texCrystal.formula_unicodeCrystal.cell_volumeCrystal.lattice_cartCrystal.lattice_abcCrystal.bond_lengthsCrystal.voronoi_substructureCrystal.space_groupCrystal.space_group_texCrystal.get_space_group()Crystal.pdfCrystal.calculate_pdf()Crystal.pxrdCrystal.calculate_pxrd()Crystal.coordination_statsCrystal.ase_atomsCrystal.pmg_structureCrystal.from_ase()Crystal.from_pmg()Crystal.coordination_listsCrystal.unique_sitesCrystal.networkCrystal.network_statsCrystal.bonding_statsCrystal.draw_network()Crystal.supercell()Crystal.standardized()
- Submodules
- matador.crystal.crystal module
UnitCellCrystalCrystal.elemsCrystal.cellCrystal.update()Crystal.print_sites()Crystal.set_positions()Crystal.atom_typesCrystal.num_atomsCrystal.num_elementsCrystal.positions_fracCrystal.positions_absCrystal.site_occupanciesCrystal.stoichiometryCrystal.num_fuCrystal.concentrationCrystal.get_concentration()Crystal.formulaCrystal.formula_texCrystal.formula_unicodeCrystal.cell_volumeCrystal.lattice_cartCrystal.lattice_abcCrystal.bond_lengthsCrystal.voronoi_substructureCrystal.space_groupCrystal.space_group_texCrystal.get_space_group()Crystal.pdfCrystal.calculate_pdf()Crystal.pxrdCrystal.calculate_pxrd()Crystal.coordination_statsCrystal.ase_atomsCrystal.pmg_structureCrystal.from_ase()Crystal.from_pmg()Crystal.coordination_listsCrystal.unique_sitesCrystal.networkCrystal.network_statsCrystal.bonding_statsCrystal.draw_network()Crystal.supercell()Crystal.standardized()
- matador.crystal.crystal_site module
- matador.crystal.elastic module
- matador.crystal.network module
- matador.data package
- matador.db package
- matador.export package
- matador.fingerprints package
- matador.hull package
- matador.magres package
MagresReferencerMagresReferencer.fit_modelMagresReferencer.fit_resultsMagresReferencer.fit_interceptMagresReferencer.fit_gradientMagresReferencer.fit_rsquaredMagresReferencer.structures_expMagresReferencer.shifts_expMagresReferencer.speciesMagresReferencer.structuresMagresReferencer.warn_toleranceMagresReferencer.fit_modelMagresReferencer.fit_resultsMagresReferencer.fit_interceptMagresReferencer.fit_gradientMagresReferencer.fit_rsquaredMagresReferencer.structures_expMagresReferencer.shifts_expMagresReferencer.speciesMagresReferencer.structuresMagresReferencer.warn_toleranceMagresReferencer.match_exp_structure_shifts()MagresReferencer.set_shifts_from_fit()MagresReferencer.fit()MagresReferencer.predict()MagresReferencer.print_fit_summary()MagresReferencer.plot_fit()MagresReferencer.plot_fit_and_predictions()
- Submodules
- matador.magres.referencer module
MagresReferencerMagresReferencer.fit_modelMagresReferencer.fit_resultsMagresReferencer.fit_interceptMagresReferencer.fit_gradientMagresReferencer.fit_rsquaredMagresReferencer.structures_expMagresReferencer.shifts_expMagresReferencer.speciesMagresReferencer.structuresMagresReferencer.warn_toleranceMagresReferencer.fit_modelMagresReferencer.fit_resultsMagresReferencer.fit_interceptMagresReferencer.fit_gradientMagresReferencer.fit_rsquaredMagresReferencer.structures_expMagresReferencer.shifts_expMagresReferencer.speciesMagresReferencer.structuresMagresReferencer.warn_toleranceMagresReferencer.match_exp_structure_shifts()MagresReferencer.set_shifts_from_fit()MagresReferencer.fit()MagresReferencer.predict()MagresReferencer.print_fit_summary()MagresReferencer.plot_fit()MagresReferencer.plot_fit_and_predictions()
- matador.orm package
- matador.plotting package
- Submodules
- matador.plotting.battery_plotting module
- matador.plotting.convergence_plotting module
- matador.plotting.hull_plotting module
- matador.plotting.ir_plotting module
- matador.plotting.magres_plotting module
- matador.plotting.misc_plotting module
- matador.plotting.pdf_plotting module
- matador.plotting.plotting module
- matador.plotting.pxrd_plotting module
- matador.plotting.spectral_plotting module
- matador.plotting.temperature_plotting module
- matador.plugins package
- matador.query package
- matador.scrapers package
res2dict()cell2dict()param2dict()castep2dict()bands2dict()arbitrary2dict()phonon2dict()phonon_dos2dict()optados2dict()usp2dict()pwout2dict()magres2dict()cif2dict()- Submodules
- matador.scrapers.castep_scrapers module
- matador.scrapers.cif_scraper module
- matador.scrapers.magres_scrapers module
- matador.scrapers.qe_scrapers module
- matador.scrapers.utils module
- matador.swaps package
- matador.utils package
- Submodules
- matador.utils.ase_utils module
- matador.utils.castep_help_utils module
- matador.utils.castep_params module
- matador.utils.cell_utils module
abc2cart()cart2abcstar()cart2volume()cart2abc()frac2cart()wrap_frac_coords()switch_coords()cart2frac()real2recip()calc_mp_grid()shift_to_include_gamma()shift_to_exclude_gamma()get_best_mp_offset_for_cell()calc_mp_spacing()get_seekpath_kpoint_path()doc2spg()get_space_group_label_latex()standardize_doc_cell()get_spacegroup_spg()get_compatible_spacegroups()add_noise()calc_pairwise_distances_pbc()create_simple_supercell()create_supercell_with_minimum_side_length()
- matador.utils.chem_utils module
get_iupac_ordered_elements()get_periodic_table()get_molar_mass()get_atomic_number()get_atomic_symbol()get_concentration()get_subscripted_formula()get_subscripted_formula_tex()get_num_intercalated()get_binary_grav_capacities()get_generic_grav_capacity()get_binary_volumetric_capacity()get_atoms_per_fu()get_formation_energy()get_number_of_chempots()get_stoich()get_padded_composition()get_ratios_from_stoichiometry()get_stoich_from_formula()parse_element_string()get_root_source()get_formula_from_stoich()magres_reference_shifts()
- matador.utils.cursor_utils module
- matador.utils.db_utils module
- matador.utils.errors module
- matador.utils.hull_utils module
- matador.utils.optimade_utils module
- matador.utils.pmg_utils module
- matador.utils.print_utils module
- matador.utils.viz_utils module
- matador.workflows package