Skip to main content
Ctrl+K
ShakeNBreak - Home ShakeNBreak - Home
  • Welcome to ShakeNBreak!

Usage

  • Installation
  • Python API
    • ShakeNBreak Package
      • shakenbreak.input module
      • shakenbreak.distortions module
      • shakenbreak.io module
      • shakenbreak.analysis module
      • shakenbreak.plotting module
      • shakenbreak.energy_lowering_distortions module
      • shakenbreak.cli module
  • Tutorials
    • SnB Python API
    • ShakeNBreak for Polarons
    • Structure Generation
    • Analysis & plotting
  • Miscellaneous Tips & Tricks
  • Code Overview & Workflow Diagrams

Information

  • Code Compatibility
  • Contributing
  • Change Log
  • ShakeNBreak on GitHub
  • .rst

shakenbreak

shakenbreak#

  • ShakeNBreak Package
    • Module contents
    • Submodules
      • shakenbreak.input module
        • Distortions
        • apply_snb_distortions()
        • bold_print()
        • distort_and_rattle_defect_entry()
        • generate_defect_object()
        • identify_defect()
      • shakenbreak.distortions module
        • apply_dimer_distortion()
        • distort()
        • distort_and_rattle()
        • get_dimer_bond_length()
        • local_mc_rattle()
        • rattle()
      • shakenbreak.io module
        • parse_energies()
        • parse_fhi_aims_input()
        • parse_qe_input()
        • parse_structure()
        • read_structure_w_ase()
        • read_vasp_structure()
      • shakenbreak.analysis module
        • analyse_defect_site()
        • analyse_structure()
        • calculate_struct_comparison()
        • compare_structures()
        • get_energies()
        • get_gs_distortion()
        • get_homoionic_bonds()
        • get_site_magnetizations()
        • get_structures()
      • shakenbreak.plotting module
        • plot_all_defects()
        • plot_defect()
        • plot_colorbar()
        • plot_datasets()
      • shakenbreak.energy_lowering_distortions module
        • compare_struct_to_distortions()
        • get_energy_lowering_distortions()
        • read_defects_directories()
        • write_groundstate_structure()
        • write_retest_inputs()
      • shakenbreak.cli module
        • Commands

previous

Installation

next

ShakeNBreak Package

By Irea Mosquera-Lois, Seán R. Kavanagh

© Copyright 2022, Irea Mosquera-Lois, Seán R. Kavanagh.