Skip to content

Commit

Permalink
Update example.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
jappoker authored Aug 1, 2023
1 parent 8557b05 commit 730cbd3
Showing 1 changed file with 32 additions and 1 deletion.
33 changes: 32 additions & 1 deletion docs/basics/example.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,33 @@
Examples
========
========

Here we show the performance of the pgm package on two important materials of importance to geophysics and planetary modeling: cubic CaSiO3 perovskite (cCaPv), a highly anharmonic insulator without an approachable ground state, and B8 FeO, a metallic system with an approachable ground state.

Example 1: cubic CaSiO3 perovskite (cCaPv)
-------------------------------------------

To run the example, execute the following commands in your terminal:

.. code-block:: bash
cd examples/casio3
pgm run casio3.yaml
The results will be generated in `./results/`.

Example 2: NiAs-type ferrous oxide (B8 FeO)
-------------------------------------------

To run the example, execute the following commands in your terminal:

.. code-block:: bash
cd examples/feo
pgm run feo.yaml
The results will be generated in `./results/`.

Note
----

For detailed calculation, method information and results, please refer to `our paper <https://authors.elsevier.com/c/1hQ5e_FEhOCgU>`_.

0 comments on commit 730cbd3

Please sign in to comment.