.. _Userguide:

User guide
==========

Summary
    This is a broad outline on how the software is used.
    For a scientific discussion on theory and examples on use, read the literature.

Installation
############

For installation please refer to the :ref:`Installation section <Install1ddft>`..

Hartree Fock SCF
################

A HF calculation can be preformed... Behold:

.. code-block:: python
  :linenos:

    #This doesn't work but is just placeholder for someone to edit
    from DFT_1d import hf_scf
    Answer = hf_scf.CALCULATECALCULATECALCULATE
    print(Answer)

The examples directory includes:

- :ref:`An example of 1D Hartree-Fock <hf_scf_example>`
- :ref:`An example of 1D Kohn-Sham DFT <ks_dft_example>`
- :ref:`A posh example of  Poschl Teller wells <two_poschl_teller>`