Welcome to iDEA’s API documentation!

In this page, we provide the full API documentation of the iDEA code.

For more information please see the iDEA home page. The full code can be found on GitHub. We also provide a tutorial so you can learn how to use the iDEA code in your research and teaching projects.

Contents:

• iDEA
  • iDEA package
    • Submodules
    • Module contents
    • iDEA.utilities module
      • ArrayPlaceholder
      • Container
      • Experiment
      • load_experiment()
      • save_experiment()
    • iDEA.interactions module
      • softened_interaction()
      • softened_interaction_alternative()
    • iDEA.system module
      • System
      • load_system()
      • save_system()
    • iDEA.state module
      • Evolution
      • ManyBodyEvolution
      • ManyBodyState
      • SingleBodyEvolution
      • SingleBodyState
      • State
    • iDEA.observables module
      • density()
      • density_matrix()
      • exchange_energy()
      • exchange_potential()
      • external_energy()
      • external_potential()
      • hartree_energy()
      • hartree_potential()
      • kinetic_energy()
      • observable()
      • single_particle_energy()
    • iDEA.methods module
      • Methods
    • iDEA.methods.interacting module
      • antisymmetrize()
      • external_potential_operator()
      • hamiltonian()
      • kinetic_energy_operator()
      • propagate()
      • propagate_step()
      • solve()
      • total_energy()
    • iDEA.methods.non_interacting module
      • add_occupations()
      • external_potential_operator()
      • hamiltonian()
      • kinetic_energy_operator()
      • propagate()
      • propagate_step()
      • sc_step()
      • solve()
      • total_energy()
    • iDEA.methods.hartree
      • hamiltonian()
      • hartree_potential_operator()
      • propagate()
      • solve()
      • total_energy()
    • iDEA.methods.hartree_fock module
      • exchange_potential_operator()
      • hamiltonian()
      • propagate()
      • solve()
      • total_energy()
    • iDEA.methods.lda module
      • HEG
      • exchange_correlation_energy()
      • exchange_correlation_potential()
      • exchange_correlation_potential_operator()
      • hamiltonian()
      • propagate()
      • solve()
      • total_energy()
    • iDEA.methods.hybrid
      • hamiltonian()
      • propagate()
      • solve()
      • total_energy()
    • iDEA.reverse_engineering module
      • reverse()
      • reverse_propagation()

• Search Page