From e082f36ab0a5e446a36a6b5e4ef0b5604c63ff05 Mon Sep 17 00:00:00 2001 From: Bradben Date: Mon, 30 Oct 2023 10:49:41 -0700 Subject: [PATCH 1/2] archiving docs for deprecated qsharp-chemistry package --- .../qsharp-chemistry documention/index.yml | 9 +++ .../qsharp.chemistry.Broombridge.yml | 12 ++++ .../qsharp.chemistry.FermionHamiltonian.yml | 20 +++++++ .../qsharp.chemistry.IndexConvention.yml | 15 +++++ .../qsharp.chemistry.InputState.yml | 12 ++++ .../qsharp.chemistry.ProblemDescription.yml | 41 +++++++++++++ .../qsharp.chemistry.version.yml | 4 ++ .../qsharp.chemistry.yml | 59 +++++++++++++++++++ 8 files changed, 172 insertions(+) create mode 100644 samples/azure-quantum/chemistry/qsharp-chemistry documention/index.yml create mode 100644 samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.Broombridge.yml create mode 100644 samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.FermionHamiltonian.yml create mode 100644 samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.IndexConvention.yml create mode 100644 samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.InputState.yml create mode 100644 samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.ProblemDescription.yml create mode 100644 samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.version.yml create mode 100644 samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.yml diff --git a/samples/azure-quantum/chemistry/qsharp-chemistry documention/index.yml b/samples/azure-quantum/chemistry/qsharp-chemistry documention/index.yml new file mode 100644 index 00000000000..120bb6aea63 --- /dev/null +++ b/samples/azure-quantum/chemistry/qsharp-chemistry documention/index.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: project-qsharp-chemistry +name: qsharp-chemistry +fullName: qsharp-chemistry +type: distribution +packages: +- qsharp.chemistry +modules: +- qsharp.chemistry.version diff --git a/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.Broombridge.yml b/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.Broombridge.yml new file mode 100644 index 00000000000..b305505ee9c --- /dev/null +++ b/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.Broombridge.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonClass +uid: qsharp.chemistry.Broombridge +name: Broombridge +fullName: qsharp.chemistry.Broombridge +module: qsharp.chemistry +inheritances: +- builtins.object +summary: Represents an instance of a broombridge schema data +constructor: + syntax: 'Broombridge(data: Dict)' + parameters: + - name: data diff --git a/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.FermionHamiltonian.yml b/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.FermionHamiltonian.yml new file mode 100644 index 00000000000..cfcd1104272 --- /dev/null +++ b/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.FermionHamiltonian.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: qsharp.chemistry.FermionHamiltonian +name: FermionHamiltonian +fullName: qsharp.chemistry.FermionHamiltonian +module: qsharp.chemistry +inheritances: +- builtins.object +summary: Represents a fermion Hamiltonian. +constructor: + syntax: FermionHamiltonian(data) + parameters: + - name: data +methods: +- uid: qsharp.chemistry.FermionHamiltonian.add_terms + name: add_terms + summary: Adds terms to the fermion Hamiltonian. + signature: 'add_terms(fermion_terms: Iterable[Tuple[List[int], float]]) -> None' + parameters: + - name: fermion_terms + isRequired: true diff --git a/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.IndexConvention.yml b/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.IndexConvention.yml new file mode 100644 index 00000000000..ffffa9c836b --- /dev/null +++ b/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.IndexConvention.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: qsharp.chemistry.IndexConvention +name: IndexConvention +fullName: qsharp.chemistry.IndexConvention +module: qsharp.chemistry +constructor: + syntax: IndexConvention(value, names=None, *, module=None, qualname=None, type=None, + start=1, boundary=None) +inheritances: +- enum.Enum +fields: +- name: HalfUp + uid: qsharp.chemistry.IndexConvention.HalfUp +- name: UpDown + uid: qsharp.chemistry.IndexConvention.UpDown diff --git a/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.InputState.yml b/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.InputState.yml new file mode 100644 index 00000000000..764385f5339 --- /dev/null +++ b/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.InputState.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonClass +uid: qsharp.chemistry.InputState +name: InputState +fullName: qsharp.chemistry.InputState +module: qsharp.chemistry +inheritances: +- builtins.object +summary: Represents an input state. +constructor: + syntax: 'InputState(data: Dict)' + parameters: + - name: data diff --git a/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.ProblemDescription.yml b/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.ProblemDescription.yml new file mode 100644 index 00000000000..9cdc8e0b27b --- /dev/null +++ b/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.ProblemDescription.yml @@ -0,0 +1,41 @@ +### YamlMime:PythonClass +uid: qsharp.chemistry.ProblemDescription +name: ProblemDescription +fullName: qsharp.chemistry.ProblemDescription +module: qsharp.chemistry +inheritances: +- builtins.object +summary: Represents an electronic structure problem. +constructor: + syntax: 'ProblemDescription(data: Dict)' + parameters: + - name: data +methods: +- uid: qsharp.chemistry.ProblemDescription.load_fermion_hamiltonian + name: load_fermion_hamiltonian + summary: 'Loads the fermion Hamiltonian associated with this electronic structure + problem. + + + *index_convention* can be ''UpDown'' or ''HalfUp''' + signature: 'load_fermion_hamiltonian(index_convention: IndexConvention = IndexConvention.UpDown) + -> FermionHamiltonian' + parameters: + - name: index_convention + defaultValue: IndexConvention.UpDown +- uid: qsharp.chemistry.ProblemDescription.load_input_state + name: load_input_state + summary: 'Loads the input state associated from this electronic structure problem + with the corresponding label. + + + If *wavefunction_label* is not specified, it loads the greedy (Hartree-Fock) state. + + + *index_convention* can be ''UpDown'' or ''HalfUp''' + signature: 'load_input_state(wavefunction_label: str = '''', index_convention: IndexConvention + = IndexConvention.UpDown) -> FermionHamiltonian' + parameters: + - name: wavefunction_label + - name: index_convention + defaultValue: IndexConvention.UpDown diff --git a/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.version.yml b/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.version.yml new file mode 100644 index 00000000000..f1721ae74c1 --- /dev/null +++ b/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: qsharp.chemistry.version +name: version +fullName: qsharp.chemistry.version diff --git a/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.yml b/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.yml new file mode 100644 index 00000000000..15f886ea3a7 --- /dev/null +++ b/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.yml @@ -0,0 +1,59 @@ +### YamlMime:PythonPackage +uid: qsharp.chemistry +name: chemistry +fullName: qsharp.chemistry +type: import +functions: +- uid: qsharp.chemistry.encode + name: encode + summary: 'Encodes the given Hamiltonian and input state using the Jordan Wigner + encoding + + that can be used to run chemistry simulations using Q#''s chemistry library.' + signature: 'encode(hamiltonian: FermionHamiltonian, input_state: InputState) -> + Tuple' + parameters: + - name: hamiltonian + - name: input_state +- uid: qsharp.chemistry.load_broombridge + name: load_broombridge + summary: Loads a Broombridge data file. + signature: 'load_broombridge(file_name: str) -> Broombridge' + parameters: + - name: file_name +- uid: qsharp.chemistry.load_fermion_hamiltonian + name: load_fermion_hamiltonian + summary: 'Loads the fermion Hamiltonian from the given file that contains broombridge + data. + + + *index_convention* can be ''UpDown'' or ''HalfUp''' + signature: 'load_fermion_hamiltonian(file_name: str, index_convention: IndexConvention + = IndexConvention.UpDown) -> FermionHamiltonian' + parameters: + - name: file_name + - name: index_convention + defaultValue: IndexConvention.UpDown +- uid: qsharp.chemistry.load_input_state + name: load_input_state + summary: "Loads the input state associated with the given labe from the given file\ + \ that contains broombridge data..\n\nIf *wavefunction_label* is not specified,\ + \ it loads the greedy (Hartree\u2013Fock) state.\n\n*index_convention* can be\ + \ 'UpDown' or 'HalfUp'" + signature: 'load_input_state(file_name: str, wavefunction_label: str = None, index_convention: + IndexConvention = IndexConvention.UpDown) -> FermionHamiltonian' + parameters: + - name: file_name + - name: wavefunction_label + defaultValue: None + - name: index_convention + defaultValue: IndexConvention.UpDown +classes: +- qsharp.chemistry.Broombridge +- qsharp.chemistry.FermionHamiltonian +- qsharp.chemistry.InputState +- qsharp.chemistry.ProblemDescription +modules: +- qsharp.chemistry.version +enums: +- qsharp.chemistry.IndexConvention From cb3f4e6dcf2902286ff4ca6a0ca5c481cf4ba49a Mon Sep 17 00:00:00 2001 From: Bradben Date: Mon, 30 Oct 2023 10:54:54 -0700 Subject: [PATCH 2/2] archiving docs for deprecated qsharp-chemistry package --- .../index.yml | 0 .../qsharp.chemistry.Broombridge.yml | 0 .../qsharp.chemistry.FermionHamiltonian.yml | 0 .../qsharp.chemistry.IndexConvention.yml | 0 .../qsharp.chemistry.InputState.yml | 0 .../qsharp.chemistry.ProblemDescription.yml | 0 .../qsharp.chemistry.version.yml | 0 .../qsharp.chemistry.yml | 0 8 files changed, 0 insertions(+), 0 deletions(-) rename samples/azure-quantum/chemistry/{qsharp-chemistry documention => qsharp-chemistry-documention}/index.yml (100%) rename samples/azure-quantum/chemistry/{qsharp-chemistry documention => qsharp-chemistry-documention}/qsharp.chemistry.Broombridge.yml (100%) rename samples/azure-quantum/chemistry/{qsharp-chemistry documention => qsharp-chemistry-documention}/qsharp.chemistry.FermionHamiltonian.yml (100%) rename samples/azure-quantum/chemistry/{qsharp-chemistry documention => qsharp-chemistry-documention}/qsharp.chemistry.IndexConvention.yml (100%) rename samples/azure-quantum/chemistry/{qsharp-chemistry documention => qsharp-chemistry-documention}/qsharp.chemistry.InputState.yml (100%) rename samples/azure-quantum/chemistry/{qsharp-chemistry documention => qsharp-chemistry-documention}/qsharp.chemistry.ProblemDescription.yml (100%) rename samples/azure-quantum/chemistry/{qsharp-chemistry documention => qsharp-chemistry-documention}/qsharp.chemistry.version.yml (100%) rename samples/azure-quantum/chemistry/{qsharp-chemistry documention => qsharp-chemistry-documention}/qsharp.chemistry.yml (100%) diff --git a/samples/azure-quantum/chemistry/qsharp-chemistry documention/index.yml b/samples/azure-quantum/chemistry/qsharp-chemistry-documention/index.yml similarity index 100% rename from samples/azure-quantum/chemistry/qsharp-chemistry documention/index.yml rename to samples/azure-quantum/chemistry/qsharp-chemistry-documention/index.yml diff --git a/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.Broombridge.yml b/samples/azure-quantum/chemistry/qsharp-chemistry-documention/qsharp.chemistry.Broombridge.yml similarity index 100% rename from samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.Broombridge.yml rename to samples/azure-quantum/chemistry/qsharp-chemistry-documention/qsharp.chemistry.Broombridge.yml diff --git a/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.FermionHamiltonian.yml b/samples/azure-quantum/chemistry/qsharp-chemistry-documention/qsharp.chemistry.FermionHamiltonian.yml similarity index 100% rename from samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.FermionHamiltonian.yml rename to samples/azure-quantum/chemistry/qsharp-chemistry-documention/qsharp.chemistry.FermionHamiltonian.yml diff --git a/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.IndexConvention.yml b/samples/azure-quantum/chemistry/qsharp-chemistry-documention/qsharp.chemistry.IndexConvention.yml similarity index 100% rename from samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.IndexConvention.yml rename to samples/azure-quantum/chemistry/qsharp-chemistry-documention/qsharp.chemistry.IndexConvention.yml diff --git a/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.InputState.yml b/samples/azure-quantum/chemistry/qsharp-chemistry-documention/qsharp.chemistry.InputState.yml similarity index 100% rename from samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.InputState.yml rename to samples/azure-quantum/chemistry/qsharp-chemistry-documention/qsharp.chemistry.InputState.yml diff --git a/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.ProblemDescription.yml b/samples/azure-quantum/chemistry/qsharp-chemistry-documention/qsharp.chemistry.ProblemDescription.yml similarity index 100% rename from samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.ProblemDescription.yml rename to samples/azure-quantum/chemistry/qsharp-chemistry-documention/qsharp.chemistry.ProblemDescription.yml diff --git a/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.version.yml b/samples/azure-quantum/chemistry/qsharp-chemistry-documention/qsharp.chemistry.version.yml similarity index 100% rename from samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.version.yml rename to samples/azure-quantum/chemistry/qsharp-chemistry-documention/qsharp.chemistry.version.yml diff --git a/samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.yml b/samples/azure-quantum/chemistry/qsharp-chemistry-documention/qsharp.chemistry.yml similarity index 100% rename from samples/azure-quantum/chemistry/qsharp-chemistry documention/qsharp.chemistry.yml rename to samples/azure-quantum/chemistry/qsharp-chemistry-documention/qsharp.chemistry.yml