-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
58 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
Basic examples | ||
============== | ||
|
||
Here are a few short basic `how to` examples. | ||
|
||
How to define a Molecule in Qibochem | ||
------------------------------------ | ||
|
||
A ``Molecule`` can be defined either inline, or using an ``.xyz`` file. An example for a H2 molecule: | ||
|
||
.. code-block:: | ||
from qibochem.driver.molecule import Molecule | ||
# Inline definition | ||
h2 = Molecule([('H', (0.0, 0.0, 0.0)), ('H', (0.0, 0.0, 0.74804))]) | ||
# From an .xyz file | ||
# h2 = Molecule(xyz_file='h2.xyz') | ||
Interfacing with PSI4/PySCF to obtain the 1-/2- electron integrals | ||
------------------------------------------------------------------ | ||
|
||
After defining a ``Molecule``, the next step is to obtain the molecular integrals. Qibochem has has functions that interface with either `PySCF`_ or `PSI4`_ to do so: | ||
|
||
.. _PySCF: https://pyscf.org/ | ||
.. _PSI4: https://psicode.org/ | ||
|
||
.. code-block:: | ||
from qibochem.driver.molecule import Molecule | ||
# Inline definition of H2 | ||
h2 = Molecule([('H', (0.0, 0.0, 0.0)), ('H', (0.0, 0.0, 0.74804))]) | ||
# Using PySCF | ||
h2.run_pyscf() | ||
# Using PSI4 | ||
# h2.run_psi4() | ||
Next section | ||
------------ | ||
|
||
hello world | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
.. _examples: | ||
|
||
Code examples | ||
============= | ||
|
||
This section provides examples of how to use Qibochem. | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
examples |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,6 +24,7 @@ Contents | |
:caption: Introduction | ||
|
||
getting-started/index | ||
code-examples/index | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|