Convenience.LoadFromBroombridge(String, IndexConvention) Method

Definition

Loads a Hamiltonian from integral data represented in Broombridge format. Please see the Broombridge documentation for further details about the format parsed by this method.

public static System.Collections.Generic.IEnumerable<Microsoft.Quantum.Chemistry.Fermion.FermionHamiltonian> LoadFromBroombridge (string filename, Microsoft.Quantum.Chemistry.IndexConvention indexConvention);
static member LoadFromBroombridge : string * Microsoft.Quantum.Chemistry.IndexConvention -> seq<Microsoft.Quantum.Chemistry.Fermion.FermionHamiltonian>
Public Shared Function LoadFromBroombridge (filename As String, indexConvention As IndexConvention) As IEnumerable(Of FermionHamiltonian)

Parameters

filename
String

The name of the file to be loaded.

indexConvention
IndexConvention

The index convention to be used in converting the loaded electronic structure problem into a fermionic Hamiltonian.

Returns

IEnumerable<FermionHamiltonian>

An instance of FermionHamiltonian representing the data contained in filename.

Applies to